diff --git a/404.html b/404.html index a8fc6e09d..bbdc71a4a 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.48542eac.js b/assets/js/05632a52.48542eac.js new file mode 100644 index 000000000..e4a159bfc --- /dev/null +++ b/assets/js/05632a52.48542eac.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:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>b});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={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/dIE5HtxnJSKUmLSkJqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2edQlxAw55N23p7ZmWfmNoJkGUR6KV5bQzKnIGaJKDDkXjlS1ohUXFQIb5Ggl4DTD2cgtbbLAGvbAFnwSF7hAqFAkkoHkJltCCQEh7maqxzyTnckEmEdesmmzwqRihKpPxOJcNLLGgk9R7QRRtYoUtGfX6lCJEJxRE5SJe6GabNrzOmsADuHW5MePzfKYyFS8g0mItBas9GgaqdRJAJXTtsCRTqXOrBAXmEtRboRtHZRkrwypUjE3Ppa0vANrmS0kgr3yzSr8uPKZaJtZ+w2OGsCBjZ0PJnwv/1wQ5PnGMK80bDLiEgiWDTE8tI5rfJ4ML4OrLS5H12HmnPn2QypzuU2GY/GUU2zanV87USb9Pl/nIFri5AhsjrWUun/oZ8hvupfjHJbsylXWfPoUE6mz6fH8Y9N5B4lYXFKh8zcKh1Pjp8fTSdHk+8vpi/Tkx/SFy9Hk8nkT5GIVR3R9FVZSIooSZEePjeu+AZ+2rtifcX3DThU2PZC27LWyaFaPLc1UqVMCUs0BEtvTZmA0ygDAvk1yFIqA1oS+idfr0jRe+u/nKbHRdYOYCujlcGrbSNenUwmV9NdEk7uJ2FLb8YSzG1jim+L9ID7L8M5uTrewXlxH86ZWUitisjWF/YGzbeFM3RPnfv7Ras6oXgu9sAO33cgA+aNV7SOk2F1JJ066s7TyxkzLteJ7SdKHCVUiVSM++ofb26nSCvYml9sx0zjtUhFReRCOh5L50bWoQmqNFpmgSloLJ0aL5hG7koHkqUy5dEjtaQpMrt6WGN2i/ec76RL+x7qXfKlU7/iWmzpek+qn5cVygJ9vABl5jYq96l+79Ccq9LEi1pM703Vj6hzWyNPeaoQtuL//PV31Chs3tRoKNbRE3jfeHB2iZ7HmjQFzDWuVKbxwNIQUNYaQ9BrUIaw9JIQClUqkho4K9z1uXQyU1px5bGYZW0Pg+INI/hYIVXo+eg7jyChwAVqLljQ1t6wHbIgG7J19NHHDEvrb+YcUgISsiYogyFAQNyqoKmkyRG2d5GA9SANoCH0zquAIFXNwnPrAedzlSs2zLXmuZlraWSJ7CwBjpuz4LxdqAIDeJs1gSBY3UQg7LFGpA6iQSzCCH5WC+yA88uO3rGAsmETCeS2QOi7jmGYAjIMBI7dqxyj0UDSE2hcoI/VGm9y3mgNzjIdKKl5aRreLRsiL03gAdsFtL2aXfqct7zBRB+FXI/gk/lkmLChCcgFoJW5CekncwSXuzL7iFlQhLOn215YLpf3+uDZvs5bRVWTgUdnb/XK+DJ2zVB99/BMJILQ1+H9/Bz9QuXYN+ADPsdReNyTJA9MJrpuheEee3VXgQlLqxxNwAGlnb798A4W8Hw0Ecmg6/9DwON3Z6/f/Hb+hu0yN3X9Nx1NRpO4AtlAtTQDV4Od/G7bbm6Z/muv7z3rEK5o7LRUkbgj0E1Pupfidv1OB8v7LBGVDcQCm00mA/7hddvy688Neib2WSIW0iuZMTVdbkShAn8vdsv5gyCf/t7v+c/g8O+Ag2FvGdQwfS6kbvhJJOIG1/u/O9pZm2xZlAPrBE7zHB0NVO/N1L3B9PbNhUiEbDhHQ/a+iezdf2HrB8Pap/UuAP7k6XJQ4Ue+6F9x/dNOvDt5UKHHt5XmFM3atv0XV/Dhaw==",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/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/dIE5HtxnJSKUmLSkJqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2edQlxAw55N23p7ZmWfmNoJkGUR6KV5bQzKnIGaJKDDkXjlS1ohUXFQIb5Ggl4DTD2cgtbbLAGvbAFnwSF7hAqFAkkoHkJltCCQEh7maqxzyTnckEmEdesmmzwqRihKpPxOJcNLLGgk9R7QRRtYoUtGfX6lCJEJxRE5SJe6GabNrzOmsADuHW5MePzfKYyFS8g0mItBas9GgaqdRJAJXTtsCRTqXOrBAXmEtRboRtHZRkrwypUjE3Ppa0vANrmS0kgr3yzSr8uPKZaJtZ+w2OGsCBjZ0PJnwv/1wQ5PnGMK80bDLiEgiWDTE8tI5rfJ4ML4OrLS5H12HmnPn2QypzuU2GY/GUU2zanV87USb9Pl/nIFri5AhsjrWUun/oZ8hvupfjHJbsylXWfPoUE6mz6fH8Y9N5B4lYXFKh8zcKh1Pjp8fTSdHk+8vpi/Tkx/SFy9Hk8nkT5GIVR3R9FVZSIooSZEePjeu+AZ+2rtifcX3DThU2PZC27LWyaFaPLc1UqVMCUs0BEtvTZmA0ygDAvk1yFIqA1oS+idfr0jRe+u/nKbHRdYOYCujlcGrbSNenUwmV9NdEk7uJ2FLb8YSzG1jim+L9ID7L8M5uTrewXlxH86ZWUitisjWF/YGzbeFM3RPnfv7Ras6oXgu9sAO33cgA+aNV7SOk2F1JJ066s7TyxkzLteJ7SdKHCVUiVSM++ofb26nSCvYml9sx0zjtUhFReRCOh5L50bWoQmqNFpmgSloLJ0aL5hG7koHkqUy5dEjtaQpMrt6WGN2i/ec76RL+x7qXfKlU7/iWmzpek+qn5cVygJ9vABl5jYq96l+79Ccq9LEi1pM703Vj6hzWyNPeaoQtuL//PV31Chs3tRoKNbRE3jfeHB2iZ7HmjQFzDWuVKbxwNIQUNYaQ9BrUIaw9JIQClUqkho4K9z1uXQyU1px5bGYZW0Pg+INI/hYIVXo+eg7jyChwAVqLljQ1t6wHbIgG7J19NHHDEvrb+YcUgISsiYogyFAQNyqoKmkyRG2d5GA9SANoCH0zquAIFXNwnPrAedzlSs2zLXmuZlraWSJ7CwBjpuz4LxdqAIDeJs1gSBY3UQg7LFGpA6iQSzCCH5WC+yA88uO3rGAsmETCeS2QOi7jmGYAjIMBI7dqxyj0UDSE2hcoI/VGm9y3mgNzjIdKKl5aRreLRsiL03gAdsFtL2aXfqct7zBRB+FXI/gk/lkmLChCcgFoJW5CekncwSXuzL7iFlQhLOn215YLpf3+uDZvs5bRVWTgUdnb/XK+DJ2zVB99/BMJILQ1+H9/Bz9QuXYN+ADPsdReNyTJA9MJrpuheEee3VXgQlLqxxNwAGlnb798A4W8Hw0Ecmg6/9DwON3Z6/f/Hb+hu0yN3X9Nx1NRpO4AtlAtTQDV4Od/G7bbm6Z/muv7z3rEK5o7LRUkbgj0E1Pupfidv1OB8v7LBGVDcQCm00mA/7hddvy688Neib2WSIW0iuZMTVdbkShAn8vdsv5gyCf/t7v+c/g8O+Ag2FvGdQwfS6kbvhJJOIG1/u/O9pZm2xZlAPrBE7zHB0NVO/N1L3B9PbNhUiEbDhHQ/a+iezdf2HrB8Pap/UuAP7k6XJQ4Ue+6F9x/dNOvDt5UKHHt5XmFM3atv0XV/Dhaw==",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={},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,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)(n.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.jsx)(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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/05632a52.8bacc2bc.js b/assets/js/05632a52.8bacc2bc.js deleted file mode 100644 index efd82a62a..000000000 --- a/assets/js/05632a52.8bacc2bc.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 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/13fdae3b.5b6095f9.js b/assets/js/13fdae3b.5b6095f9.js deleted file mode 100644 index c1f29c952..000000000 --- a/assets/js/13fdae3b.5b6095f9.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:()=>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.7c32856a.js b/assets/js/13fdae3b.7c32856a.js new file mode 100644 index 000000000..6b45d5b6f --- /dev/null +++ b/assets/js/13fdae3b.7c32856a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,s,l)=>{l.r(s),l.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>m,metadata:()=>x,toc:()=>k});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),l(5397)),c=l(4667),h=l(9472),p=l(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:"eJy9Vttu20YQ/ZXxvrQBaElOk4cSRdGgNgIjRhNADvwgC8aQHJEbLXe3u0tKgsC3fkk/rV9SzFLUzXXQFkVfdNk5czmzM4fcioClF+lMPFBWGbMU80QU5HMnbZBGi1TcVwTXpCgQ7DDw7tMtoFJmBRvTQDBQ9PbVzt44JRJhLDnkILeFSEUPGbIkwpG3RnvyIt2K15MJf50mnjZ5Tt4vGgX7UCIRudGBdGA8WqtkHg3jL56dtsLnFdXIv8LGkkiFyb5QHkQirOMwQfYpHflGhSOcD07qUiSC1lhbxUcD3772Avy+IrW5EF2XiCBDREqtpKangdTT68nk6XvRdYx5M3nznNxnTw60CbAwjS4u/jte5JxxX6d1nvtrRLj4gcbb5zRudYtKFnEi7s2S9P/L5Dh96NNzqetasZ/GuqcUQdEuTqgen/ckPeWNk2Ej0tlWrC/Rysvens7m3TwRNYXKHMaZa8ZQiVSMV/vJ9uRacj6G4E1IRRWC9el4jNaOjCXtZakVZn6Um3qMVo7bK9El52gfsJS6vPyHXqiLzKxf9pgfWE75Jvpmn3Ddtxyt/EAbkQytPEYlQvIEVIQFudh2qRcmOu8a/NGSnspSx+tpr8S5sjyQyk1NLCChIhjgf/z2e/QoTN7UpEOcngv42DiwZkWOBQF1AQtFa5kpOsiRH/TIE9aKvFcbkDpQ6TAQFLKUARVwV6QuIUeLmVSS541hhr0dHI2sH8FDRaEix6ZvHAFCQS0pHlNQxiw5TjCATTB1zLGrGVbGLRdcUgIIWeOlJu/BEw0upCvUOcFwFwkYB6iBdCBnnfQEKGsGL4wDWixkLjkwL5fDPECNGkviZAlw3dwF60wrC/LgTNb4AN6oJhLhjDVR6ClqosKP4Fq21BPnw4ICSkUFlA2HSCA3BcFu15iGLiAjH8ByeplTDOoDugCKWnJxWuNNskCCNSwCEhWYxcndcqDgUPuFcXVf0HA1+/ZZZ1hpY44CNyN41I96ysPSeOIBUFIvffqoL2G2H7MHyrwMNP922IXVavVsD16d+ryXoWoycGTNwa+Mh3Frjt33f16JRARytf+4mJJrZU67BXwh5ziCxztpxDxKI9UoVb9jP507sEwpmZP2dCRk795/uoMWvhtNRHK09X+j4PHd7c83v0xvOC5rU79/V6PJaMJH1vhQoz5KdfrAP9/c7UHi//3rwU5iAq3D2CqUUZsjq+1OVGdidXgpqYwPfLTdZujps1Ndx8e/NuRYreeJaNFJzFh5ZvMuGYSJVXhJG25fnpPlx0yLqunV7ezhdKLw1zd3N/c3IhHYcDHHmriMmrj7wQkGk94chT8Vy74G/mTN/kuHH7hxH2jz4x7eW1502FEc0NzCedd1fwKyo3Ic",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/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:"eJy9Vttu20YQ/ZXxvrQBaElOk4cSRdGgNgIjRhNADvwgC8aQHJEbLXe3u0tKgsC3fkk/rV9SzFLUzXXQFkVfdNk5czmzM4fcioClF+lMPFBWGbMU80QU5HMnbZBGi1TcVwTXpCgQ7DDw7tMtoFJmBRvTQDBQ9PbVzt44JRJhLDnkILeFSEUPGbIkwpG3RnvyIt2K15MJf50mnjZ5Tt4vGgX7UCIRudGBdGA8WqtkHg3jL56dtsLnFdXIv8LGkkiFyb5QHkQirOMwQfYpHflGhSOcD07qUiSC1lhbxUcD3772Avy+IrW5EF2XiCBDREqtpKangdTT68nk6XvRdYx5M3nznNxnTw60CbAwjS4u/jte5JxxX6d1nvtrRLj4gcbb5zRudYtKFnEi7s2S9P/L5Dh96NNzqetasZ/GuqcUQdEuTqgen/ckPeWNk2Ej0tlWrC/Rysvens7m3TwRNYXKHMaZa8ZQiVSMV/vJ9uRacj6G4E1IRRWC9el4jNaOjCXtZakVZn6Um3qMVo7bK9El52gfsJS6vPyHXqiLzKxf9pgfWE75Jvpmn3Ddtxyt/EAbkQytPEYlQvIEVIQFudh2qRcmOu8a/NGSnspSx+tpr8S5sjyQyk1NLCChIhjgf/z2e/QoTN7UpEOcngv42DiwZkWOBQF1AQtFa5kpOsiRH/TIE9aKvFcbkDpQ6TAQFLKUARVwV6QuIUeLmVSS541hhr0dHI2sH8FDRaEix6ZvHAFCQS0pHlNQxiw5TjCATTB1zLGrGVbGLRdcUgIIWeOlJu/BEw0upCvUOcFwFwkYB6iBdCBnnfQEKGsGL4wDWixkLjkwL5fDPECNGkviZAlw3dwF60wrC/LgTNb4AN6oJhLhjDVR6ClqosKP4Fq21BPnw4ICSkUFlA2HSCA3BcFu15iGLiAjH8ByeplTDOoDugCKWnJxWuNNskCCNSwCEhWYxcndcqDgUPuFcXVf0HA1+/ZZZ1hpY44CNyN41I96ysPSeOIBUFIvffqoL2G2H7MHyrwMNP922IXVavVsD16d+ryXoWoycGTNwa+Mh3Frjt33f16JRARytf+4mJJrZU67BXwh5ziCxztpxDxKI9UoVb9jP507sEwpmZP2dCRk795/uoMWvhtNRHK09X+j4PHd7c83v0xvOC5rU79/V6PJaMJH1vhQoz5KdfrAP9/c7UHi//3rwU5iAq3D2CqUUZsjq+1OVGdidXgpqYwPfLTdZujps1Ndx8e/NuRYreeJaNFJzFh5ZvMuGYSJVXhJG25fnpPlx0yLqunV7ezhdKLw1zd3N/c3IhHYcDHHmriMmrj7wQkGk94chT8Vy74G/mTN/kuHH7hxH2jz4x7eW1502FEc0NzCedd1fwKyo3Ic",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"}},j={},k=[{value:"Request",id:"request",level:2}];function f(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 Webhook"})}),"\n",(0,a.jsx)(o(),{method:"delete",path:"/webhook"}),"\n",(0,a.jsx)(s.p,{children:"The Delete Webhook API allow you to delete webhook url"}),"\n",(0,a.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(p.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)(d.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)(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)(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)(r.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)(s.p,{children:"User not found!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.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)(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)(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)(r.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)(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)(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)(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)(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)(r.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.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/1f73ca32.70560ad8.js b/assets/js/1f73ca32.70560ad8.js new file mode 100644 index 000000000..b08bd4e06 --- /dev/null +++ b/assets/js/1f73ca32.70560ad8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>j,toc:()=>g});var t=a(85893),l=a(11151),n=a(58219),i=(a(62316),a(51039)),r=a.n(i),c=(a(82723),a(9487)),o=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(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+yn7ZcMR1mO7bTDgg39YovkPffGu+e4EhGrIPJr8S6QF9NMlBSkVy4qa0QurmqCc4rAp/D87QWQwUJTgKVtIVqoKPKnB7swgFLa1kQoKaLSYSQyYR15ZF0XpchFRTGZyYSn4KwJFES+EieTCf/tW75spaQQZq2GrRKRCWlNJBNZHp3TSqaD8U1g0EoEWVOD/BWXjkQubHFDMopMOM9qoupN9tvs1FYyRK9MJTIxs77BuLtDt9g4zUK/nKv5yWlRv3sp1pkw2NBDNby0BD8SMZwaVPqh+BtLBdGzzcZI2oZVudqaB7ty9vjJ029PT45PTlnFjS2uVNQP1lJSx3BpG4dm+VC0dWSCqkxS4Qkjlc/jp5TcQU4mJ6dHx5OjydOr4yf52Xf54yejyWTym8jEbZPy2d+LKDGmPMc+rO26deUXsLM+FGu59HfE+vWaBc8mZ/c7IPWcsRFmtjXlo/+v+Ml76/859kPb6x2/ldHK0MehhT+y80MYj++HcWE61KpM7HFl52S+bCS75mNv/v7VqF4onYu9UHf3+yADydaruBT59UrcHqFTR/15fj1dTzPRUKzthu3YYYy1yMW4otj23BfId+RDwrdei1zUMbqQj8fo3GhoCI1F4O4eo1Pj7liss0PpELFSpjp6IApNWdjbzyOmdyFe8jX0md4LdJtvdOoVLcXAhHtSmVB8/TVhmeqc1zObwJvsvnFkLlVl0t10x+Jw+LwnLW1DPGdiTTCI//XHnwlRWtk2ZGIqnUfwpvXg7II8jww0Jcw03apCUxJGre1iO7YCYaMpBL0EZSJVHiNBqSoVUQNnRZkKJDoslFZcbCxm+0m3U69hBO9rijV5PvrKEyCU1JHmGgVt7Zz1RAvYRtskGxufYWH9fMYuZYBQtEEZCgEC0QAhU6ORBMNdZGA9oAEykbzzKhCgalh4Zj3QbKakYsXcWR5lhAYNVsTGMmC/OQvO206VFMDbog0RgtVtCoQtNjQMc0NUhhH8rDrqA+fNfqpTCVXLKjKQtiTYNBqHYUooKERwbF5JSkpDRB9BU0c+VWu6yVmrNTjLDKBQg53t3S0rih5N4LnROzRczTZ9zlt+HSQbJS5H8MF8MJdcLG0gLgCtzDzkH8wRXG/L7D0VQUWafj30wmKxuNcH3+xjzlWs2wI8OXuHq9Jm6ppd+HbxjchEJN+EN7NL8p2StGnAz9gcJ+HxhhdRJl7cvA64x54dApijtJJkAu2w2PPzt6+hg9PRRGQ7Xf8vHB6/vvjpxa+XL1gvc1Pff8ejyWiSXhc2xAbNjqnzoVQO3nyHPby6Y/r//JbccE6k2zh2GlVi6hTmasOy12Jg2Wkmahsib61WBQZ65/V6zdu/t+SZu6eZ6NAr9iAxdzYwFdPynJacTynJMYd3qNue7g5G1R7fn7+4EpnAlj3ZZch5YsjNB2sfjsxyR/c+dfYO8C8z+CcB33MKX9Hyh614f/JZwCa+QZrzN12v138DIxohhw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/get-user",title:"Get your 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+yn7ZcMR1mO7bTDgg39YovkPffGu+e4EhGrIPJr8S6QF9NMlBSkVy4qa0QurmqCc4rAp/D87QWQwUJTgKVtIVqoKPKnB7swgFLa1kQoKaLSYSQyYR15ZF0XpchFRTGZyYSn4KwJFES+EieTCf/tW75spaQQZq2GrRKRCWlNJBNZHp3TSqaD8U1g0EoEWVOD/BWXjkQubHFDMopMOM9qoupN9tvs1FYyRK9MJTIxs77BuLtDt9g4zUK/nKv5yWlRv3sp1pkw2NBDNby0BD8SMZwaVPqh+BtLBdGzzcZI2oZVudqaB7ty9vjJ029PT45PTlnFjS2uVNQP1lJSx3BpG4dm+VC0dWSCqkxS4Qkjlc/jp5TcQU4mJ6dHx5OjydOr4yf52Xf54yejyWTym8jEbZPy2d+LKDGmPMc+rO26deUXsLM+FGu59HfE+vWaBc8mZ/c7IPWcsRFmtjXlo/+v+Ml76/859kPb6x2/ldHK0MehhT+y80MYj++HcWE61KpM7HFl52S+bCS75mNv/v7VqF4onYu9UHf3+yADydaruBT59UrcHqFTR/15fj1dTzPRUKzthu3YYYy1yMW4otj23BfId+RDwrdei1zUMbqQj8fo3GhoCI1F4O4eo1Pj7liss0PpELFSpjp6IApNWdjbzyOmdyFe8jX0md4LdJtvdOoVLcXAhHtSmVB8/TVhmeqc1zObwJvsvnFkLlVl0t10x+Jw+LwnLW1DPGdiTTCI//XHnwlRWtk2ZGIqnUfwpvXg7II8jww0Jcw03apCUxJGre1iO7YCYaMpBL0EZSJVHiNBqSoVUQNnRZkKJDoslFZcbCxm+0m3U69hBO9rijV5PvrKEyCU1JHmGgVt7Zz1RAvYRtskGxufYWH9fMYuZYBQtEEZCgEC0QAhU6ORBMNdZGA9oAEykbzzKhCgalh4Zj3QbKakYsXcWR5lhAYNVsTGMmC/OQvO206VFMDbog0RgtVtCoQtNjQMc0NUhhH8rDrqA+fNfqpTCVXLKjKQtiTYNBqHYUooKERwbF5JSkpDRB9BU0c+VWu6yVmrNTjLDKBQg53t3S0rih5N4LnROzRczTZ9zlt+HSQbJS5H8MF8MJdcLG0gLgCtzDzkH8wRXG/L7D0VQUWafj30wmKxuNcH3+xjzlWs2wI8OXuHq9Jm6ppd+HbxjchEJN+EN7NL8p2StGnAz9gcJ+HxhhdRJl7cvA64x54dApijtJJkAu2w2PPzt6+hg9PRRGQ7Xf8vHB6/vvjpxa+XL1gvc1Pff8ejyWiSXhc2xAbNjqnzoVQO3nyHPby6Y/r//JbccE6k2zh2GlVi6hTmasOy12Jg2Wkmahsib61WBQZ65/V6zdu/t+SZu6eZ6NAr9iAxdzYwFdPynJacTynJMYd3qNue7g5G1R7fn7+4EpnAlj3ZZch5YsjNB2sfjsxyR/c+dfYO8C8z+CcB33MKX9Hyh614f/JZwCa+QZrzN12v138DIxohhw==",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"}},x={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(s.p,{children:"Get your account details"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,t.jsx)(s.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,t.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(n.Z,{children:[(0,t.jsxs)(p.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,t.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,t.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,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.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,t.jsxs)(p.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"User not found!"})}),(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)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(o.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(s.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(s.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(d.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 f(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/1f73ca32.bbe9fcf5.js b/assets/js/1f73ca32.bbe9fcf5.js deleted file mode 100644 index 7e178607f..000000000 --- a/assets/js/1f73ca32.bbe9fcf5.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:()=>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.c742feb2.js b/assets/js/2304e9ae.c742feb2.js new file mode 100644 index 000000000..f59336560 --- /dev/null +++ b/assets/js/2304e9ae.c742feb2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7964],{31898:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>u,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>j,toc:()=>f});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),s(5397)),c=s(4667),p=s(9472),m=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:"eJzNV9tu3DYQ/RVmXtoA2oudOEWFoqibpoGbIDZqFwFqL4yRNKtlTJEMSe16sdBbv6Sf1i8phlzZe3GCuiiCvixW5FzPzJyRVhCw9pBfws9GVeRgkkFFvnTSBmk05HAxI/HSEQYSSUQcn50IVMosvFiaVgQjynQ/jfdDyMBYcsgGTirIIV2nW8jA0ceWfPjRVEvIVzvuzpyZy4pEQcoshEWHDQVye14gg9LoQDqwDbRWyTJ6HH3wbGgFvpxRg/yPHUpHFaeZtDU2xKmGpSXIwRQfqAyQgXUceZDkWS/JvmPZfNXL+uCkriGDqXENhs0TusXGKhbStOjj7DKw6EiHhB4D8jhb0HUZBBniQzJ6XTB2HV/c5xZcS/HAW6N9yuBwPN6HONlYw1kJ35YleT9tlVo+eQysnwcvHT8+XTs7KGa3hx8sI/f/qMAvhxr90Y08I7a1xu04PGTmXulwfPhscDAejL+5OHiRP/82P3oxHI/Hv0MGt41i3diEOVQYot2+xP1za6sv4KfbFUugVRRQKg97rcdd12Xw/KHGOjcNhZnUtViQDmLhjK4zYRWhJxHcUmCNUguFgdx/2GnknHGfB+lxkW0OnNRKarrup+r6+Xh8fXAHwtE+CCd6jkpWkSUvzA3pL5vppvuQ3O/XWCaheA9byW6epyQ9la2TYQn55QpuB2jlIN3nl5NukgEDa5jlrfExYgwzyGG0Q/qe3Jycj1ZapyCHWQjW56MRWjs0lrSXtVZY+GFpmhFaOZofQJftSvuAtdT14JFaqKvC3H5aY3Kf6DkXI+G9le4d6mjlG1pC1qO5KZWB5CaYEaZZyYBr/Ov9xnvVV2p7vWzy1T5dARdJ6qmJUayLdWpJn8tax1LPD2B3cb8nVZqGeHOGGYle/K8//owalSnbhnSInfhEnLZOWLMgN22VQF2JqaJbWSh6YN17wkaR92oppA5UO17LlaxlQCUYXh60Ei0WUknuXRYzrO3ERvv7oXg/ozAjx1dfORIoKpqT4pYXypgbthOMwDaYJvpYxywWxt1MOaRMoChaLzV5LzxRr0J6hrok0Rc1E8YJ1IJ0IGed9CRQNiw8NU7QdCpLyYZ5UB2WQTSosSZ2lgmOm1Gw6d3EC2eK1gfhjWpjIuyxIQopRU1U+aH4Sc4pJc6HiVCpEnXLJjJRmorEem45DV2JgnwQlt3LkqJRH9AFoWhOLrZ9rCRvamENE4pEJcx0q7ZsKDjUnjdaCqgvzR181hle+dFHhcuhuNJXmjlStJ64AZTUNz6/0gNxeddm76nwMtDk636oFovF3kA93dZ5LcOsLYQja+716ngYx29T/e7hKWQQyDX+dHpObi5LWk/yJ3yOovBoTbNYRpqlBqVKw/rDrgJPk5IlaU8bpHj8+uytmItnwzFkG/TxDwIevT15+erd+Su2yySX5u9gOB6O48uH8aFBveFq6316d3BX99vi3718r2kq0G0YWYUyUnxMaLVm58vtV/JJBjMm7/wSVqsCPf3mVNfx8ceWHDP/JIM5OokFM8/lpMt6hmM6v6El55SCHlywdxZXbSLLnXXH5Jw0jsuSbPis7OZ+OTs9v4AMivVnQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhSbrH4TWX39hzPrr/RyI8ptuk+p8C8n9qDCd1yzN7T8/k483XxSYY1tL80FnHRd9zejcLvj",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/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:"eJzNV9tu3DYQ/RVmXtoA2oudOEWFoqibpoGbIDZqFwFqL4yRNKtlTJEMSe16sdBbv6Sf1i8phlzZe3GCuiiCvixW5FzPzJyRVhCw9pBfws9GVeRgkkFFvnTSBmk05HAxI/HSEQYSSUQcn50IVMosvFiaVgQjynQ/jfdDyMBYcsgGTirIIV2nW8jA0ceWfPjRVEvIVzvuzpyZy4pEQcoshEWHDQVye14gg9LoQDqwDbRWyTJ6HH3wbGgFvpxRg/yPHUpHFaeZtDU2xKmGpSXIwRQfqAyQgXUceZDkWS/JvmPZfNXL+uCkriGDqXENhs0TusXGKhbStOjj7DKw6EiHhB4D8jhb0HUZBBniQzJ6XTB2HV/c5xZcS/HAW6N9yuBwPN6HONlYw1kJ35YleT9tlVo+eQysnwcvHT8+XTs7KGa3hx8sI/f/qMAvhxr90Y08I7a1xu04PGTmXulwfPhscDAejL+5OHiRP/82P3oxHI/Hv0MGt41i3diEOVQYot2+xP1za6sv4KfbFUugVRRQKg97rcdd12Xw/KHGOjcNhZnUtViQDmLhjK4zYRWhJxHcUmCNUguFgdx/2GnknHGfB+lxkW0OnNRKarrup+r6+Xh8fXAHwtE+CCd6jkpWkSUvzA3pL5vppvuQ3O/XWCaheA9byW6epyQ9la2TYQn55QpuB2jlIN3nl5NukgEDa5jlrfExYgwzyGG0Q/qe3Jycj1ZapyCHWQjW56MRWjs0lrSXtVZY+GFpmhFaOZofQJftSvuAtdT14JFaqKvC3H5aY3Kf6DkXI+G9le4d6mjlG1pC1qO5KZWB5CaYEaZZyYBr/Ov9xnvVV2p7vWzy1T5dARdJ6qmJUayLdWpJn8tax1LPD2B3cb8nVZqGeHOGGYle/K8//owalSnbhnSInfhEnLZOWLMgN22VQF2JqaJbWSh6YN17wkaR92oppA5UO17LlaxlQCUYXh60Ei0WUknuXRYzrO3ERvv7oXg/ozAjx1dfORIoKpqT4pYXypgbthOMwDaYJvpYxywWxt1MOaRMoChaLzV5LzxRr0J6hrok0Rc1E8YJ1IJ0IGed9CRQNiw8NU7QdCpLyYZ5UB2WQTSosSZ2lgmOm1Gw6d3EC2eK1gfhjWpjIuyxIQopRU1U+aH4Sc4pJc6HiVCpEnXLJjJRmorEem45DV2JgnwQlt3LkqJRH9AFoWhOLrZ9rCRvamENE4pEJcx0q7ZsKDjUnjdaCqgvzR181hle+dFHhcuhuNJXmjlStJ64AZTUNz6/0gNxeddm76nwMtDk636oFovF3kA93dZ5LcOsLYQja+716ngYx29T/e7hKWQQyDX+dHpObi5LWk/yJ3yOovBoTbNYRpqlBqVKw/rDrgJPk5IlaU8bpHj8+uytmItnwzFkG/TxDwIevT15+erd+Su2yySX5u9gOB6O48uH8aFBveFq6316d3BX99vi3718r2kq0G0YWYUyUnxMaLVm58vtV/JJBjMm7/wSVqsCPf3mVNfx8ceWHDP/JIM5OokFM8/lpMt6hmM6v6El55SCHlywdxZXbSLLnXXH5Jw0jsuSbPis7OZ+OTs9v4AMivVnQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhSbrH4TWX39hzPrr/RyI8ptuk+p8C8n9qDCd1yzN7T8/k483XxSYY1tL80FnHRd9zejcLvj",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"}},u={},f=[{value:"Request",id:"request",level:2}];function g(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)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(m.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)(m.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.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)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.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)(m.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)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.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)(m.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)(m.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)(m.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(m.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)(m.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,r.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/2304e9ae.e976b175.js b/assets/js/2304e9ae.e976b175.js deleted file mode 100644 index f737f43cc..000000000 --- a/assets/js/2304e9ae.e976b175.js +++ /dev/null @@ -1 +0,0 @@ -"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.41c168b1.js b/assets/js/28b19cd2.41c168b1.js new file mode 100644 index 000000000..e66782243 --- /dev/null +++ b/assets/js/28b19cd2.41c168b1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>h,metadata:()=>f,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),c=s(5397),d=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+8p1cqNPYPL3MMd86fsPJaeO/4/4WU5fyJ+Ki7qI7puoeJktCnjMcT875L9tHwJc+cyO0ftcD7zG6HsD1M8Q8KO5R8QCKx8h3PsayQuzi1fYJtIe/hNjFFT3TMDW7h9GhwXj2sWHXMxPi1JXXVUmasXUoztXZs2n5lVRi2oHJkKMn//c//xU4+loKd+cNXFUWSrMmm1Uq9KdM0ZOMFR14tDvCQpFzqg5P3Dw84FOZS48KOqAACZYYSyX5tjGZaYfw6MK6CXzdYvIjG17etCLFlxSUMY/h4WsAK2+KoKPv1WtjHzM2KQKEmF/IPEkdUc9Ceok64bbUll3EvRU1ED/JS8tDEmXBxIxxKctkIlkwtxaLiYcCNebEyiJguzkKXV92YE3M2wlnVBUcYY0FkW9d5HWCm8BnuaLW8QA+yKNUlEJesYgIEpMyTAmFx27oFGIKKw9MvEwoCHUerQfF+4pwMVvwWCkFpeEWKFExvBnnlgV5i9qF9UcLfLrUDOErreEpF3SkWE/gXt/rGy6WyhEXgJL60c3u9QncDWX2lWInPW1XF+v1+tmVP97l+VH6ZRXz3sRs+fJwGBrEmH34cSwi4ckW7iq7IbuSST/0X9A5DcTTbjBg+9jprzeW8od9Bm7SSiakHY3a+Kcfr3+GFbyfnIpo1OC+weDpz5cXX/5+84Xlchtu79/Z5HRyGt7UxvkC9UjV/l4srIxG25Sdizxaa/x/qfYHLtW6eeTpyU9LhVKP4Go7lu/2ngciErPxHm0eiSWP8dmd2Gw4YL/y44mPf6vIMgaYR2KFVmLMHf1uI1Lp+O90mAYvVsLbX7pHxzG8sJI7aH8/ZDVP2LC8aCfRI9V7S8Bm3kT9pGXTWoqL1oCTW5azlfAMhjFIaDk+JQmV/lXaMe65vrq5FZHo395F2BkKi2teMuJazMS9uBdh5xlab9ir8flGKNR5FV4AopXLAAErztQYXTwGdNH9wZ4djMku7Ghd4X/ZsYMMf+Z7+BPVfxnI2y8vMnSx7ak5P/Omaf4D7WxEoQ==",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:"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+8p1cqNPYPL3MMd86fsPJaeO/4/4WU5fyJ+Ki7qI7puoeJktCnjMcT875L9tHwJc+cyO0ftcD7zG6HsD1M8Q8KO5R8QCKx8h3PsayQuzi1fYJtIe/hNjFFT3TMDW7h9GhwXj2sWHXMxPi1JXXVUmasXUoztXZs2n5lVRi2oHJkKMn//c//xU4+loKd+cNXFUWSrMmm1Uq9KdM0ZOMFR14tDvCQpFzqg5P3Dw84FOZS48KOqAACZYYSyX5tjGZaYfw6MK6CXzdYvIjG17etCLFlxSUMY/h4WsAK2+KoKPv1WtjHzM2KQKEmF/IPEkdUc9Ceok64bbUll3EvRU1ED/JS8tDEmXBxIxxKctkIlkwtxaLiYcCNebEyiJguzkKXV92YE3M2wlnVBUcYY0FkW9d5HWCm8BnuaLW8QA+yKNUlEJesYgIEpMyTAmFx27oFGIKKw9MvEwoCHUerQfF+4pwMVvwWCkFpeEWKFExvBnnlgV5i9qF9UcLfLrUDOErreEpF3SkWE/gXt/rGy6WyhEXgJL60c3u9QncDWX2lWInPW1XF+v1+tmVP97l+VH6ZRXz3sRs+fJwGBrEmH34cSwi4ckW7iq7IbuSST/0X9A5DcTTbjBg+9jprzeW8od9Bm7SSiakHY3a+Kcfr3+GFbyfnIpo1OC+weDpz5cXX/5+84Xlchtu79/Z5HRyGt7UxvkC9UjV/l4srIxG25Sdizxaa/x/qfYHLtW6eeTpyU9LhVKP4Go7lu/2ngciErPxHm0eiSWP8dmd2Gw4YL/y44mPf6vIMgaYR2KFVmLMHf1uI1Lp+O90mAYvVsLbX7pHxzG8sJI7aH8/ZDVP2LC8aCfRI9V7S8Bm3kT9pGXTWoqL1oCTW5azlfAMhjFIaDk+JQmV/lXaMe65vrq5FZHo395F2BkKi2teMuJazMS9uBdh5xlab9ir8flGKNR5FV4AopXLAAErztQYXTwGdNH9wZ4djMku7Ghd4X/ZsYMMf+Z7+BPVfxnI2y8vMnSx7ak5P/Omaf4D7WxEoQ==",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 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)(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.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)(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)(a.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)(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)(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)(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)(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)(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)(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:a}={...(0,t.a)(),...e.components};return a?(0,i.jsx)(a,{...e,children:(0,i.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/28b19cd2.dcf7a360.js b/assets/js/28b19cd2.dcf7a360.js deleted file mode 100644 index eea7dab14..000000000 --- a/assets/js/28b19cd2.dcf7a360.js +++ /dev/null @@ -1 +0,0 @@ -"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 deleted file mode 100644 index ea6d20aba..000000000 --- a/assets/js/2c586be5.1cac45ae.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:()=>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.7973af60.js b/assets/js/2c586be5.7973af60.js new file mode 100644 index 000000000..96a2b8115 --- /dev/null +++ b/assets/js/2c586be5.7973af60.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:()=>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),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+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/lcyPngI1dxmVF2eeeK847Vt6QOL/E1hrtYqxLfIQVbQZ59qIQJMoMcOd1lJEHS8o9d3uSbqKuY0diWpOh0spl22Hw/tiQSYh5hLTWwPTMwetyLyc9ieO0i5jZg3hYDt6zHqLYNantxai9MPetsto0IY0A4cpHU8cmJCzmejpxv/uiZc3tPnqyclXUuIGPrbp5LdG06K4ytP8JxUfvE+GeEdDVTTrFB2q8rlG/FXLrzczW6GRJgkSqfLKF3OIL/51//diuiltzx/gJe1xoqtUA9q33D4qzApaCWu14Xa3Q4kZcFGlM0IKTFuetnzcTc1Q3D60l1RD4VhaALgcCUT8D07hQzhJ87l/WB9iXUKyzoHoFCqUvXbKiA11aVbo/46C2UvpwRSQlwmFJXIhoDBjEuQZlzmZLX689JAkoDl4DSoq60MAhclATsWuNmM5EK95oqaTVPLZRc8jnSZokLTUgKVewp1GpKxRmjitqnfKmzEdF6Fl32dggvqU3UMe4ST2i5KDCDeU0oEqADBMFOiQ2ZwZR8qYq2FymarlmiwCvU7ibxHlVdFFApuqUFL8g37+uWEFnNpaHHNSS9gmpa8VVaka/g9sh4MwSq9tDDQ942GUAh5KVvsD1rzexnnBphsQvLFovFjTvq4fqab4XN6ylorFS3bu4G3Y3WX95+PKQLAHVpXs/eor4SaXQHdux56IAPw9vFfQQQLwReia82F9A7UogUpcHeS/P82zffwxU8Gh6xpHcjfwDBh9+fvvjmh7ffEF56N/z5Gw2Phkcul6SMLbnsbbXRKL55dHvJ6n1f+b6vfN9Xvu8r3/eV37/65L6vfN9Xvu8r3/eV7/vK933l+77yfV/5vq9831e+7yvfYtT7vvJ9X/m+r3zfVw77vvJ9X/nn1+1dfeWh+kd+0mFVcCF7HQy+ZHy22W1+nrCcasrjM3Z9TRnqn6h3hIZ/rVFTQfo8YVdcC0o2unJ0EsuuVG+8RCr8vfBJ/8E72j/xtuYqGBtVeKoY+xXPnXJuhe2Xvd+8fvuOJSw2+5QqozWaL6hbni/YmHxS5jrrnWRdEzN33YcFl/PalUCZx0vVYl7bfL3UfOlKzeFHr5LKZdOjcr0G7Vmhv8TY1gV/pYrHd9j8rQX3MzsXBNlGaFLh+Wq1+i/yI4tj",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/lcyPngI1dxmVF2eeeK847Vt6QOL/E1hrtYqxLfIQVbQZ59qIQJMoMcOd1lJEHS8o9d3uSbqKuY0diWpOh0spl22Hw/tiQSYh5hLTWwPTMwetyLyc9ieO0i5jZg3hYDt6zHqLYNantxai9MPetsto0IY0A4cpHU8cmJCzmejpxv/uiZc3tPnqyclXUuIGPrbp5LdG06K4ytP8JxUfvE+GeEdDVTTrFB2q8rlG/FXLrzczW6GRJgkSqfLKF3OIL/51//diuiltzx/gJe1xoqtUA9q33D4qzApaCWu14Xa3Q4kZcFGlM0IKTFuetnzcTc1Q3D60l1RD4VhaALgcCUT8D07hQzhJ87l/WB9iXUKyzoHoFCqUvXbKiA11aVbo/46C2UvpwRSQlwmFJXIhoDBjEuQZlzmZLX689JAkoDl4DSoq60MAhclATsWuNmM5EK95oqaTVPLZRc8jnSZokLTUgKVewp1GpKxRmjitqnfKmzEdF6Fl32dggvqU3UMe4ST2i5KDCDeU0oEqADBMFOiQ2ZwZR8qYq2FymarlmiwCvU7ibxHlVdFFApuqUFL8g37+uWEFnNpaHHNSS9gmpa8VVaka/g9sh4MwSq9tDDQ942GUAh5KVvsD1rzexnnBphsQvLFovFjTvq4fqab4XN6ylorFS3bu4G3Y3WX95+PKQLAHVpXs/eor4SaXQHdux56IAPw9vFfQQQLwReia82F9A7UogUpcHeS/P82zffwxU8Gh6xpHcjfwDBh9+fvvjmh7ffEF56N/z5Gw2Phkcul6SMLbnsbbXRKL55dHvJ6n1f+b6vfN9Xvu8r3/eV37/65L6vfN9Xvu8r3/eV7/vK933l+77yfV/5vq9831e+7yvfYtT7vvJ9X/m+r3zfVw77vvJ9X/nn1+1dfeWh+kd+0mFVcCF7HQy+ZHy22W1+nrCcasrjM3Z9TRnqn6h3hIZ/rVFTQfo8YVdcC0o2unJ0EsuuVG+8RCr8vfBJ/8E72j/xtuYqGBtVeKoY+xXPnXJuhe2Xvd+8fvuOJSw2+5QqozWaL6hbni/YmHxS5jrrnWRdEzN33YcFl/PalUCZx0vVYl7bfL3UfOlKzeFHr5LKZdOjcr0G7Vmhv8TY1gV/pYrHd9j8rQX3MzsXBNlGaFLh+Wq1+i/yI4tj",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)(o.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)(o.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)(d.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)(o.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)(d.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)(o.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)(d.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.353c0b5e.js b/assets/js/377084eb.353c0b5e.js deleted file mode 100644 index 534712c4e..000000000 --- a/assets/js/377084eb.353c0b5e.js +++ /dev/null @@ -1 +0,0 @@ -"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/377084eb.6a7b09a1.js b/assets/js/377084eb.6a7b09a1.js new file mode 100644 index 000000000..bf52cbd43 --- /dev/null +++ b/assets/js/377084eb.6a7b09a1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),p=s(5397),o=s(4667),d=s(9472),h=s(85162);const x={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWG1v3DYS/itTfrkGkPfF2Ti9RVHUuAY5o0UT1D4EqLMwKGlWYkyRLDnaFyz07X7J/bT+ksNQ0lrrdewYPQS4L/aKmofzzHDeqJ0gWQQxvxZXWDktCYNYJCLHkHnlSFkj5uKqRHiLBL0InL+/AKm1XQfY2hrIgkfyClcIOZJUOoBMbU0gITjM1FJlQB14tN8mQEC/QpABUl2j88pQgKX1kHmUpEwBuc3qCnl5ragE5zHHpTKYQyBfZ1R7DCORCOvQS2Z7kYu5KJB6HSIRTnpZIaFnM3fCyArFXPR0blQuEqHYTCepFPdtv/gJ7HJPHqiUBAYxD2x1irBEykrkPTz+USuPuZiTrzERgbaaNQVVOc1EcOO0zVHMl1IHFshKrKSY7wRtXZQkr0whErG0vpLUrphCNM2Ctw/OmoCBAaeTCf87pBrqLMMQlrWGvT9EIjJrCA2xvHROqyy+GH8KDNods7DpJ8yIHed5G1KtynaZ/fs433YFNzJaPReb6T9TU4XT94VoEkGKePV4iztAiD/2LmeUsfQEaH9AUbRhSjpH/7XMaoPqMYItH4iCzZ0j7uKwI8zU1VMuKolcmI/HPbgO6EeZrRht1+bA7secFfPM9qwSEVRhYp7s0dJ7ueUEIazC09709inqGdovc9gni5BipIWVVPpJ6RTxx26h94UrrXlCzezV2en05Xevpyy/VnmB9Bfsb98e6ztM1HMunZjDSuoaA5wA+11yMUsgkKzc6Ing28sz6c1AoamrFP0QvV/Zo09nsyYR22eiXk/ZP88EvfyuSUT5TNDsjE9OFvhM3PTBtLpsQ/qmP9rmMamYmQFNfmHe+cPykVqrUZqhwljGm0TELML8nB6PtNPJ6cuT6eRk8vpqejaf/X3+6mw0mUx+F4nYVDG8u9aUd1WvZ9k/1y7/Cnqa+2LDQnzfcezOJhGzh9rRpa2QSu7iazQEa29NkYDTKAMC+S3IQioDvI3/5n/Xp9B7+0T9ex6zYcAoo5XBm74X38wmk5vp3gmzYydcDfoSLG1t8q9r6kP6HzdodnO2N+jVsUEXZiW1yuMIeGVv0Xxde4bqqVV/HLGqFYrvxYGxw/XWyIBZ7RVt42y4OZFOnbTv59cLHrs4Umw3VMZhkkoxF/vOO94NBslG8H5+1Y+atdeDZi2dG1mHhou3lmngJjWWTo1X3HvuSweShTLFyTNR0uSp3Xwesbiz+JJPpXX8gd13vc+pn5GbX+fWoVQ3Mpco49DS8PPSRnDn7HcODZfVeFSr6VET/IA6sxXyGE0lQi/+57//ExH95B8j6Rt4V3twdo2ep1tpclhq3KhUP3QXCSgrjSHoLShDWHiO/1wViqSOrZYzP5NOpkorjj0Ws4z2MAjfMIIPJVKJnl/9zSNIyHGFmkMWtLW3vA9ZkDXZKuroOMPa+tslU0pAQloHZTDwbQd7CJpSmgyhP4sErAdpAA2hd14FBKkqFubrEC6XKlO8MSealxlBJY0skJUlwLzZC87blcoxgLdpHQiC1XU0hDVWiNSaGG8vI/hJrbA1nBfbaxvmUNS8RQKZzRG6vGMzTA4pBgLH6lWGcdNA0hNoXKGP0RpPcllrDc5yQVBS8+1peLa8EXlpAnfyllB/NHv3OW/5IhN15HI7go/mo+GiDXVADgCtzG2YfzQncL0Psw+YBkW4+LbPhfV6fZQHLw4xbxWVdQoenb3DFXExZs0Qvn94IRJB6KvwbnmJfqWyfiL/jM5xFB53ZVJmsUx2Iy3n2I/3AVyytMrQBBwUtfO373+BFbwcTUQyyPovIDz+5eIfb369fMP7cm1q8286mowmcUi2gSppBqqGd/37ebu7K/b/B98FukpGuKGx01LFdhCdt+tK+fXdLJOI+fCrwCIRpQ3EIrtdKgP+y+um4eU/avTcMBaJWEmvZMoF73onchX4d76/4X/Wc9/+1n0seAFf/oHhQWP6Wm24UMcLhZgLkYhb3N77ytEseBhvCzazbSXOswwdDbBHDfygC759cyUSIWsqDxvFbWwU3Q/e/UFehx2kJcB/uZE9CPieI+pn3P6wF2/ffBbQ2ddLs48WTdP8F8eriao=",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:"eJzVWG1v3DYS/itTfrkGkPfF2Ti9RVHUuAY5o0UT1D4EqLMwKGlWYkyRLDnaFyz07X7J/bT+ksNQ0lrrdewYPQS4L/aKmofzzHDeqJ0gWQQxvxZXWDktCYNYJCLHkHnlSFkj5uKqRHiLBL0InL+/AKm1XQfY2hrIgkfyClcIOZJUOoBMbU0gITjM1FJlQB14tN8mQEC/QpABUl2j88pQgKX1kHmUpEwBuc3qCnl5ragE5zHHpTKYQyBfZ1R7DCORCOvQS2Z7kYu5KJB6HSIRTnpZIaFnM3fCyArFXPR0blQuEqHYTCepFPdtv/gJ7HJPHqiUBAYxD2x1irBEykrkPTz+USuPuZiTrzERgbaaNQVVOc1EcOO0zVHMl1IHFshKrKSY7wRtXZQkr0whErG0vpLUrphCNM2Ctw/OmoCBAaeTCf87pBrqLMMQlrWGvT9EIjJrCA2xvHROqyy+GH8KDNods7DpJ8yIHed5G1KtynaZ/fs433YFNzJaPReb6T9TU4XT94VoEkGKePV4iztAiD/2LmeUsfQEaH9AUbRhSjpH/7XMaoPqMYItH4iCzZ0j7uKwI8zU1VMuKolcmI/HPbgO6EeZrRht1+bA7secFfPM9qwSEVRhYp7s0dJ7ueUEIazC09709inqGdovc9gni5BipIWVVPpJ6RTxx26h94UrrXlCzezV2en05Xevpyy/VnmB9Bfsb98e6ztM1HMunZjDSuoaA5wA+11yMUsgkKzc6Ing28sz6c1AoamrFP0QvV/Zo09nsyYR22eiXk/ZP88EvfyuSUT5TNDsjE9OFvhM3PTBtLpsQ/qmP9rmMamYmQFNfmHe+cPykVqrUZqhwljGm0TELML8nB6PtNPJ6cuT6eRk8vpqejaf/X3+6mw0mUx+F4nYVDG8u9aUd1WvZ9k/1y7/Cnqa+2LDQnzfcezOJhGzh9rRpa2QSu7iazQEa29NkYDTKAMC+S3IQioDvI3/5n/Xp9B7+0T9ex6zYcAoo5XBm74X38wmk5vp3gmzYydcDfoSLG1t8q9r6kP6HzdodnO2N+jVsUEXZiW1yuMIeGVv0Xxde4bqqVV/HLGqFYrvxYGxw/XWyIBZ7RVt42y4OZFOnbTv59cLHrs4Umw3VMZhkkoxF/vOO94NBslG8H5+1Y+atdeDZi2dG1mHhou3lmngJjWWTo1X3HvuSweShTLFyTNR0uSp3Xwesbiz+JJPpXX8gd13vc+pn5GbX+fWoVQ3Mpco49DS8PPSRnDn7HcODZfVeFSr6VET/IA6sxXyGE0lQi/+57//ExH95B8j6Rt4V3twdo2ep1tpclhq3KhUP3QXCSgrjSHoLShDWHiO/1wViqSOrZYzP5NOpkorjj0Ws4z2MAjfMIIPJVKJnl/9zSNIyHGFmkMWtLW3vA9ZkDXZKuroOMPa+tslU0pAQloHZTDwbQd7CJpSmgyhP4sErAdpAA2hd14FBKkqFubrEC6XKlO8MSealxlBJY0skJUlwLzZC87blcoxgLdpHQiC1XU0hDVWiNSaGG8vI/hJrbA1nBfbaxvmUNS8RQKZzRG6vGMzTA4pBgLH6lWGcdNA0hNoXKGP0RpPcllrDc5yQVBS8+1peLa8EXlpAnfyllB/NHv3OW/5IhN15HI7go/mo+GiDXVADgCtzG2YfzQncL0Psw+YBkW4+LbPhfV6fZQHLw4xbxWVdQoenb3DFXExZs0Qvn94IRJB6KvwbnmJfqWyfiL/jM5xFB53ZVJmsUx2Iy3n2I/3AVyytMrQBBwUtfO373+BFbwcTUQyyPovIDz+5eIfb369fMP7cm1q8286mowmcUi2gSppBqqGd/37ebu7K/b/B98FukpGuKGx01LFdhCdt+tK+fXdLJOI+fCrwCIRpQ3EIrtdKgP+y+um4eU/avTcMBaJWEmvZMoF73onchX4d76/4X/Wc9/+1n0seAFf/oHhQWP6Wm24UMcLhZgLkYhb3N77ytEseBhvCzazbSXOswwdDbBHDfygC759cyUSIWsqDxvFbWwU3Q/e/UFehx2kJcB/uZE9CPieI+pn3P6wF2/ffBbQ2ddLs48WTdP8F8eriao=",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 y(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Template"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of template that needs to be fetched",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"strng"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "x1Hbnms2Pg",\n "title": "sample template",\n "note": "template note",\n "folder": {\n "objectId": "x1Hbnms2Pg",\n "name": "folder name"\n },\n "file": "https://templateuser.com",\n "owner": "template creator name",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/38c56221.7ae433ff.js b/assets/js/38c56221.7ae433ff.js deleted file mode 100644 index 1997f2671..000000000 --- a/assets/js/38c56221.7ae433ff.js +++ /dev/null @@ -1 +0,0 @@ -"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.a09d80c4.js b/assets/js/38c56221.a09d80c4.js new file mode 100644 index 000000000..3df4d8606 --- /dev/null +++ b/assets/js/38c56221.a09d80c4.js @@ -0,0 +1 @@ +"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:()=>y,frontMatter:()=>h,metadata:()=>g,toc:()=>j});var n=a(85893),i=a(11151),t=a(58219),r=(a(62316),a(51039)),l=a.n(r),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+FbvkKbUPWCpTnrySC43M7OPXOVYHT685G33Aj/w9tPJG/UDcy4dwTqkSofgVVITcxTiAnOS/Hgb2pzFV4yh9bjoeUvJ03j3Fus9MsHGAHc2kyUha7qfLcwNj79U4AvYTYNrUV0+6dd+R2fnCxkgN5l82ZBiLxfe4Pv3C/M+kc1tHlMQoaCT/9z//FTlGt2O5fAOXrYPGbsgVrY4IrND0qDIdQVsPS/fwfkSluovAunQM9qUqVUAd4SB3gxwbzJRWXGBMNqDDSY36GXyuKCL+zra/c8SIk9akuS5BW/vAcoIFbIOto45xgGyseyjYpAQQstYrwyDZE40sZCo0OcH48BJgPG2AeBFonPIEqOoRaFNRqFzFyWRN4G1i2FtYWRLXCI5C4+xaSfLgbNb6AN7qNjrCGmui0LtoiKSfwUfeSKLjERVTQKVJQtmyiAT4RcLwOtgNIyEjz+sALzM5+X59QBdA05pcLM2YSR6X0Fjuego17xLT3LKguC3woBoQ+ZCaycoR15CoQ2I3A14buJHztsQPgHF0vzss98/sM2VeBVq9HQt/s9l8uR4d83yvQtVm4KixB74yHsYWMWXff3nHNUqu9pfFNbm1ysfR+hWd80g8H2YB5mEC8rihfPuUgfuyVjkZT5POff791Y+whvezhUgmLe4XGDz/8eK7Tz9df2K5w0rIJT1bzBYR5VkfajQTVccb9NPKnWwdv+3bv+3b/+f79jDYAz2GeaNRmQm27gHN8njH4D25YsCTLsV2yxP8b07vdnz8c0uO0dIqEWt0imsgYqVkBAU8gB+oE6n4ri+hkxtWz+S67fHFE4jIeKbnOM9zasKLtFNMdnV5fSMSkQ0/FNRWMo/DDf+IgBuRiltxK+IPDnFGxB8J+HwrNJqyxTIigSiXsQy2HIspEHqIQGj4wJ6NV6abWHmMkHpX+C879izDH7lsfqDuT3vy/uarDENsR2rO4Gq32/0H5n0WVQ==",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+FbvkKbUPWCpTnrySC43M7OPXOVYHT685G33Aj/w9tPJG/UDcy4dwTqkSofgVVITcxTiAnOS/Hgb2pzFV4yh9bjoeUvJ03j3Fus9MsHGAHc2kyUha7qfLcwNj79U4AvYTYNrUV0+6dd+R2fnCxkgN5l82ZBiLxfe4Pv3C/M+kc1tHlMQoaCT/9z//FTlGt2O5fAOXrYPGbsgVrY4IrND0qDIdQVsPS/fwfkSluovAunQM9qUqVUAd4SB3gxwbzJRWXGBMNqDDSY36GXyuKCL+zra/c8SIk9akuS5BW/vAcoIFbIOto45xgGyseyjYpAQQstYrwyDZE40sZCo0OcH48BJgPG2AeBFonPIEqOoRaFNRqFzFyWRN4G1i2FtYWRLXCI5C4+xaSfLgbNb6AN7qNjrCGmui0LtoiKSfwUfeSKLjERVTQKVJQtmyiAT4RcLwOtgNIyEjz+sALzM5+X59QBdA05pcLM2YSR6X0Fjuego17xLT3LKguC3woBoQ+ZCaycoR15CoQ2I3A14buJHztsQPgHF0vzss98/sM2VeBVq9HQt/s9l8uR4d83yvQtVm4KixB74yHsYWMWXff3nHNUqu9pfFNbm1ysfR+hWd80g8H2YB5mEC8rihfPuUgfuyVjkZT5POff791Y+whvezhUgmLe4XGDz/8eK7Tz9df2K5w0rIJT1bzBYR5VkfajQTVccb9NPKnWwdv+3bv+3b/+f79jDYAz2GeaNRmQm27gHN8njH4D25YsCTLsV2yxP8b07vdnz8c0uO0dIqEWt0imsgYqVkBAU8gB+oE6n4ri+hkxtWz+S67fHFE4jIeKbnOM9zasKLtFNMdnV5fSMSkQ0/FNRWMo/DDf+IgBuRiltxK+IPDnFGxB8J+HwrNJqyxTIigSiXsQy2HIspEHqIQGj4wJ6NV6abWHmMkHpX+C879izDH7lsfqDuT3vy/uarDENsR2rO4Gq32/0H5n0WVQ==",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,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"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 y(e={}){const{wrapper:s}={...(0,i.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.08d2a181.js b/assets/js/451a5132.08d2a181.js new file mode 100644 index 000000000..76aaf288a --- /dev/null +++ b/assets/js/451a5132.08d2a181.js @@ -0,0 +1 @@ +"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:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=a(85893),i=a(11151),r=a(58219),n=(a(62316),a(51039)),t=a.n(n),o=(a(82723),a(9487)),d=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+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/4og8l+/cD9eSoAxyfC1/tbpALyeJLDDkXjlS1sixvKpQtHfiQgUSp2/PBdbOLtAHsbKNICs8klc4RwFCM42dimnLslBUCdv+2oaEA4+GWnnnhUykdeiBVZ0XcixbLpYhE+nAQ42EnvGtpYEa5VjekaAY5ccG/Urexm6zD5jTebEHJBPp8WOjPBZyPAUdMJGBVhqjcl/LROLSaVvg/jqvsAY5XktaOaYL5JUpZRIZgPonuITaRWFys0l2mLWqFd2G+tk4yDcHMGpYqrqp5fgkTZMOlGnqDL3c9DCM0h6EMFPuiyF4WGe6mbDc4KwJGJj2OE355zAwoclzDGHaaLFLAJnI3BpCQ0wPzmmVx4vhh8BM67sA2vhyqngWQ6pV6TE0mnp04D2wwYqwDv/O36XNY2PuqlFWLY8/OHZJm2+vo/cfJ8bgosvWTXI73x8p67djA+Fkpt7ibVn/FVlosh663CMQFqd0n6g943F6/OxolB6l312NXoyffz8+eTFI0/QPmchlrZl3m6YFUERKinT/u3HFV9DTO2hNvPEY5KZ/roxWBm+6FL85TtOb0TOm2STy+X25fmlrpEqZUizQkFh4a8pEOI0QUJBfCShBGaGB0D/5ckWA3lv/aW89DtmnvPCcvbBzwsldJ5ybOWhVxOlxZWdovq6lffXUqmeohzmhWqJ4Lw+M7Z+3RgbMG69oFSfT8gicOmrvx9cTboHsWMsTrcR2lFElx3J4MN8C+nk33Bqv5VhWRC6Mh0NwbmAdmqBKoyELg9zWQ3BqOB9J7umH1IGgVKY8eiQXmCKzy4c5JnsrLzkSrbMPbN03WKdeIXfYrSv7VNuhUyHEnrHh76mNzFsHv3FoLlVpYnjmoztj/B3q3NbImwZVKDryv//8K3IUNm9qNBSz54l403gR1xOeLmAKMdW4VJnGSAxa28VucQkItcYQ9EooQ1h6IBSFKhWBFuwVLo4cHGRKK843JrPM7UUvZcNAvKuQKvR89Y3nRajAOWpOU6GtnbEcsgIasnXUscUsFtbPpgwpESCyJiiDIYiA2LGgqcDkKLpYJLxOgRFoCL3zKqAAVTPx1HqB06nKFQvm4vKQk6jBQImsLBGMm73gvJ2rAoPwNmsCiWB1Ew1hjTUitSYaxCIMxC9qjq3hfFgggdJYiLJhEYnIbYFiW2tshilEhoGEY/Uqxyg0EHgSGufoY7bGSE4brYWz3AQUaN7S+rFlQeTBBB5JLaAuNDv3OW95kYg6ClgNxHvz3nBfE01ATgCtzCyM35sjcb1Ls3eYBUU4+barhcVicacOnh7ynCmqmkx4dHbPV8bDWDV99t3HU5lIQl+HN9NL9HOV47YAH9A5jMTDbWuEPLZGrEHptsZ+us3AbUqrHE3AXiM7PXt7Iebi2SCVSa/qPwPw8OL855evL1+yXO5Nbf2NBukgjfuDDVSD6ak6Q+pW/W1XOyjd9b7H/98PiW0nIlzS0GlQsYVH49fb9nvdf15MElnZQHy6XmcQ8HevNxs+brdjbsqFCpDp3n78oG33PjTuRTTD1X2PmDnopn02JPfobZm6V8Tn0G7X/T3phD+8Yto4o5KuIbOhLc9pnqPrK7gzlA8m29nLK5lIaNi1/UEwi4Ng+w9L767Mqif7cEK0APgv23Qvww+cL69w9eOOvL15kGFrX0fN7p9sNpt/AOPFKCM=",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+tu2zYUfhWWf7YCii2nTYcZw7Bg64KsQVsgGQosNYIj6VhiTZEseeQLDP/bk+zR9iTDoSxbzqVrhq5/4og8l+/cD9eSoAxyfC1/tbpALyeJLDDkXjlS1sixvKpQtHfiQgUSp2/PBdbOLtAHsbKNICs8klc4RwFCM42dimnLslBUCdv+2oaEA4+GWnnnhUykdeiBVZ0XcixbLpYhE+nAQ42EnvGtpYEa5VjekaAY5ccG/Urexm6zD5jTebEHJBPp8WOjPBZyPAUdMJGBVhqjcl/LROLSaVvg/jqvsAY5XktaOaYL5JUpZRIZgPonuITaRWFys0l2mLWqFd2G+tk4yDcHMGpYqrqp5fgkTZMOlGnqDL3c9DCM0h6EMFPuiyF4WGe6mbDc4KwJGJj2OE355zAwoclzDGHaaLFLAJnI3BpCQ0wPzmmVx4vhh8BM67sA2vhyqngWQ6pV6TE0mnp04D2wwYqwDv/O36XNY2PuqlFWLY8/OHZJm2+vo/cfJ8bgosvWTXI73x8p67djA+Fkpt7ibVn/FVlosh663CMQFqd0n6g943F6/OxolB6l312NXoyffz8+eTFI0/QPmchlrZl3m6YFUERKinT/u3HFV9DTO2hNvPEY5KZ/roxWBm+6FL85TtOb0TOm2STy+X25fmlrpEqZUizQkFh4a8pEOI0QUJBfCShBGaGB0D/5ckWA3lv/aW89DtmnvPCcvbBzwsldJ5ybOWhVxOlxZWdovq6lffXUqmeohzmhWqJ4Lw+M7Z+3RgbMG69oFSfT8gicOmrvx9cTboHsWMsTrcR2lFElx3J4MN8C+nk33Bqv5VhWRC6Mh0NwbmAdmqBKoyELg9zWQ3BqOB9J7umH1IGgVKY8eiQXmCKzy4c5JnsrLzkSrbMPbN03WKdeIXfYrSv7VNuhUyHEnrHh76mNzFsHv3FoLlVpYnjmoztj/B3q3NbImwZVKDryv//8K3IUNm9qNBSz54l403gR1xOeLmAKMdW4VJnGSAxa28VucQkItcYQ9EooQ1h6IBSFKhWBFuwVLo4cHGRKK843JrPM7UUvZcNAvKuQKvR89Y3nRajAOWpOU6GtnbEcsgIasnXUscUsFtbPpgwpESCyJiiDIYiA2LGgqcDkKLpYJLxOgRFoCL3zKqAAVTPx1HqB06nKFQvm4vKQk6jBQImsLBGMm73gvJ2rAoPwNmsCiWB1Ew1hjTUitSYaxCIMxC9qjq3hfFgggdJYiLJhEYnIbYFiW2tshilEhoGEY/Uqxyg0EHgSGufoY7bGSE4brYWz3AQUaN7S+rFlQeTBBB5JLaAuNDv3OW95kYg6ClgNxHvz3nBfE01ATgCtzCyM35sjcb1Ls3eYBUU4+barhcVicacOnh7ynCmqmkx4dHbPV8bDWDV99t3HU5lIQl+HN9NL9HOV47YAH9A5jMTDbWuEPLZGrEHptsZ+us3AbUqrHE3AXiM7PXt7Iebi2SCVSa/qPwPw8OL855evL1+yXO5Nbf2NBukgjfuDDVSD6ak6Q+pW/W1XOyjd9b7H/98PiW0nIlzS0GlQsYVH49fb9nvdf15MElnZQHy6XmcQ8HevNxs+brdjbsqFCpDp3n78oG33PjTuRTTD1X2PmDnopn02JPfobZm6V8Tn0G7X/T3phD+8Yto4o5KuIbOhLc9pnqPrK7gzlA8m29nLK5lIaNi1/UEwi4Ng+w9L767Mqif7cEK0APgv23Qvww+cL69w9eOOvL15kGFrX0fN7p9sNpt/AOPFKCM=",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 b(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get folder list"})}),"\n",(0,l.jsx)(t(),{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)(d.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)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(d.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)(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)(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)(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)(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)(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)(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 v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/451a5132.20e29001.js b/assets/js/451a5132.20e29001.js deleted file mode 100644 index 7165dd2f1..000000000 --- a/assets/js/451a5132.20e29001.js +++ /dev/null @@ -1 +0,0 @@ -"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.34673f6d.js b/assets/js/52d5c0f9.34673f6d.js new file mode 100644 index 000000000..fb618e80e --- /dev/null +++ b/assets/js/52d5c0f9.34673f6d.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:()=>v,contentTitle:()=>j,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>f});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),o=a.n(i),d=(a(82723),a(9487)),r=a(41429),c=a(5397),m=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/ZXJvjQBaEm+JEWJoqhbG6mRoAlqFwHqCMaIHJIbL3e3u0tdIPCtX9JP65cUw4tEWbKRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9fASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDk987MZUpgZp8oCVcpmGxrUDDQqhORcPRnJR2lIg6uokj4sFKsyMvSKgbQ0iqTkogzVJ4BSUElingtwso2yOCkzkUkMuNKDMMTWmJzSyxscTIrTtCnoq6nrNVboz15vudkMuG/XQf6dHSWpuCrJCHvs0qp1TMRicTowJGK1wKtVTJpYjn+5Fl8vW9mGwkOrOPIB9kq7wN0yKGt+T8t2Xj7iz0VddTn6jw8LXQyOTk9Op4cTb69OX4Vn30Xv3w1mkwmf4hILEvFsn1SMRDfG2RQ2/d6D9bmbAjsTmoGnx0K47UpKRRS57DgYC6c0XkEVhF6guBWgDlKDQoDuf8wquSccU9H58ssqwdeS62kpru+hu7OJpO7400Qzp6oJW0CZKbS6dd19ZD+px06uzvdOPRy36ErPUcl04aEbsw96a/rz1B9aNXvV6tsQc13sePs8Lx10lNSORlWDdMtj9DKo/Z7fDtluuBKMVuWbNgxFCIW457TxusBM9aCr3Tznjsrp0QsihCsj8djtHZkLGkvc61w5keJKcdo5Xh+LOroIdoHzKXOj75QCnU6M8vHJaZbp685MW3sd1zfZACtfEMrEfWRHaK6GVAQpuSaLEidmUa4i/c7S/pa5rrJ1vx4b1J8IJWYkngohIKgh//z19+NRB/WppiewbvKgTULclmlAHUKmaKlnCk6MBA9YanIe7UCqQPlDnmAylwGVMBR4eZP0OJMKsnlxzDTTspBBfsRfCgoFOT40zeOACGlOSmuWlDG3PM9wQBWwZQ4HNIL4+4zNikChFnlpSbvwRP1IqQL1AlBn4sIjAPUQDqQs056ApQlgzPjgLJMJpIv5l5zmAQoUWNOrCwCtpujYNvZ68GZWeUDeKOqxhHWWBKF1kVNlPoRXMg5tY43GwIFlIpSyCu+IoLEpARd67EbOoUZ+QCW1cuEmkt9QBdA0ZxcU61NJnlSgjXMCRIVLwDD3PJFwaH2PLW77aRLzSZ81hkeuY2OFFcj+Kg/auZtqDxxASip7338UR/B7abMPtDMy0DT530vLBaLvT54sSvzWoaimoEja7ZyeXPYdM1QfPPyQkQikCv9u+ya3Fwm1DXgIzrHDXjcMSUmDVNSiVK1PfbjQwFmLSUT0p4GvHb++v1bmMPpaCKiQdd/hsHjt1c/X/56fcn3Mje1/Xc8mowmfGSNDyXqgapu57zYLoU7rbveUv7/tKJ2BBRoGcZWoWyIvPF53THwrRisrPFwO51GojA+MGS9nqGn352qaz7+syLHVD+NxBydxBnz1O1apNLzc7pZNR/19vlv3db6Aj570T3oS8+wmul1jqriNxGJe1o9WLbraR31NMvGtojzJCEbBrJ7k3dnfF1cvr28uRSRwIqDN2T4+4bhuwdWcNC0XepvbeBfnkAHBb7nInhDqx828PbLowKdiz2awzSt6/pfe/aW0A==",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/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+JEWJoqhbG6mRoAlqFwHqCMaIHJIbL3e3u0tdIPCtX9JP65cUw4tEWbKRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9fASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDk987MZUpgZp8oCVcpmGxrUDDQqhORcPRnJR2lIg6uokj4sFKsyMvSKgbQ0iqTkogzVJ4BSUElingtwso2yOCkzkUkMuNKDMMTWmJzSyxscTIrTtCnoq6nrNVboz15vudkMuG/XQf6dHSWpuCrJCHvs0qp1TMRicTowJGK1wKtVTJpYjn+5Fl8vW9mGwkOrOPIB9kq7wN0yKGt+T8t2Xj7iz0VddTn6jw8LXQyOTk9Op4cTb69OX4Vn30Xv3w1mkwmf4hILEvFsn1SMRDfG2RQ2/d6D9bmbAjsTmoGnx0K47UpKRRS57DgYC6c0XkEVhF6guBWgDlKDQoDuf8wquSccU9H58ssqwdeS62kpru+hu7OJpO7400Qzp6oJW0CZKbS6dd19ZD+px06uzvdOPRy36ErPUcl04aEbsw96a/rz1B9aNXvV6tsQc13sePs8Lx10lNSORlWDdMtj9DKo/Z7fDtluuBKMVuWbNgxFCIW457TxusBM9aCr3Tznjsrp0QsihCsj8djtHZkLGkvc61w5keJKcdo5Xh+LOroIdoHzKXOj75QCnU6M8vHJaZbp685MW3sd1zfZACtfEMrEfWRHaK6GVAQpuSaLEidmUa4i/c7S/pa5rrJ1vx4b1J8IJWYkngohIKgh//z19+NRB/WppiewbvKgTULclmlAHUKmaKlnCk6MBA9YanIe7UCqQPlDnmAylwGVMBR4eZP0OJMKsnlxzDTTspBBfsRfCgoFOT40zeOACGlOSmuWlDG3PM9wQBWwZQ4HNIL4+4zNikChFnlpSbvwRP1IqQL1AlBn4sIjAPUQDqQs056ApQlgzPjgLJMJpIv5l5zmAQoUWNOrCwCtpujYNvZ68GZWeUDeKOqxhHWWBKF1kVNlPoRXMg5tY43GwIFlIpSyCu+IoLEpARd67EbOoUZ+QCW1cuEmkt9QBdA0ZxcU61NJnlSgjXMCRIVLwDD3PJFwaH2PLW77aRLzSZ81hkeuY2OFFcj+Kg/auZtqDxxASip7338UR/B7abMPtDMy0DT530vLBaLvT54sSvzWoaimoEja7ZyeXPYdM1QfPPyQkQikCv9u+ya3Fwm1DXgIzrHDXjcMSUmDVNSiVK1PfbjQwFmLSUT0p4GvHb++v1bmMPpaCKiQdd/hsHjt1c/X/56fcn3Mje1/Xc8mowmfGSNDyXqgapu57zYLoU7rbveUv7/tKJ2BBRoGcZWoWyIvPF53THwrRisrPFwO51GojA+MGS9nqGn352qaz7+syLHVD+NxBydxBnz1O1apNLzc7pZNR/19vlv3db6Aj570T3oS8+wmul1jqriNxGJe1o9WLbraR31NMvGtojzJCEbBrJ7k3dnfF1cvr28uRSRwIqDN2T4+4bhuwdWcNC0XepvbeBfnkAHBb7nInhDqx828PbLowKdiz2awzSt6/pfe/aW0A==",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"}},v={},f=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"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)(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,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.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)(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)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.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)(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)(u.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)(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)(m.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)(c.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)(m.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.46904785.js b/assets/js/52d5c0f9.46904785.js deleted file mode 100644 index 15a42175b..000000000 --- a/assets/js/52d5c0f9.46904785.js +++ /dev/null @@ -1 +0,0 @@ -"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.4ca525ce.js b/assets/js/5a2de241.4ca525ce.js new file mode 100644 index 000000000..2c9bb48e0 --- /dev/null +++ b/assets/js/5a2de241.4ca525ce.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,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),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/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvW/UQl1k5urzGtMt4hOuSpv4a7g36UcrX9NKJH1ah1Id288JC3KxBFzsd1tmfdGXbFOVXTrq2ejrCGb3SnErZQwZQ3DlpS5NRNR1wFtL+oSNc/8s9m9Y/UAqNxUx2/NtpRf/648/o0YfTWzve/C2dmDNklxZqxh3qehKZqq9mKFSZrm5l3nCSpH3agVSB5q5GLucyYAq4pV6BjlazKSSPBAsZljbwWCm/Ag+zCnMyfGnHxwBQkELUjxHoIy5ZDvBANbBVNFHFzMsjbssOaQEELLaS03egyfqVUjPUecEfYMkYBygBtKBnHXSE6CsWLg0DqgsZS7ZME+/wzxAhRpnxM4S4Lg5C92i9eBMVvsA3qg6AomXVaLQQow3wRE8lwtqgfNhe2ulAmY1m0ggNwVBtwwYhi4gIx/AsnuZUzTqAzq+ly3IxRGKlWTyBmt4S0lUfBsd1pYNBYfa8yptA+pLs0mfdYZvAdFHgasRnOtzfcLNUnviBlBSX/r0XO/B2abNPlDmZaDp/X5Al8vljeF8cF3npQzzOgNH1mz1ZvEwjvJQffMPXzUDucq/LU/ILWRO3Vb4jM9xFB53uxvzuLupQqnawf9lV4GnScmctB/O9NOXx29gAQ9HE5EMVtFXBDx+c/TsxW8nL9guL8x2/vZHk9GEj6zxoUI9cLXz9tkd3fWWhP7tp1K3HgNdhbFVKCPHRPDrjh/OxGDLpcNX0jQRc+MDi6zXGXp671TT8PGnmhyz0DQRC3SSI40kUkjPv4vNa+ezsO+/698d8G0PrlsB9SSgmQEWqOp41U7EJa12Xn7NtEl6JuCIW4lnbVx7p2xna+HG/YBJrNV4mudkw52yQ0I+fn8qEpF1r7gqPgiFwyW/IHEpUnEuzkV82cZ9w0LxfC0U6lmNM5ZvzTJ/Yc2VG5LfZSS/7gcDuzUl11mxRcJ/GdetCj9xK76m1c8b8fbLZxW61PbSXJ5p0zR/AySHpuc=",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/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HaO3IWNK8PRVmfpSbaoxWjhf7okl2pX3AmdSzvW/UQl1k5urzGtMt4hOuSpv4a7g36UcrX9NKJH1ah1Id288JC3KxBFzsd1tmfdGXbFOVXTrq2ejrCGb3SnErZQwZQ3DlpS5NRNR1wFtL+oSNc/8s9m9Y/UAqNxUx2/NtpRf/648/o0YfTWzve/C2dmDNklxZqxh3qehKZqq9mKFSZrm5l3nCSpH3agVSB5q5GLucyYAq4pV6BjlazKSSPBAsZljbwWCm/Ag+zCnMyfGnHxwBQkELUjxHoIy5ZDvBANbBVNFHFzMsjbssOaQEELLaS03egyfqVUjPUecEfYMkYBygBtKBnHXSE6CsWLg0DqgsZS7ZME+/wzxAhRpnxM4S4Lg5C92i9eBMVvsA3qg6AomXVaLQQow3wRE8lwtqgfNhe2ulAmY1m0ggNwVBtwwYhi4gIx/AsnuZUzTqAzq+ly3IxRGKlWTyBmt4S0lUfBsd1pYNBYfa8yptA+pLs0mfdYZvAdFHgasRnOtzfcLNUnviBlBSX/r0XO/B2abNPlDmZaDp/X5Al8vljeF8cF3npQzzOgNH1mz1ZvEwjvJQffMPXzUDucq/LU/ILWRO3Vb4jM9xFB53uxvzuLupQqnawf9lV4GnScmctB/O9NOXx29gAQ9HE5EMVtFXBDx+c/TsxW8nL9guL8x2/vZHk9GEj6zxoUI9cLXz9tkd3fWWhP7tp1K3HgNdhbFVKCPHRPDrjh/OxGDLpcNX0jQRc+MDi6zXGXp671TT8PGnmhyz0DQRC3SSI40kUkjPv4vNa+ezsO+/698d8G0PrlsB9SSgmQEWqOp41U7EJa12Xn7NtEl6JuCIW4lnbVx7p2xna+HG/YBJrNV4mudkw52yQ0I+fn8qEpF1r7gqPgiFwyW/IHEpUnEuzkV82cZ9w0LxfC0U6lmNM5ZvzTJ/Yc2VG5LfZSS/7gcDuzUl11mxRcJ/GdetCj9xK76m1c8b8fbLZxW61PbSXJ5p0zR/AySHpuc=",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)(r(),{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)(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 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)(d.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)(d.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)(d.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)(d.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 deleted file mode 100644 index b83778015..000000000 --- a/assets/js/5a2de241.6f610eff.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:()=>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.ab27f80c.js b/assets/js/5c04ee3b.ab27f80c.js new file mode 100644 index 000000000..2d33b0ee2 --- /dev/null +++ b/assets/js/5c04ee3b.ab27f80c.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:()=>g,frontMatter:()=>m,metadata:()=>x,toc:()=>b});var l=a(85893),o=a(11151),t=a(58219),i=(a(62316),a(51039)),n=a.n(i),r=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),h=a(9472),p=a(85162);const m={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:"eJy9Vm1v2zYQ/itXftkKKLbTtRhgDEOLLQiCFmsBp8gHxwhO0kliTZEcSfkFhr7tl+yn7ZcMR0mO7CzFNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3dXbnub9GhIsfaLx5SuNGb1DJPM7ErVmT/n+ZjNOHLj2XuqsV4zTWHaXoFM/FCdWxvSPpKWucDHsxXx7E7gKtvOjO58tVu0pETaEy/UxzwRgqMRfT7XG8PbkNOR/xvAuPs4TWTowl7WWpFaaeZ2iKVk43l6JNzr19wFLq8uIfolDnqdk9j1g9UlzwNXSdPiF67Dda+Z72Ihn6OPZKhOTrrwhzcrHnUhcmgvvufrSkF7LU8W42l+JcVe5IZaYm1o9QEQzuf/z2e0TkJmtq0iGOzgv42DiwZkuOVQF1DoWinUwVPaqRH+TIE9aKvFd7kDpQ6TAQ5LKUARVwV6QuIUOLqVSSh43dDKMdjObVT+CuolCR46NvHAFCThtSPKOgjFlznGAAm2DqmKOvGbbGrQsuKQGEtPFSk/fgiQYI6Qp1RjDcRQLGAWogHchZJz0BypqdC+OAikJmkgPzZjnMAtSosSROlgDXzV2wzmxkTh6cSRsfwBvVRCKcsSYKHUVNlPsJ/Cw31BFnY04BpaIcyoZDJJCZnKBfNKahc0jJB7CcXmYUg/qALoCiDbk4rfEmi0YpsIYVQKICU5zcLQcKDrUvjKu7goarObbPOsMPQMyR434C9/peL3hYGk88AErqtZ/f6wtYHsfsjlIvA62+HXZhu90+2YOXp5hrGaomBUfWPOLKaIxbM4Yf/3gpEhHI1f5jsSC3kdnwYDyTcxqdp70uYhZ1kWqUqtuxt+cA1iglM9KeRir27vrTB9jAd5OZSEZb/zcKnn64+enql8UVx2Vt6vbvcjKbzNhkjQ816lGq0WN/vraHR3H/N/8X9MoSaBemVqGMehzJHHotXR4f6FUiKuMDmw6HFD19dqpt2fxrQ44VepWIDTqJKQvOctUmgx6x+K5pz13LMrKs1BtUTSdqZw/SiapfX92KRGDDlYx1cB11sP/B0YcjvR/FPhXIrgD+ZJ3+S8AP3LL3tP/x6N6dPAvo+Q3e3L9V27Z/AuOba9U=",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:"eJy9Vm1v2zYQ/itXftkKKLbTtRhgDEOLLQiCFmsBp8gHxwhO0kliTZEcSfkFhr7tl+yn7ZcMR0mO7CzFNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3dXbnub9GhIsfaLx5SuNGb1DJPM7ErVmT/n+ZjNOHLj2XuqsV4zTWHaXoFM/FCdWxvSPpKWucDHsxXx7E7gKtvOjO58tVu0pETaEy/UxzwRgqMRfT7XG8PbkNOR/xvAuPs4TWTowl7WWpFaaeZ2iKVk43l6JNzr19wFLq8uIfolDnqdk9j1g9UlzwNXSdPiF67Dda+Z72Ihn6OPZKhOTrrwhzcrHnUhcmgvvufrSkF7LU8W42l+JcVe5IZaYm1o9QEQzuf/z2e0TkJmtq0iGOzgv42DiwZkuOVQF1DoWinUwVPaqRH+TIE9aKvFd7kDpQ6TAQ5LKUARVwV6QuIUOLqVSSh43dDKMdjObVT+CuolCR46NvHAFCThtSPKOgjFlznGAAm2DqmKOvGbbGrQsuKQGEtPFSk/fgiQYI6Qp1RjDcRQLGAWogHchZJz0BypqdC+OAikJmkgPzZjnMAtSosSROlgDXzV2wzmxkTh6cSRsfwBvVRCKcsSYKHUVNlPsJ/Cw31BFnY04BpaIcyoZDJJCZnKBfNKahc0jJB7CcXmYUg/qALoCiDbk4rfEmi0YpsIYVQKICU5zcLQcKDrUvjKu7goarObbPOsMPQMyR434C9/peL3hYGk88AErqtZ/f6wtYHsfsjlIvA62+HXZhu90+2YOXp5hrGaomBUfWPOLKaIxbM4Yf/3gpEhHI1f5jsSC3kdnwYDyTcxqdp70uYhZ1kWqUqtuxt+cA1iglM9KeRir27vrTB9jAd5OZSEZb/zcKnn64+enql8UVx2Vt6vbvcjKbzNhkjQ816lGq0WN/vraHR3H/N/8X9MoSaBemVqGMehzJHHotXR4f6FUiKuMDmw6HFD19dqpt2fxrQ44VepWIDTqJKQvOctUmgx6x+K5pz13LMrKs1BtUTSdqZw/SiapfX92KRGDDlYx1cB11sP/B0YcjvR/FPhXIrgD+ZJ3+S8AP3LL3tP/x6N6dPAvo+Q3e3L9V27Z/AuOba9U=",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 f(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)(n(),{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)(t.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.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)(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)(p.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)(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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.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)(d.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)(c.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)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(h.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)(d.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.e37eecda.js b/assets/js/5c04ee3b.e37eecda.js deleted file mode 100644 index ee9af1b3c..000000000 --- a/assets/js/5c04ee3b.e37eecda.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:()=>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 deleted file mode 100644 index ce531ed55..000000000 --- a/assets/js/5ce9853b.3a3ae921.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:()=>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.d72b2598.js b/assets/js/5ce9853b.d72b2598.js new file mode 100644 index 000000000..f92ea70b1 --- /dev/null +++ b/assets/js/5ce9853b.d72b2598.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:()=>x,contentTitle:()=>h,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=a(85893),l=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:"eJzlV8mOGzcQ/ZUyL4mB1jLO+NIIAjtjwxjYyAw8DnyYEQSqu9Sih03SXLSg0bd8ST4tXxIUe1FrJG8JkhxyEVpkba/IelWsmOeFY+kte6GzUKLyjs0SlqPLrDBeaMVS9hYdqhwsfgzoPJRcSPAagkMLS23BiUIJVUDemhjfKZYwbdBysnCZ9zZaE2SBJaz997POdyytWKaVR+XpkxsjRRa1Jx8cBVExl62w5PRFesJiTmF3PuciZwnDaHmWML8zyFKmFx8w8yxhxlI4XqAjA0OltOqEnbdCFWRly0sjaclYvRY59shA5Kzu3JzQPMxbpx0TFbO2tLqM6ULrKIUWR0epbbK3j4G0n7V/x5ku+wDmLjTwvhjIRXC+dcx9sNj7i3agtQNCgcetn6x8KelgS+7HcMEVCJXJkCMstZR6Q0e95lbwhUQHUFV9Or3wEusaqopQoZ0rXmJdJ/sF8newYFZatSIWMxTrA61+CfeK/dpAFbdG2N08575dyHRpuNoNA2gu6TxYWdfjgwzvM7por+LfSicZ+R/nsk5YjJ2lzMai32e2ps199XobMC44o5VrSvPJdBor9CDhLPl6cvh85Vt0QZ6smOaMTtNAUyVU/y5kGTq3DFLuxgdYhZJC4bwDM38ync7PpgS5Ttj5P4sKrdX2W0Hd6BL9ii7ghpBtrFbF5yGdT6fzJz2i82NEoz1RKu1hqYPKQSyH9AnCxb1MW4sZtYpRw48HCi1z5s1WU1atoomXKpJVQ6QghfOg914if/6XmT2RBG0foPxSps/nZ32mnx5n+lKtuRQ5PL++hHf6HtWjfwHzHuHQvW/cU6jbMnZFIooIKgrFfXYAdrjegHSYBSv8jqW3FduOuBGjZj+9ndWzhNFV1TRHGO1ixNyvWMome4ZhZMSu0bpoI1jJUrby3rh0MuHGjLVBRTdG8oWjPjrhRkzWZ6xOHko7zwuhitE3anGVL/T20xqzPcwbOoom2wdg+5xzI17jjiVdLodSCRN0BVbIc7Qx73TCb/fD1MvunB5MOifHmX6aOR40juYMxg4bZeycQi11jLw93iuD6kYUKl6O9dlR93yPMtMl0vjjVwid+B+//R41utji3X0EV8GC0Ru0yyCBqxyWErdiITEKc+qhDnY6kDmHvJTonKT267Gw3CPkohCey35IzbjhCyEF3XYS06RtYVAwbgzvV+hXaGnrO4vAIcc1SioSkFrfkx2vgQevy+ijy+dG2/slhZQAh0VwQqFz4BA7FVQrrjKE7iIkxAxcASqP1ljhELgoSZgGa1wuRSbIMJW25RlNiIoXSM4SoLgpC+2xOrB6EZwHp2WIQMhjiegbiAoxd2N4IdbYAKfFHD0XEnMoAplIINM5QnsLCIbKYUGzjSH3IsNo1HluPUhco42lEk+SmiIYTRQkuCRGHp4tGfKWK0fM2QTUHU2fPmM1ddfoI+e7MdypO0V9isiTLoAU6t6l1DNu+2v2HhdOeJx93xXiZrM5KsLHhzqvhF+FBVg0eq9XxMVYskP1/s9jljCPtnRXyxu0a5FhW/2f8DmJwpOWmHkzqHfFxo149lCBqkmKDJXDAY0+f3X9Btbww3jKkgHlfEXAkzeXFy9/uXlJdokYm/o7G0/HU1oiKi25Grg68dB7WL6DZ9pffBe2DBenYyO5iL0h4qpaWr8dDI70mFsR56e3rKoW3OGvNHTS8seAlhrGLGHdCB3bRdJRI/WBeySeumhiHr0j3yQuQ8OyD7oksXqj8TzL0PjPyg7b0vXVzTuWsO79UOo8zr98Q89cvmEpu2N3LL6KY2XGWZTWKya5KgIvSL6xS4zOAyVi2A7uYztoPwhZt6V2gygP+0QDhX4J2EmFH4lAXuPup1682fmkQpvbTpqOb1bX9Z/NjcyN",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,j={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:"eJzlV8mOGzcQ/ZUyL4mB1jLO+NIIAjtjwxjYyAw8DnyYEQSqu9Sih03SXLSg0bd8ST4tXxIUe1FrJG8JkhxyEVpkba/IelWsmOeFY+kte6GzUKLyjs0SlqPLrDBeaMVS9hYdqhwsfgzoPJRcSPAagkMLS23BiUIJVUDemhjfKZYwbdBysnCZ9zZaE2SBJaz997POdyytWKaVR+XpkxsjRRa1Jx8cBVExl62w5PRFesJiTmF3PuciZwnDaHmWML8zyFKmFx8w8yxhxlI4XqAjA0OltOqEnbdCFWRly0sjaclYvRY59shA5Kzu3JzQPMxbpx0TFbO2tLqM6ULrKIUWR0epbbK3j4G0n7V/x5ku+wDmLjTwvhjIRXC+dcx9sNj7i3agtQNCgcetn6x8KelgS+7HcMEVCJXJkCMstZR6Q0e95lbwhUQHUFV9Or3wEusaqopQoZ0rXmJdJ/sF8newYFZatSIWMxTrA61+CfeK/dpAFbdG2N08575dyHRpuNoNA2gu6TxYWdfjgwzvM7por+LfSicZ+R/nsk5YjJ2lzMai32e2ps199XobMC44o5VrSvPJdBor9CDhLPl6cvh85Vt0QZ6smOaMTtNAUyVU/y5kGTq3DFLuxgdYhZJC4bwDM38ync7PpgS5Ttj5P4sKrdX2W0Hd6BL9ii7ghpBtrFbF5yGdT6fzJz2i82NEoz1RKu1hqYPKQSyH9AnCxb1MW4sZtYpRw48HCi1z5s1WU1atoomXKpJVQ6QghfOg914if/6XmT2RBG0foPxSps/nZ32mnx5n+lKtuRQ5PL++hHf6HtWjfwHzHuHQvW/cU6jbMnZFIooIKgrFfXYAdrjegHSYBSv8jqW3FduOuBGjZj+9ndWzhNFV1TRHGO1ixNyvWMome4ZhZMSu0bpoI1jJUrby3rh0MuHGjLVBRTdG8oWjPjrhRkzWZ6xOHko7zwuhitE3anGVL/T20xqzPcwbOoom2wdg+5xzI17jjiVdLodSCRN0BVbIc7Qx73TCb/fD1MvunB5MOifHmX6aOR40juYMxg4bZeycQi11jLw93iuD6kYUKl6O9dlR93yPMtMl0vjjVwid+B+//R41utji3X0EV8GC0Ru0yyCBqxyWErdiITEKc+qhDnY6kDmHvJTonKT267Gw3CPkohCey35IzbjhCyEF3XYS06RtYVAwbgzvV+hXaGnrO4vAIcc1SioSkFrfkx2vgQevy+ijy+dG2/slhZQAh0VwQqFz4BA7FVQrrjKE7iIkxAxcASqP1ljhELgoSZgGa1wuRSbIMJW25RlNiIoXSM4SoLgpC+2xOrB6EZwHp2WIQMhjiegbiAoxd2N4IdbYAKfFHD0XEnMoAplIINM5QnsLCIbKYUGzjSH3IsNo1HluPUhco42lEk+SmiIYTRQkuCRGHp4tGfKWK0fM2QTUHU2fPmM1ddfoI+e7MdypO0V9isiTLoAU6t6l1DNu+2v2HhdOeJx93xXiZrM5KsLHhzqvhF+FBVg0eq9XxMVYskP1/s9jljCPtnRXyxu0a5FhW/2f8DmJwpOWmHkzqHfFxo149lCBqkmKDJXDAY0+f3X9Btbww3jKkgHlfEXAkzeXFy9/uXlJdokYm/o7G0/HU1oiKi25Grg68dB7WL6DZ9pffBe2DBenYyO5iL0h4qpaWr8dDI70mFsR56e3rKoW3OGvNHTS8seAlhrGLGHdCB3bRdJRI/WBeySeumhiHr0j3yQuQ8OyD7oksXqj8TzL0PjPyg7b0vXVzTuWsO79UOo8zr98Q89cvmEpu2N3LL6KY2XGWZTWKya5KgIvSL6xS4zOAyVi2A7uYztoPwhZt6V2gygP+0QDhX4J2EmFH4lAXuPup1682fmkQpvbTpqOb1bX9Z/NjcyN",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"}},x={},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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Resend request mail"})}),"\n",(0,i.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,i.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,i.jsx)(s.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)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,i.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,i.jsx)(s.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(s.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(m.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,i.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,i.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,i.jsx)(m.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body 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,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{}),(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)(c.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"400",value:"400",children:[(0,i.jsx)("div",{}),(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)(c.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(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."\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(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)(c.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "document not found or user not found."\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(p.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(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 y(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/70853c19.6ace34db.js b/assets/js/70853c19.6ace34db.js new file mode 100644 index 000000000..9f374ac68 --- /dev/null +++ b/assets/js/70853c19.6ace34db.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8766],{6809:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>u,contentTitle:()=>j,default:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),l=n(11151),i=n(58219),r=(n(62316),n(51039)),t=n.n(r),d=(n(82723),n(9487)),o=(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:"eJztWdtuGzcQ/ZUJA/QSrCU5dYFiURR1EyEVGl8Q2fCDJTjU7khizSW3JFeyIOitX9JP65cUQ+5Kq7WjJIjrooD8YEvkGXLOcDgkj5fM8Yll8TW7wtFU61s2jFiKNjEid0IrFrOLKYLlMwRtoMhT7hBKLByf94BLqeew0AU4HXDzsrcwEuZTkUxBWCgspoRwRkwmaABnqJwdqOfPn5ef44EaqMMWvHgxEzjHNH7xYqAAAA7gaooKrJgoNBA6IdVJkaFy4KbChhFgLqSsJmgF2/fv34cPy/CHfgbMwwcshgELww1YVO8fC4mh+/XZq8uT7unFzeW7tw2Q4lkTdHp80m2itCtR5xK5RTBIUwJXqWcU/K/YNIxrCxHGaPSHkFjqu960b5Ft+trvvTntvrvvaRmYjAu5BeyeHPfePoDMp1ptD3n+69lpd8DqwNXmy3DL8RD1XxYfmaoCHpeLddE76fYvjk/OG6jEIHcPwirUaqBeUmqVyGZurbNJWCghX5pY5TD7zHrazPqkVPBQ9R0lhCe6Mx8CAkaLqgJ9YWKE8Rrx1qPfMXG9dMDi2qr3XtdZ77Pn0bKnZja85/gXl5sVZdeRLzc6yyV+pOBsEoxLWSaZ/UiWfUL9qabeV6B/J4c+WIGqwD/KqeWh6ntKphQTKT5SrCrM45WrasR9Gj1tGlVx/4RLUgV9lIRjEdM5Gk4R7aUsZnSn/ypc/Ks3QsQM/lGgdb/odMHiZePFcG70TKToHwBOlxcq2BgnWjlUjgx5nkuR+Mnav1uyXjKbTDHj9IlmEQZTep9cGklvE7fIkcXleckilhvy1gm0ZFAYSX9KkHVGqAmL2FibjLt6C95x2qUsZlPnchu32wtdmIPy6XJQGPlzCWklOmOrVcSccN6gxNyMiPtqRV0Gba6VDT687HTuh6RfJAlaOy4krKP7OZHYTdugLaR7iPmGZ/VmCyuZgl17JBfPtggKRdl0U5G6ednp3PxQMj16kJzO0E2FmsDcVxmj1SSCPGxmZxbAJ1wokNyhefZ4rNEYbXaT/jzPdgXhqNO5OVwH4fB+EK5qr14uDfJ0AXgnrLNPS3mXH7sJHt7M1wSP7hO8tGhAaQdjXaj0aUk1595N5GhN4/v7NHpqxqVIvXZxoW9RPS2T+vQuTE+u3mW+cNEh5Cl5kO9nW1Tr7YGkxaQwwi1YfL1kdwc8FwehP74eroYRow2gqY7n2nqPuZuymLXn63Js0czQWD+AL6DrmsjzvKVzVHSISj6yVAvbPBft2SFbRU20dXwi1OTgM624Skf67sMWww3HPq1DCPUW03XAeS5+wwWLqkDWURETtP5T5CkaH3Ra3nebg6xbLVLTxd1HA4071t6JcpnOclR9urjQIs8OWVNRu0KZ6Ay9HDZFqOB///mXt6huOj4Hn8FZYSDXczR0eNCdaCzxTowkbuQ3u9bfkGcSrZULEMrhxNDBm4qJcDy8LKgUJjznIyEFZS3BNFkbqCW+bdHN0k3RUNfXBoFDijOUlOwgtb6lcZwGXjid+TmqO+hcm9sxuRQBh1FhhUJrwSJWJqimXCUI1ZpGpCtyBagcmtwIi8BFRuCxNoDjsUgEDUxb1PDEQcYVnyBNFgH5TVHIw43DgtGjwjqwWhaeCM2YIbpAUSGmtgWvxQwDcWpM0XEhMYVJQUNEkOgUoVxioqFSGKF1kNP0IkE/qHXcOJA4Q+Oz3q8kHaaQayolgkvQ4621pYGc4crSdSQ4VC3NOny50XQq+zlSvmgBiaJ0ipGASgkghbolqfQArtdpdoUjKxwOv6kSdj6f39tP327bvBFuWozAYK43dhPf6Hdf3Xz95VsWMYcms2fjPpqZSKoL1AfmbHtwuyywPPEF1l+gw179uWlAu0mKBJXFWjk8fnP+FmbwXavDotrW/ASH2297r7qn/S6NSzUu7L/DVqfVoSYqiRlXtan6pdB9uSV0N3fwcnNg7OXx/dtvL4/v5fH/SWbt5fF99uzl8b08vpfH9/L4/zqN/kN5vNQaHN65di658BJNqTwHdeW6EolJsZ6S7hJfs+VyxC1eGrlaUfMfBRoSbYYRm3Ej+Iikg+vhKqoUCpJjbnHBYvYqPDYOLmhigssiiB0NpYrElWBxnCSYu53YujR0fta/YBEblWp+plOyMXxOSj+fs5hR4vj/DPhXtdecqX3JJFeTgk8IH8YlYYUXFIW6KnPrVZnyAzGrutSi5uW2XBOo0G8i9qDBj/TE+g0XP63hoeeDBmVsKzSt3XC1Wv0DWFo5kg==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=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:"eJztWdtuGzcQ/ZUJA/QSrCU5dYFiURR1EyEVGl8Q2fCDJTjU7khizSW3JFeyIOitX9JP65cUQ+5Kq7WjJIjrooD8YEvkGXLOcDgkj5fM8Yll8TW7wtFU61s2jFiKNjEid0IrFrOLKYLlMwRtoMhT7hBKLByf94BLqeew0AU4HXDzsrcwEuZTkUxBWCgspoRwRkwmaABnqJwdqOfPn5ef44EaqMMWvHgxEzjHNH7xYqAAAA7gaooKrJgoNBA6IdVJkaFy4KbChhFgLqSsJmgF2/fv34cPy/CHfgbMwwcshgELww1YVO8fC4mh+/XZq8uT7unFzeW7tw2Q4lkTdHp80m2itCtR5xK5RTBIUwJXqWcU/K/YNIxrCxHGaPSHkFjqu960b5Ft+trvvTntvrvvaRmYjAu5BeyeHPfePoDMp1ptD3n+69lpd8DqwNXmy3DL8RD1XxYfmaoCHpeLddE76fYvjk/OG6jEIHcPwirUaqBeUmqVyGZurbNJWCghX5pY5TD7zHrazPqkVPBQ9R0lhCe6Mx8CAkaLqgJ9YWKE8Rrx1qPfMXG9dMDi2qr3XtdZ77Pn0bKnZja85/gXl5sVZdeRLzc6yyV+pOBsEoxLWSaZ/UiWfUL9qabeV6B/J4c+WIGqwD/KqeWh6ntKphQTKT5SrCrM45WrasR9Gj1tGlVx/4RLUgV9lIRjEdM5Gk4R7aUsZnSn/ypc/Ks3QsQM/lGgdb/odMHiZePFcG70TKToHwBOlxcq2BgnWjlUjgx5nkuR+Mnav1uyXjKbTDHj9IlmEQZTep9cGklvE7fIkcXleckilhvy1gm0ZFAYSX9KkHVGqAmL2FibjLt6C95x2qUsZlPnchu32wtdmIPy6XJQGPlzCWklOmOrVcSccN6gxNyMiPtqRV0Gba6VDT687HTuh6RfJAlaOy4krKP7OZHYTdugLaR7iPmGZ/VmCyuZgl17JBfPtggKRdl0U5G6ednp3PxQMj16kJzO0E2FmsDcVxmj1SSCPGxmZxbAJ1wokNyhefZ4rNEYbXaT/jzPdgXhqNO5OVwH4fB+EK5qr14uDfJ0AXgnrLNPS3mXH7sJHt7M1wSP7hO8tGhAaQdjXaj0aUk1595N5GhN4/v7NHpqxqVIvXZxoW9RPS2T+vQuTE+u3mW+cNEh5Cl5kO9nW1Tr7YGkxaQwwi1YfL1kdwc8FwehP74eroYRow2gqY7n2nqPuZuymLXn63Js0czQWD+AL6DrmsjzvKVzVHSISj6yVAvbPBft2SFbRU20dXwi1OTgM624Skf67sMWww3HPq1DCPUW03XAeS5+wwWLqkDWURETtP5T5CkaH3Ra3nebg6xbLVLTxd1HA4071t6JcpnOclR9urjQIs8OWVNRu0KZ6Ay9HDZFqOB///mXt6huOj4Hn8FZYSDXczR0eNCdaCzxTowkbuQ3u9bfkGcSrZULEMrhxNDBm4qJcDy8LKgUJjznIyEFZS3BNFkbqCW+bdHN0k3RUNfXBoFDijOUlOwgtb6lcZwGXjid+TmqO+hcm9sxuRQBh1FhhUJrwSJWJqimXCUI1ZpGpCtyBagcmtwIi8BFRuCxNoDjsUgEDUxb1PDEQcYVnyBNFgH5TVHIw43DgtGjwjqwWhaeCM2YIbpAUSGmtgWvxQwDcWpM0XEhMYVJQUNEkOgUoVxioqFSGKF1kNP0IkE/qHXcOJA4Q+Oz3q8kHaaQayolgkvQ4621pYGc4crSdSQ4VC3NOny50XQq+zlSvmgBiaJ0ipGASgkghbolqfQArtdpdoUjKxwOv6kSdj6f39tP327bvBFuWozAYK43dhPf6Hdf3Xz95VsWMYcms2fjPpqZSKoL1AfmbHtwuyywPPEF1l+gw179uWlAu0mKBJXFWjk8fnP+FmbwXavDotrW/ASH2297r7qn/S6NSzUu7L/DVqfVoSYqiRlXtan6pdB9uSV0N3fwcnNg7OXx/dtvL4/v5fH/SWbt5fF99uzl8b08vpfH9/L4/zqN/kN5vNQaHN65di658BJNqTwHdeW6EolJsZ6S7hJfs+VyxC1eGrlaUfMfBRoSbYYRm3Ej+Iikg+vhKqoUCpJjbnHBYvYqPDYOLmhigssiiB0NpYrElWBxnCSYu53YujR0fta/YBEblWp+plOyMXxOSj+fs5hR4vj/DPhXtdecqX3JJFeTgk8IH8YlYYUXFIW6KnPrVZnyAzGrutSi5uW2XBOo0G8i9qDBj/TE+g0XP63hoeeDBmVsKzSt3XC1Wv0DWFo5kg==",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"}},u={},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)(d.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)(d.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)(o.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)(d.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)(o.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)(d.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)(o.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)(d.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)(o.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)(d.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)(o.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/70853c19.caa20f8c.js b/assets/js/70853c19.caa20f8c.js deleted file mode 100644 index 30190e2e2..000000000 --- a/assets/js/70853c19.caa20f8c.js +++ /dev/null @@ -1 +0,0 @@ -"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.1ad6ce7c.js b/assets/js/770b40a9.1ad6ce7c.js deleted file mode 100644 index 0f1aba49a..000000000 --- a/assets/js/770b40a9.1ad6ce7c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>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/770b40a9.cfa8a05d.js b/assets/js/770b40a9.cfa8a05d.js new file mode 100644 index 000000000..150e967b4 --- /dev/null +++ b/assets/js/770b40a9.cfa8a05d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});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/5KmjOjfkRgxnVL7uo53nU6GmB09kcZWnevEwY7yx84ruonH3lrWb8mnEG6T62Tqzj2rnrgJ56Hs1fU90ILcuvjSoKDPDBc1GO3X0PcpMl0jDqy8QOvjff/4VGN2MGuLnGVxWFoyeo6UBi6scJhIXggbq3fnbIS8lOieXIJTHqaVumYup8FyGak0zcMYNT4UUFHEE08S20AtaN4D3BfoCLW19Z2mez3GGkgIVpNZ3YcbWwCuvyyCj1Rnm2t5NSKUIOKSVEwqdA4fYUVAVXGUI3V1EoC3N/Kg8WmOFQ+CiJPBEW8DJRGSCDqb0sjzzUHLFp0jCIiC9yQvrx4PVaeU8OC2rYAhJLBF9Y6JCzN0AfhEzbAynxRw9FxJzmFZ0RASZzhHabCMzVA4pOg+GxIsMw6HOc+tB4gxtiNZwk5NKSjCayoDgkl4v/bulg7zlylEzaBTqrmbtPmM1zdJBRs6XA/igPqgrCpbKIQWAFOrOJR/UAdysw+w9pk54HH/f5cJ8Pt/Jg+fbnHPhiyoFi0ZveNOwGLKmT19/PGcR82hLdzm5ohda1g11D8gcBvCwLY48C8WxnYoox17dJ1ChkiJD5bBXys7O372FGRwNYhb1sv4LFB6+vfj59W9Xr+lcqk1N/o0G8SAOc5Z2vuSqJ2rrkdvWta3kXW3q/P/0VdyWQI8LPzSSi9A9gtdXbeW/YVuVfxyxQjtP66tVyh3+bmVd03LzNqV+kAtH1m5ep3e47L2lw0TJEhbq+gPY9tG7gY7pwwrChkYVdTWZBDacsyxD0xew05m32tv562sWMV75YrsX3IVe0P6g07stteydvd0kGgXoL9n0WcKPFCpvcPnTGt7sPEho7evQdDXjuq7/AS+aIgM=",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/5KmjOjfkRgxnVL7uo53nU6GmB09kcZWnevEwY7yx84ruonH3lrWb8mnEG6T62Tqzj2rnrgJ56Hs1fU90ILcuvjSoKDPDBc1GO3X0PcpMl0jDqy8QOvjff/4VGN2MGuLnGVxWFoyeo6UBi6scJhIXggbq3fnbIS8lOieXIJTHqaVumYup8FyGak0zcMYNT4UUFHEE08S20AtaN4D3BfoCLW19Z2mez3GGkgIVpNZ3YcbWwCuvyyCj1Rnm2t5NSKUIOKSVEwqdA4fYUVAVXGUI3V1EoC3N/Kg8WmOFQ+CiJPBEW8DJRGSCDqb0sjzzUHLFp0jCIiC9yQvrx4PVaeU8OC2rYAhJLBF9Y6JCzN0AfhEzbAynxRw9FxJzmFZ0RASZzhHabCMzVA4pOg+GxIsMw6HOc+tB4gxtiNZwk5NKSjCayoDgkl4v/bulg7zlylEzaBTqrmbtPmM1zdJBRs6XA/igPqgrCpbKIQWAFOrOJR/UAdysw+w9pk54HH/f5cJ8Pt/Jg+fbnHPhiyoFi0ZveNOwGLKmT19/PGcR82hLdzm5ohda1g11D8gcBvCwLY48C8WxnYoox17dJ1ChkiJD5bBXys7O372FGRwNYhb1sv4LFB6+vfj59W9Xr+lcqk1N/o0G8SAOc5Z2vuSqJ2rrkdvWta3kXW3q/P/0VdyWQI8LPzSSi9A9gtdXbeW/YVuVfxyxQjtP66tVyh3+bmVd03LzNqV+kAtH1m5ep3e47L2lw0TJEhbq+gPY9tG7gY7pwwrChkYVdTWZBDacsyxD0xew05m32tv562sWMV75YrsX3IVe0P6g07stteydvd0kGgXoL9n0WcKPFCpvcPnTGt7sPEho7evQdDXjuq7/AS+aIgM=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},g={},f=[{value:"Request",id:"request",level:2}];function 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 diff --git a/assets/js/78b2b753.1d06cdac.js b/assets/js/78b2b753.1d06cdac.js deleted file mode 100644 index 813d923a2..000000000 --- a/assets/js/78b2b753.1d06cdac.js +++ /dev/null @@ -1 +0,0 @@ -"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/78b2b753.d6937815.js b/assets/js/78b2b753.d6937815.js new file mode 100644 index 000000000..469b267d7 --- /dev/null +++ b/assets/js/78b2b753.d6937815.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>u,contentTitle:()=>x,default:()=>v,frontMatter:()=>j,metadata:()=>f,toc:()=>g});var a=s(85893),i=s(11151),r=s(58219),n=(s(62316),s(51039)),d=s.n(n),t=(s(82723),s(9487)),o=s(41429),c=s(5397),m=s(4667),p=s(9472),h=s(85162);const j={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+UMrre21mxZYIUREA4RWpCJFlUis6OzuWXua2ZnpzKwvsvYfT8Kj8STo7MWX2EEUEH8S75zrdy7fzEYEnHmR3IjvjMrJiWkkcvKZkzZIo0Ui3s0JclIUCFoVOH97CaiUWXpYmwqC6eVFIx+KSBhLDtnBZS4S0YpbqYiERYclBXIcdyM0liQS0YrvZC4iITmwxTAXD7Mx6QfKwmUOpoCtQ0cfK+koF0lwFUXCh7Vil16WVpGIBK2sMjmJpEDlWSGbU4ki2Yiwto1mcFLPRCQK40oM+ye0wsZLItLX46zIJ3Obirqeclhvjfbk2dEkjvnfYba+yjLyvqgUbCsiIpEZHUgH1kdrlcwaweiDZ6PNcXYtaK6cYzdBtiH7Wnwqjh/u/eRHS8tLK+qoa05+Hk652RlN4snzwTgexJ+/G79Mzr5MXrwcxnH8q4jEqlRs2/Uxx0DsN8igdt97B1Irqemur97dJI7vxhNR16x0dqqMg67VID1oE4BKG9YRcBlRag+5yaqSdADj+hm81QO4NiWFudQzWLJw6YyeRWAVoScIbg04Q6lBYSD35PZfNcZouip4mutow6PxGNazOL57voV6dgy1A8ooC1PpfPjfjQs5Z9ynzspxPn/VyrP47O6LLbwXx/Au9QKVzBsKCeae9JP/Ad8OzYnwnOrhAMtWqZGLA7D75y1IT1nlZFg3RLYaoJWDVp7cTHkOeADNjgIb8gtzkYhRW9jRZkt7tWB3btHTYuWUSMQ8BOuT0QitHRpL2suZVpj6YWbKEVo5WoxFHT3U9gFnUs8Gn2iFOk/N6nGL6Q7wNTelrfsB7G310crXtBZRX9V9rY7g54TM31xHqQvTGHe1vrKkr+VMN51ajI+ugfekMlMS3z1hTtCr//Hb741FTwjNID2Bq8qBNUtyTMSocygUrWSq6MRV5glLRd6rNUgdaOYwEORyJgMq4Kown2RoMZVK8uixmmFrB3vT64fwfk5hTo5FnzkChJwWpHhiQRlzz36CAayCKZsYPYktjbsvOKUIENLKS03egyfqTUjPUWcEfS8i5j3UQDqQs056ApQlKxfGARWFzCQ75j1zmAUoUeOMOFgEnDdXwTqzkDl5cCatfABvVNUA4YglUWghaqLcD+GVXFALnA9zCigV5TCr2AUzc07QrR3D0Dmk5ANYDi8zapz6gC6AogW5ZlqbThaVUmAN84FExbf8fm/ZUXCoPVNWm1Dfmm35rDN85zYxclwP4Vbfar4KoPLEA6CkvvcJXxA32zF7T6mXgaZP+11YLpdHe/Ds0OZ7GeZVCo6s2dnNmsNma/bNtx/PRCQCudJfFdfkFjKjbgEfiTlqlEcdS2LWsCSVKFW7Y988NGDGUjIj7WmP086/f/sGFvB8GItob+v/RsKjN5ffXvx0fcF+mZva/RsP42HMR9b4UKLeC/Vq/634cHE3O7L/Zw/Ljl0CrcLIKpQNQzeANh213ojtuzDZvSmnkZgbH1i82aTo6Ren6pqPP1bkmL+nkVigk5gyAd1sRC49/863j8ZHgTz9uXt/PoOTz9OTOfc0qZkjF6gq/hKRuKf1wWO4ntZRz5ScVis/zzKyYc/y6OI8uH1eXby5eHchIoEVl2ifpO8bku5+cICTiR2yd5sD/+VL5KTBV9zL17T+eqveSh416CD22lykaV3XfwLaq2HI",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=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+UMrre21mxZYIUREA4RWpCJFlUis6OzuWXua2ZnpzKwvsvYfT8Kj8STo7MWX2EEUEH8S75zrdy7fzEYEnHmR3IjvjMrJiWkkcvKZkzZIo0Ui3s0JclIUCFoVOH97CaiUWXpYmwqC6eVFIx+KSBhLDtnBZS4S0YpbqYiERYclBXIcdyM0liQS0YrvZC4iITmwxTAXD7Mx6QfKwmUOpoCtQ0cfK+koF0lwFUXCh7Vil16WVpGIBK2sMjmJpEDlWSGbU4ki2Yiwto1mcFLPRCQK40oM+ye0wsZLItLX46zIJ3Obirqeclhvjfbk2dEkjvnfYba+yjLyvqgUbCsiIpEZHUgH1kdrlcwaweiDZ6PNcXYtaK6cYzdBtiH7Wnwqjh/u/eRHS8tLK+qoa05+Hk652RlN4snzwTgexJ+/G79Mzr5MXrwcxnH8q4jEqlRs2/Uxx0DsN8igdt97B1Irqemur97dJI7vxhNR16x0dqqMg67VID1oE4BKG9YRcBlRag+5yaqSdADj+hm81QO4NiWFudQzWLJw6YyeRWAVoScIbg04Q6lBYSD35PZfNcZouip4mutow6PxGNazOL57voV6dgy1A8ooC1PpfPjfjQs5Z9ynzspxPn/VyrP47O6LLbwXx/Au9QKVzBsKCeae9JP/Ad8OzYnwnOrhAMtWqZGLA7D75y1IT1nlZFg3RLYaoJWDVp7cTHkOeADNjgIb8gtzkYhRW9jRZkt7tWB3btHTYuWUSMQ8BOuT0QitHRpL2suZVpj6YWbKEVo5WoxFHT3U9gFnUs8Gn2iFOk/N6nGL6Q7wNTelrfsB7G310crXtBZRX9V9rY7g54TM31xHqQvTGHe1vrKkr+VMN51ajI+ugfekMlMS3z1hTtCr//Hb741FTwjNID2Bq8qBNUtyTMSocygUrWSq6MRV5glLRd6rNUgdaOYwEORyJgMq4Kown2RoMZVK8uixmmFrB3vT64fwfk5hTo5FnzkChJwWpHhiQRlzz36CAayCKZsYPYktjbsvOKUIENLKS03egyfqTUjPUWcEfS8i5j3UQDqQs056ApQlKxfGARWFzCQ75j1zmAUoUeOMOFgEnDdXwTqzkDl5cCatfABvVNUA4YglUWghaqLcD+GVXFALnA9zCigV5TCr2AUzc07QrR3D0Dmk5ANYDi8zapz6gC6AogW5ZlqbThaVUmAN84FExbf8fm/ZUXCoPVNWm1Dfmm35rDN85zYxclwP4Vbfar4KoPLEA6CkvvcJXxA32zF7T6mXgaZP+11YLpdHe/Ds0OZ7GeZVCo6s2dnNmsNma/bNtx/PRCQCudJfFdfkFjKjbgEfiTlqlEcdS2LWsCSVKFW7Y988NGDGUjIj7WmP086/f/sGFvB8GItob+v/RsKjN5ffXvx0fcF+mZva/RsP42HMR9b4UKLeC/Vq/634cHE3O7L/Zw/Ljl0CrcLIKpQNQzeANh213ojtuzDZvSmnkZgbH1i82aTo6Ren6pqPP1bkmL+nkVigk5gyAd1sRC49/863j8ZHgTz9uXt/PoOTz9OTOfc0qZkjF6gq/hKRuKf1wWO4ntZRz5ScVis/zzKyYc/y6OI8uH1eXby5eHchIoEVl2ifpO8bku5+cICTiR2yd5sD/+VL5KTBV9zL17T+eqveSh416CD22lykaV3XfwLaq2HI",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={},g=[{value:"Request",id:"request",level:2}];function b(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)(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)(r.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,i.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/7b076186.7764bd79.js b/assets/js/7b076186.7764bd79.js new file mode 100644 index 000000000..5e2a71d05 --- /dev/null +++ b/assets/js/7b076186.7764bd79.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,t)=>{t.r(a),t.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>v});var s=t(85893),l=t(11151),n=t(58219),r=(t(62316),t(51039)),i=t.n(r),o=(t(82723),t(9487)),d=t(41429),c=t(5397),m=t(4667),p=t(9472),h=t(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/itXfmkLKLaTph0mDMOyNuiCFmuxZCiw1AjO4lliTZEcSfkFhr7tl+yn7ZcMJ8m2HDtFCwwF9iWxyHt97u45rkXEPIj0Vry0JmIWgxgnQlLIvHJRWSNScVMQvCJNkaATgov3V4Ba20WAla0gWvBU2jkBQtaJTL0t+dJvTibWzgZwNW00jAVtTU4eDJEEBIc+qqzSuJV/HECZqfUlchwJxEKFxnGJMwqgIhCGFfuWbXCxIOXBU2a9HIhEWEe+0b2SIhWtUGdbJMKhx5Iiec5+LQyWJFLR3d8pKRKhOHuHsRD3IXnv7VxJAjv5RFm8kmCn28S3AYlEePqzUp6kSKOvKBEhrjS7Cap0mgVo6bSVJNIp6sACWUElinQt4so1ktErk4tEtEj0T2iJjZVUuOJsUpxhkKKux+w1OGsCBbZzNhrxv/34N3VsA5UQqiyjEKaV1qtHImlgIBNZEZ3TKmtwHH4KrL0+jLLFgVH1jHpUre8NPMfy2UX/85Jjd7+4Z6JOujrJi/h5pbPR2bOT09HJ6Lub0xfp+ffp8xeD0Wj0h0jEstSs21VUYiS2G1XUu+/6QKwtWV+wO6lZ+PwYite2pFgok8OCTISFtyZPwGnCQBD9CjBHZUBjJP8fokreW/95dL4usrqXtTJaGbrbtNDd+Wh0d7oF4fzhVjI2wtRWRn7bTI+4/3w653dn23SeH6ZzZeaolWyI5sbOyHzbdPruY+v+sFdVK9Tci71k++dtkoGyyqu4akhueYJOnbT36e2YuYL7xO74sSHGWIhUDDs+G653nFgLNujnG9KsvBapKGJ0IR0O0bmBdWSCyo3GSRhkthyiU8P5qaiT+9IhYq5MfvKVWmjkxC4f1hjvUr7msrTI7yW+xR+dekMrkWxw7Ut17F8QSvJNDXgZNcod2u8cmWuVm6ZW89ODHfGBdGZL4n0QC4KN+D9//d1oSJtVJZnYtNIjeFd5cHZBflppQCNhqmmpJpqO7NpAWGoKQa9AmUi5x0ggVa4iamBUePAzdDhRWnHzsZhtl3Gvf8MAPhQUC/J89djz9pY0J809C9raGduJFrCKtmx8dDHDwvrZlENKAGFSBWUoBAhEGxUyBZqMYFOLBKwHNEAmkndeBQJUJQtPrQeaTlWm2DD3mud5LtFgTuwsAY6bUXDt1g3g7aQKEYLVVZMIeyyJYpsivyjCAF6pObWJ86GkiEqThLxiEwlkVhJ0g8dpGAkTChEcu1cZNUZDRB9B05x8061NJXlLgrPMCAo1r/5+bdlQ9GgCL+w2oE1ptvA5b3ndNj4krgbw0Xw0zNlQBeIG0MrMQvrRnMDtts0+0CSoSOMnm1lYLBYHc/B0X+e1ikU1AU/O7vTy5rCZmr769uOpSEQkX4Z302vyc5VRN4AP+Bw2wsOOJ/l1xVxXotLtjP10X4E5S6uMTKAeq128fv8W5vBsMBJJb+q/IODh26uXl79eX7Jd5qZ2/k4Ho8GIj5wNsUTTc7X/mr0/uesd3/9v374dw0VaxqHTqJo90YC67gj+Vuzewmnv2TtORGFDZIH1eoKBfve6rvn4z4o875FxIuboFU6YBm/XQqrAv+X2Efsgmk9+697DT+FLX9BHE9nwt2HynqOu+EskYkar/Td8Pa6TDYdzqK3ARZaRiz3Vg6W+txlfXb69vLkUicCKgeuvj1mzProf7OBoZPt7pY2B//J6O6rwA5f6Da1+3Iq3Nw8qdClupBmlcV3X/wJ7U9VT",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletecontact",title:"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/itXfmkLKLaTph0mDMOyNuiCFmuxZCiw1AjO4lliTZEcSfkFhr7tl+yn7ZcMJ8m2HDtFCwwF9iWxyHt97u45rkXEPIj0Vry0JmIWgxgnQlLIvHJRWSNScVMQvCJNkaATgov3V4Ba20WAla0gWvBU2jkBQtaJTL0t+dJvTibWzgZwNW00jAVtTU4eDJEEBIc+qqzSuJV/HECZqfUlchwJxEKFxnGJMwqgIhCGFfuWbXCxIOXBU2a9HIhEWEe+0b2SIhWtUGdbJMKhx5Iiec5+LQyWJFLR3d8pKRKhOHuHsRD3IXnv7VxJAjv5RFm8kmCn28S3AYlEePqzUp6kSKOvKBEhrjS7Cap0mgVo6bSVJNIp6sACWUElinQt4so1ktErk4tEtEj0T2iJjZVUuOJsUpxhkKKux+w1OGsCBbZzNhrxv/34N3VsA5UQqiyjEKaV1qtHImlgIBNZEZ3TKmtwHH4KrL0+jLLFgVH1jHpUre8NPMfy2UX/85Jjd7+4Z6JOujrJi/h5pbPR2bOT09HJ6Lub0xfp+ffp8xeD0Wj0h0jEstSs21VUYiS2G1XUu+/6QKwtWV+wO6lZ+PwYite2pFgok8OCTISFtyZPwGnCQBD9CjBHZUBjJP8fokreW/95dL4usrqXtTJaGbrbtNDd+Wh0d7oF4fzhVjI2wtRWRn7bTI+4/3w653dn23SeH6ZzZeaolWyI5sbOyHzbdPruY+v+sFdVK9Tci71k++dtkoGyyqu4akhueYJOnbT36e2YuYL7xO74sSHGWIhUDDs+G653nFgLNujnG9KsvBapKGJ0IR0O0bmBdWSCyo3GSRhkthyiU8P5qaiT+9IhYq5MfvKVWmjkxC4f1hjvUr7msrTI7yW+xR+dekMrkWxw7Ut17F8QSvJNDXgZNcod2u8cmWuVm6ZW89ODHfGBdGZL4n0QC4KN+D9//d1oSJtVJZnYtNIjeFd5cHZBflppQCNhqmmpJpqO7NpAWGoKQa9AmUi5x0ggVa4iamBUePAzdDhRWnHzsZhtl3Gvf8MAPhQUC/J89djz9pY0J809C9raGduJFrCKtmx8dDHDwvrZlENKAGFSBWUoBAhEGxUyBZqMYFOLBKwHNEAmkndeBQJUJQtPrQeaTlWm2DD3mud5LtFgTuwsAY6bUXDt1g3g7aQKEYLVVZMIeyyJYpsivyjCAF6pObWJ86GkiEqThLxiEwlkVhJ0g8dpGAkTChEcu1cZNUZDRB9B05x8061NJXlLgrPMCAo1r/5+bdlQ9GgCL+w2oE1ptvA5b3ndNj4krgbw0Xw0zNlQBeIG0MrMQvrRnMDtts0+0CSoSOMnm1lYLBYHc/B0X+e1ikU1AU/O7vTy5rCZmr769uOpSEQkX4Z302vyc5VRN4AP+Bw2wsOOJ/l1xVxXotLtjP10X4E5S6uMTKAeq128fv8W5vBsMBJJb+q/IODh26uXl79eX7Jd5qZ2/k4Ho8GIj5wNsUTTc7X/mr0/uesd3/9v374dw0VaxqHTqJo90YC67gj+Vuzewmnv2TtORGFDZIH1eoKBfve6rvn4z4o875FxIuboFU6YBm/XQqrAv+X2Efsgmk9+697DT+FLX9BHE9nwt2HynqOu+EskYkar/Td8Pa6TDYdzqK3ARZaRiz3Vg6W+txlfXb69vLkUicCKgeuvj1mzProf7OBoZPt7pY2B//J6O6rwA5f6Da1+3Iq3Nw8qdClupBmlcV3X/wJ7U9VT",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={},v=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:t}=a;return t||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete Contact"})}),"\n",(0,s.jsx)(i(),{method:"delete",path:"/contact/{contact_id}"}),"\n",(0,s.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,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(t,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(d.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"Provide objectId of contact to delete",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"ph2bh2asd"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(n.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Contact deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(o.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)(t,{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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.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)(o.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)(t,{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)(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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.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:"Contact not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(o.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)(t,{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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Contact not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "error": "Contact 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)(o.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)(t,{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)(m.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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,s.jsx)(a,{...e,children:(0,s.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 deleted file mode 100644 index db5f354c2..000000000 --- a/assets/js/7b076186.b8f734db.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:()=>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/8a725248.4dec468f.js b/assets/js/8a725248.4dec468f.js deleted file mode 100644 index ff5d37abf..000000000 --- a/assets/js/8a725248.4dec468f.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:()=>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.79523427.js b/assets/js/8a725248.79523427.js new file mode 100644 index 000000000..aa3e2f155 --- /dev/null +++ b/assets/js/8a725248.79523427.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:()=>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)),c=(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/0kMo71kO2QIwYpjjLCJRKRgiLSImpna2ZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBSy/SK/HO6IB58GKciIJ87qQN0miRisspwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCFMMkKMG5kcPXpaanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej6fUoX8xRqlo4JjRhVKJRKhsSKRCDs1mjh+YWlJpMJktxSFW8deBEmeJUTqdNVR+eCkLkUiJsZVGHZPaIGVVUx0a9gNEuukVfp8/ozobXvQy03FohqDnylqODoeDY+Hx6OhWK8TEWSIx3uZuck4IWu+38YruJrigbdG+yYWo8Hgft66KmtEFuDrPCfvJ7VSyxfPydXTeWiOuayeFwA7HWbTxejWcgj/58l8NTwejuIfi2gDfhIeErNlGg1Gx0fDwdHgu8vhm/TV9+nrN73BYPC7SMSiUtsSFwWG6GVXI93v2hZfQc/6kKwtzoICSuV3GTocWMeSffVQUV6YisJU6hLmpAPMndFlAlYReoLgloAlSg0KA7l/sUjJOeOeDtPzLNvtWamV1HTTdeTNq8HgZrgJwvDxzkTlCIsl0EL64L+uu4/Z8LRjwx3HXt937FTPUMkiDrZLc0f66/q0qz406u+Xr2yI4r3Yc3b3vHHSU147GZYivVqJxRFaedTcp1fj9TgRXDGGB6o1PlqMYSpS0T+cr57cjJyPYmqnRCqmIVif9vtobc9Y0jzHFWaeYaiPVvZnDCWH1D5gKXV59Ewu1EVmFo9zjLeeXnA2moDv+bsJO1r5kZbdtE73qBIhuQqmhAW5GHpO8q/b5eJ9l6pNNjoQ32D4Q7C8QeW9qcnaJiaa1qbwzJK+kKWOBTAbisMV7DOp3FTEm0uYEnTkf/3xZ+ToFqZYny/grHZgzZzcpFaAuoCJooXMFD2wt3nCqt3apA5UOl6LClnKgCruaIwrOVrMpJJc0Uxmmo1tpyl8Dz5PKUwpLnPfOAKEgmakuBFAGXPHcoIBrIOpoo7WZpgbdzdhkxJAyGovNXkPnqhjIT1FnRN0mU7AOEANpAM566QnQFkxMe+SNJnIXLJgrmLHSFGhxpJYWQJsN0fBNruhB2ey2gfwRtXREdZYEYXGRU1U+B78LGfUOM6HzQChAsqaRSSQm4KgzTu7oQvIyAewrF7mFIX6gC6Aohm52Asxk7zTgDUMMxIVmMlebllQcKg9j/DGoC41m/BZZ3g5ijoKXPbgWl9rHglQe+ICUFLf+fRaH8HVpsw+U+ZloPG3XafN5/N7XfZyn+eDDNM6A0fWbPnKeBh7cpd98+OlSEQgV/mzyQW5mcypbe9HdPYjcb8FX8YgBtC2wdDKt4cM3E1K5qT9bnOefDj/BDM47g1EsoMp/8Dg/qfTd+9/uXjPchn5mv4b9ga9QVyyjA8V6h1V+y+jw85dbYfIf/yOalEw0CL0rUIZR0gMzapF/6uD19U4EVOeDumVWK0y9PSbU+s1H3+pyfFoGSdihk5ixiB2NV4nHYLyuLijZTutSYejS1bP5KpuwPhgnjL4NxwneU42PEm7O8DOzy4uRSKy9gVYmYJ5HM75dYhzkYprcS3iQzL2d3zD8flKKNRljWVE8yiXgR9rjsXu1LiLU6P9YM+6K73csXJ/nDSu8H927EGGHzj5H2n544a8uXmUoY1tR80ZHK/X678BoZ5zNA==",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/0kMo71kO2QIwYpjjLCJRKRgiLSImpna2ZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBSy/SK/HO6IB58GKciIJ87qQN0miRisspwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCFMMkKMG5kcPXpaanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej6fUoX8xRqlo4JjRhVKJRKhsSKRCDs1mjh+YWlJpMJktxSFW8deBEmeJUTqdNVR+eCkLkUiJsZVGHZPaIGVVUx0a9gNEuukVfp8/ozobXvQy03FohqDnylqODoeDY+Hx6OhWK8TEWSIx3uZuck4IWu+38YruJrigbdG+yYWo8Hgft66KmtEFuDrPCfvJ7VSyxfPydXTeWiOuayeFwA7HWbTxejWcgj/58l8NTwejuIfi2gDfhIeErNlGg1Gx0fDwdHgu8vhm/TV9+nrN73BYPC7SMSiUtsSFwWG6GVXI93v2hZfQc/6kKwtzoICSuV3GTocWMeSffVQUV6YisJU6hLmpAPMndFlAlYReoLgloAlSg0KA7l/sUjJOeOeDtPzLNvtWamV1HTTdeTNq8HgZrgJwvDxzkTlCIsl0EL64L+uu4/Z8LRjwx3HXt937FTPUMkiDrZLc0f66/q0qz406u+Xr2yI4r3Yc3b3vHHSU147GZYivVqJxRFaedTcp1fj9TgRXDGGB6o1PlqMYSpS0T+cr57cjJyPYmqnRCqmIVif9vtobc9Y0jzHFWaeYaiPVvZnDCWH1D5gKXV59Ewu1EVmFo9zjLeeXnA2moDv+bsJO1r5kZbdtE73qBIhuQqmhAW5GHpO8q/b5eJ9l6pNNjoQ32D4Q7C8QeW9qcnaJiaa1qbwzJK+kKWOBTAbisMV7DOp3FTEm0uYEnTkf/3xZ+ToFqZYny/grHZgzZzcpFaAuoCJooXMFD2wt3nCqt3apA5UOl6LClnKgCruaIwrOVrMpJJc0Uxmmo1tpyl8Dz5PKUwpLnPfOAKEgmakuBFAGXPHcoIBrIOpoo7WZpgbdzdhkxJAyGovNXkPnqhjIT1FnRN0mU7AOEANpAM566QnQFkxMe+SNJnIXLJgrmLHSFGhxpJYWQJsN0fBNruhB2ey2gfwRtXREdZYEYXGRU1U+B78LGfUOM6HzQChAsqaRSSQm4KgzTu7oQvIyAewrF7mFIX6gC6Aohm52Asxk7zTgDUMMxIVmMlebllQcKg9j/DGoC41m/BZZ3g5ijoKXPbgWl9rHglQe+ICUFLf+fRaH8HVpsw+U+ZloPG3XafN5/N7XfZyn+eDDNM6A0fWbPnKeBh7cpd98+OlSEQgV/mzyQW5mcypbe9HdPYjcb8FX8YgBtC2wdDKt4cM3E1K5qT9bnOefDj/BDM47g1EsoMp/8Dg/qfTd+9/uXjPchn5mv4b9ga9QVyyjA8V6h1V+y+jw85dbYfIf/yOalEw0CL0rUIZR0gMzapF/6uD19U4EVOeDumVWK0y9PSbU+s1H3+pyfFoGSdihk5ixiB2NV4nHYLyuLijZTutSYejS1bP5KpuwPhgnjL4NxwneU42PEm7O8DOzy4uRSKy9gVYmYJ5HM75dYhzkYprcS3iQzL2d3zD8flKKNRljWVE8yiXgR9rjsXu1LiLU6P9YM+6K73csXJ/nDSu8H927EGGHzj5H2n544a8uXmUoY1tR80ZHK/X678BoZ5zNA==",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={},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 Contact"})}),"\n",(0,l.jsx)(i(),{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)(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 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)(o.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)(c.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)(o.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)(c.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)(o.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)(c.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)(o.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)(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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a855f99.a5cf424a.js b/assets/js/8a855f99.a5cf424a.js deleted file mode 100644 index 3acf7f1df..000000000 --- a/assets/js/8a855f99.a5cf424a.js +++ /dev/null @@ -1 +0,0 @@ -"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/8a855f99.f275f83a.js b/assets/js/8a855f99.f275f83a.js new file mode 100644 index 000000000..2cb8422b8 --- /dev/null +++ b/assets/js/8a855f99.f275f83a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[3495],{50437:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>y,frontMatter:()=>x,metadata:()=>u,toc:()=>v});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),m=s(5397),p=s(4667),c=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:"eJy9V+9uGzcMfxWWX9YCF9tJ0247DMO6ruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2MnWIB1X/xHIinyR/JHaYlBlB7TC/zVqIIcjhMsyOdO2iCNxhTPpwQfbSECQSsCL05PQChl5h4WpoZgoDZxf9Lua1ERCA9zUoq/rXCkQ6t8UgwwQWPJCbZ/UmCKdbTeKmOCVjhRUSDHbi2RrWGK7faVLDBByX5ZEaZ421mTfaY8nBRgJrA26OhLLR0VmAZXU4I+LBSb9LKyijBBurHKFITpRCjPAvmUKoHpEsPCRsngpC4xwYlxlQj9FboR0UqK2ZvDfFIcTW2GTTNujyUffjbFgk1tO3rqzEwWBBkpM4d1yAxm7mgDJiaYGx1IB7YhrFUyj8gNP3s2tOw5u4nzYgVXxG6cdGG06DDEjjMQJHnWa2XfRZwfFrKmeednExPXy/NDbWHTJBhkUL1sZ4xd0/COI2+N9q3HR6PRLqS+znPyflIrWNfXQ+C7H6Sush4a1m/X/uh3S/MTyxC1pV68CPvMbJSORkdPDw5HB6Nvzw+fp8ffp8+eD0aj0R+Y4E2lWHfVFWwNe7i1/3sLUiup6apD7+poNLo6PFxherwPxjNTUZhKXcKcdIC5M7pMwCoSniC4BYhSSA1KBHKP/jt8yTnj7kflYZ7dh8Ixo7AG4XgXhI7JTICJqXUkra8d6H1VtOvP/eEdX323Du/ZbngneiaULCKTB3NN+v9N5J7j2dXt0patUNzHrWD7622QnvLaybCIA+PmQFh50O6nF2OmYq4bw6PG1tFhHh0pDltUh8v1bGmQbblZN3tqpzDFaQjWp8OhsHZgLGkvS61E5ge5qYbCyuHsEJvktrQPopS6PHigltBFZm7u1hhvoj3jjLSgb8W8hl5Y+YYWmHSQ9qVWU3RKIrJ3kyAn+sNmZr3q0rU9IPqcv0v5yJmSemKiF6uMvbekz2SpY75nhztD+xOp3FTEsy9MCTrxv//8K2oUJq8r0iGW4yN4XzuwZk6OiV7oAiaKbmSmaM+9xJOoFHmvFiB1oNLxYC1kKYNQwPAymeTCikwqyQXMYoa1HfR6wA/g05TClBxvfeMIBBQ0I8V1D8qYa7YTDIg6mCqesfIZ5sZdT9ilBARktZeavAdP1KmQngqdE3RJTcA4EBpIB3LWSU8gZMXCE+OAJhOZSzbM3epEHqASWpTEhyXAfjMKtr1deHAmq30Ab1QdA+ETK6LQhqiJCj+AX+SM2sB5saAgpKICyppNJJCbgmDVvByGLiAjH8Dy8TKnaNQH4QIompGLZR8zOamVAmuYVaRQfCfr55YNBSe0Z+JrHepSs4bPOsMzPZ5RiMUALvWl5jkAtScuACX1tU8v9QFcrMvsE2VeBho/7ppqPp/vNNSTbZ3XMkzrDBxZs9Er42Jsv776+s8TTDCQq/z7yRm5mcxp1cl3nDmMwsMV14o8ci1VQqq2WX+6rcDdpGRO2lOPGV+8Pn0LM3g6GGHSo49/4fDw7cnLV+/OXrFdJrm2/w4Ho8EoXuCMD5XQvaO2Lv63G3e5GRlf5ZWwYrFAN2FolZBxDMR4lysK7+65mGC6eSCME5waH3h7ucyEp49ONQ0vf6nJ8ZAYJzgTToqM+eliiYX0/LtYvwDujPPxh9Ul+wnsfWvs9bmjY81cPBOqjvfdBK9psfWyacZN0jEyu9Xuv2wPPzhnKxv9nRnNw6TVeJHnZMO9sv2hePrxHBPMVu+UKr6E0Ik5P53EHFO8xEuMr7bIIfGpwetLVEKXtShZvjXLc0TUnJr+ELqOQ2j1gwPbC8j2dGoj4U+Oa6/CD1xib2jx41q83blTYQVtJ83JGTdN8w+NvTfZ",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={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+9uGzcMfxWWX9YCF9tJ0247DMO6ruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2MnWIB1X/xHIinyR/JHaYlBlB7TC/zVqIIcjhMsyOdO2iCNxhTPpwQfbSECQSsCL05PQChl5h4WpoZgoDZxf9Lua1ERCA9zUoq/rXCkQ6t8UgwwQWPJCbZ/UmCKdbTeKmOCVjhRUSDHbi2RrWGK7faVLDBByX5ZEaZ421mTfaY8nBRgJrA26OhLLR0VmAZXU4I+LBSb9LKyijBBurHKFITpRCjPAvmUKoHpEsPCRsngpC4xwYlxlQj9FboR0UqK2ZvDfFIcTW2GTTNujyUffjbFgk1tO3rqzEwWBBkpM4d1yAxm7mgDJiaYGx1IB7YhrFUyj8gNP3s2tOw5u4nzYgVXxG6cdGG06DDEjjMQJHnWa2XfRZwfFrKmeednExPXy/NDbWHTJBhkUL1sZ4xd0/COI2+N9q3HR6PRLqS+znPyflIrWNfXQ+C7H6Sush4a1m/X/uh3S/MTyxC1pV68CPvMbJSORkdPDw5HB6Nvzw+fp8ffp8+eD0aj0R+Y4E2lWHfVFWwNe7i1/3sLUiup6apD7+poNLo6PFxherwPxjNTUZhKXcKcdIC5M7pMwCoSniC4BYhSSA1KBHKP/jt8yTnj7kflYZ7dh8Ixo7AG4XgXhI7JTICJqXUkra8d6H1VtOvP/eEdX323Du/ZbngneiaULCKTB3NN+v9N5J7j2dXt0patUNzHrWD7622QnvLaybCIA+PmQFh50O6nF2OmYq4bw6PG1tFhHh0pDltUh8v1bGmQbblZN3tqpzDFaQjWp8OhsHZgLGkvS61E5ge5qYbCyuHsEJvktrQPopS6PHigltBFZm7u1hhvoj3jjLSgb8W8hl5Y+YYWmHSQ9qVWU3RKIrJ3kyAn+sNmZr3q0rU9IPqcv0v5yJmSemKiF6uMvbekz2SpY75nhztD+xOp3FTEsy9MCTrxv//8K2oUJq8r0iGW4yN4XzuwZk6OiV7oAiaKbmSmaM+9xJOoFHmvFiB1oNLxYC1kKYNQwPAymeTCikwqyQXMYoa1HfR6wA/g05TClBxvfeMIBBQ0I8V1D8qYa7YTDIg6mCqesfIZ5sZdT9ilBARktZeavAdP1KmQngqdE3RJTcA4EBpIB3LWSU8gZMXCE+OAJhOZSzbM3epEHqASWpTEhyXAfjMKtr1deHAmq30Ab1QdA+ETK6LQhqiJCj+AX+SM2sB5saAgpKICyppNJJCbgmDVvByGLiAjH8Dy8TKnaNQH4QIompGLZR8zOamVAmuYVaRQfCfr55YNBSe0Z+JrHepSs4bPOsMzPZ5RiMUALvWl5jkAtScuACX1tU8v9QFcrMvsE2VeBho/7ppqPp/vNNSTbZ3XMkzrDBxZs9Er42Jsv776+s8TTDCQq/z7yRm5mcxp1cl3nDmMwsMV14o8ci1VQqq2WX+6rcDdpGRO2lOPGV+8Pn0LM3g6GGHSo49/4fDw7cnLV+/OXrFdJrm2/w4Ho8EoXuCMD5XQvaO2Lv63G3e5GRlf5ZWwYrFAN2FolZBxDMR4lysK7+65mGC6eSCME5waH3h7ucyEp49ONQ0vf6nJ8ZAYJzgTToqM+eliiYX0/LtYvwDujPPxh9Ul+wnsfWvs9bmjY81cPBOqjvfdBK9psfWyacZN0jEyu9Xuv2wPPzhnKxv9nRnNw6TVeJHnZMO9sv2hePrxHBPMVu+UKr6E0Ik5P53EHFO8xEuMr7bIIfGpwetLVEKXtShZvjXLc0TUnJr+ELqOQ2j1gwPbC8j2dGoj4U+Oa6/CD1xib2jx41q83blTYQVtJ83JGTdN8w+NvTfZ",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={},v=[{value:"Request",id:"request",level:2}];function g(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)(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:""}})]})]})})}),"\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)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(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)(m.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)(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)(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:"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)(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)(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)(m.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)(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)(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:a}={...(0,r.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/a2bc1463.cf280f35.js b/assets/js/a2bc1463.cf280f35.js new file mode 100644 index 000000000..092a3951a --- /dev/null +++ b/assets/js/a2bc1463.cf280f35.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var t=s(85893),l=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:"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:"eJzNV21r3EYQ/iuT/dIG5DudY6dUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVrqzzo7TuoRQMLG1+8zrzjwz2YiAlRfZtXhpdMAieDFNREm+cNIGabTIxFVN0N/CG+kDnL27AGqsWZLzsDYtBAOOgpO0IEBQjDEzKHqNCVhnFrKUugKEwjTWUU3aywXBQtKSsagU4AKlwlzRXhKkZv1ud5AbMx+JRBhLDtm7i1Jkor9ksyIRFh02FMhxVBuhsSGRCSUbybeSA/rUkluLRDj61EpHpchmqDwlwoe1YvTMuEYkglZWmZJEFlzLt0VNDYpsIxpcyaZtRHaapokIa8tCum1ycmLLcthYVjRJt8neBT+X9qt58LDNdDtlvd4a7ckz9jhN+dfho/q2KMj7Watgn02RxFySDoxHa5Us4sX4xrPQ5r4DJr+hIqbdsZogO5OOfKvCAIfOIQcsAzX+n+W7Y37dPdIHJ3UlkpgaDMOTfezC1pO8Xh3fWE5Jl/fHKbgxBDlRzGiDUv0H+ZzoRX8wKkzDqmxt9KNdOZk8mxzHH1ZROMJA5Vn4nJpboeP0+NnRJD1Kf7iaPM9OfsxOn4/SNP1dJGLVxGj6aiwxxCiDDGr43dryG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV93JX5Ry7xbUScfK7YL01DoWb+WZIOsHRGVwlYRegJglsDVig1KAzknny9LiDnjPtyHh/n2ZdScJKmHyf7JJzeT8KFXqCSZWTvKzMn/W0jHZoPnfn7ZSA7ULwXB8EOz7sgPRWtk2EdaX51hFYedffZ9ZQ5kBNreD5U1M2FUItMjA+nhSe32I2K1imRiToE67PxGK0dGctjqtIKc8+9PEYrxwvux7toH7CSujp6pBTqMjerhyWmt2Fe8lN02T4I9pZirXxNzLF9LoeofuzUhCWPiy1/z0wU7jP81pK+lJWO77OYiLtLwHtShWmIR32oCXbwv/74M0qUpmgb0iGWzxN42zqI+wHPF9QlzBStJI92BqNSZrnfHDxho8h7tQapA1UOA0EpKxlQAWeFu6NAi7lUkguOYabbCwY160fwvqZQk+Or7xxvIiUtSHGdgjJmznqCAWyDaaKN3mdYGjefsUsJIOStl5q8B0+0EyFdoy4Idm+RgHGAGkgHctZJT4CyYfDMOKDZTBaSFXOtOV6bGtRYERtLgP3mLHRLEXlwJm99AG9UGwNhiw1R6ELURKUfwS+8LcXA+bDjSSqhallFAoUpCfpm4zB0CTn5AJbNy4KiUh/QBVC0IBerNb7krFUKrGEWkKh4Fxu+LSsKDrXnSdU5tHuaffqsM7xKRBslrkfwQX/QTGzQeuICUFLPffZBH8H1vszeU+5loOn3u15YLpf3+uDpocy5DHWbgyNrbuWqeBi7Zii+/3gqEhHINf7t7JLcQhbUN+ADNscRPO65kScP81u3C3CPvbgrwDylZEHa04DJzs7fvYEFPBulIhl0/b9wePzm4uWrXy9fsV7mpq7/JqN0lMZdwvjQoB6YOqew3897Wjvo3c0ty/8Pd/mevQKtwtgqlJH3Y8I2PWdfH2z400TUxgc+3mxy9PSbU9stH3dLNTN5KT3bvl2r57Qe/Cdggaplm5GRH8D22/otdMofTjI2Tphkx6ZssJM5KwqyQwP3RurBXDp/dSUSgS3HOGTxeWTx/g/WvrvS64HuQ3rvHOB/OabPCvzET/2a1j/v4d3NgwJ9fDs0v8x0u93+DWu16Cg=",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/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:"eJzNV21r3EYQ/iuT/dIG5DudY6dUlBKTBmMSmoBdAnWOMJLmpPWtdje7q3vhuG/9Jf1p/SVlVrqzzo7TuoRQMLG1+8zrzjwz2YiAlRfZtXhpdMAieDFNREm+cNIGabTIxFVN0N/CG+kDnL27AGqsWZLzsDYtBAOOgpO0IEBQjDEzKHqNCVhnFrKUugKEwjTWUU3aywXBQtKSsagU4AKlwlzRXhKkZv1ud5AbMx+JRBhLDtm7i1Jkor9ksyIRFh02FMhxVBuhsSGRCSUbybeSA/rUkluLRDj61EpHpchmqDwlwoe1YvTMuEYkglZWmZJEFlzLt0VNDYpsIxpcyaZtRHaapokIa8tCum1ycmLLcthYVjRJt8neBT+X9qt58LDNdDtlvd4a7ckz9jhN+dfho/q2KMj7Watgn02RxFySDoxHa5Us4sX4xrPQ5r4DJr+hIqbdsZogO5OOfKvCAIfOIQcsAzX+n+W7Y37dPdIHJ3UlkpgaDMOTfezC1pO8Xh3fWE5Jl/fHKbgxBDlRzGiDUv0H+ZzoRX8wKkzDqmxt9KNdOZk8mxzHH1ZROMJA5Vn4nJpboeP0+NnRJD1Kf7iaPM9OfsxOn4/SNP1dJGLVxGj6aiwxxCiDDGr43dryG9jZ3oX1PVxSQKn8UKC/Edvt4FBqJTV93JX5Ry7xbUScfK7YL01DoWb+WZIOsHRGVwlYRegJglsDVig1KAzknny9LiDnjPtyHh/n2ZdScJKmHyf7JJzeT8KFXqCSZWTvKzMn/W0jHZoPnfn7ZSA7ULwXB8EOz7sgPRWtk2EdaX51hFYedffZ9ZQ5kBNreD5U1M2FUItMjA+nhSe32I2K1imRiToE67PxGK0dGctjqtIKc8+9PEYrxwvux7toH7CSujp6pBTqMjerhyWmt2Fe8lN02T4I9pZirXxNzLF9LoeofuzUhCWPiy1/z0wU7jP81pK+lJWO77OYiLtLwHtShWmIR32oCXbwv/74M0qUpmgb0iGWzxN42zqI+wHPF9QlzBStJI92BqNSZrnfHDxho8h7tQapA1UOA0EpKxlQAWeFu6NAi7lUkguOYabbCwY160fwvqZQk+Or7xxvIiUtSHGdgjJmznqCAWyDaaKN3mdYGjefsUsJIOStl5q8B0+0EyFdoy4Idm+RgHGAGkgHctZJT4CyYfDMOKDZTBaSFXOtOV6bGtRYERtLgP3mLHRLEXlwJm99AG9UGwNhiw1R6ELURKUfwS+8LcXA+bDjSSqhallFAoUpCfpm4zB0CTn5AJbNy4KiUh/QBVC0IBerNb7krFUKrGEWkKh4Fxu+LSsKDrXnSdU5tHuaffqsM7xKRBslrkfwQX/QTGzQeuICUFLPffZBH8H1vszeU+5loOn3u15YLpf3+uDpocy5DHWbgyNrbuWqeBi7Zii+/3gqEhHINf7t7JLcQhbUN+ADNscRPO65kScP81u3C3CPvbgrwDylZEHa04DJzs7fvYEFPBulIhl0/b9wePzm4uWrXy9fsV7mpq7/JqN0lMZdwvjQoB6YOqew3897Wjvo3c0ty/8Pd/mevQKtwtgqlJH3Y8I2PWdfH2z400TUxgc+3mxy9PSbU9stH3dLNTN5KT3bvl2r57Qe/Cdggaplm5GRH8D22/otdMofTjI2Tphkx6ZssJM5KwqyQwP3RurBXDp/dSUSgS3HOGTxeWTx/g/WvrvS64HuQ3rvHOB/OabPCvzET/2a1j/v4d3NgwJ9fDs0v8x0u93+DWu16Cg=",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 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 list"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,t.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,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:"Query Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsxs)("ul",{children:[(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\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)(o.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:!0,className:"schemaItem",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(a.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(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)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,t.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.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,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)(o.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:"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)(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/a2bc1463.e5b83ec4.js b/assets/js/a2bc1463.e5b83ec4.js deleted file mode 100644 index ec6b7af01..000000000 --- a/assets/js/a2bc1463.e5b83ec4.js +++ /dev/null @@ -1 +0,0 @@ -"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.ab6ff70c.js b/assets/js/a88a3db3.ab6ff70c.js new file mode 100644 index 000000000..66751cebe --- /dev/null +++ b/assets/js/a88a3db3.ab6ff70c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>b});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),o=s(5397),p=s(4667),c=s(9472),h=s(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:"eJzNVttu20YQ/ZXJvjQBaEl2nBQliqJubaRGjCaoXQSoIxgrckhuvNzd7A51gcC3fkk/rV9SzJKUJcs2GqAI+iKRy7mduZzZtSBZBpFeiyusnZaEQUwTkWPIvHKkrBGpuKoQTlEjIQxScPL+HJy3c5VjgJVtYKGoAqoQ5ExpRSsgCx5rO0eQEBxmqlAZ0KBfeFtH8eEkjOC8AHknoQIYC9qaEj0YxBxzkQjr0EuO6zwXqchjVENQIhFOelkjoWdMa2FkjSIVg80bxSYUY3KSKnEf6Pkp2GInKqBKUvQeGNAMoXPJdjx+bpTHXKTkG0xEoJVmb0HVTnMwuHTa5ijSQurAAlmFtRTpWtDKRUnyypQiEYX1taS7k7adsv3grAkYWONoMuG/e4UZouyDgtBkGYZQNFqvnolEZNYQGmJN6ZxWWUzd+FNg9fV+QHb2CTPiPHpONKnOeXfMGd8PHZcywk3FT8vqSAb3i3sp2qQvTX5CTysdTY5eHhxODibfXh2+To+/S1+9Hk0mkz9EIpa1Zt2+hjkXuE0EKdJ37+2eWHS7I9iftCx8/FAaL22NVClTwgINwcJbUybgNMqAQH4FspTKAGfa/4dZRe+tfzo7XxZZu4VaGa0M3gw9dHM8mdwcbpJw/EQvGUtQ2MbkXxfqQ/6fBnR883oD6NU+oHMzl1rlkamu7C2ar4tn2z117ve7VXVC8bvYAbt93oEMmDVe0SoS2/JAOnXQfU+vp0wX3Cn2jhQjGVIlUjEeyGy83iLCVrBJPx+osvFapKIiciEdj6VzI+vQBFUaLWdhlNl6LJ0azw9Fm9yXDiRLZcqDL9SSJp/Z5eMa0zvQl1yYLvc70DcVkE69xZVIhsxuS/WUX6HM0ccqKFPYqNzn+51Dc6lKE6s1P9xbDB9QZ7ZGXgG8HQbxv//8K2rkNmtqNBSb6Rm8azw4u0BfNBqkyaHQuFQz3W1NqbVddDuTLASUtcYQ9AqUISx9pHNVKpIaOCs8/Jl03VZVGFjMsraHrQ4OI/hQIVXo+dM3npdujnPU3LWgrb1lO2RBNmTr6KOPGRbW3xYcUgISZk1QBkOAgDiooKmkyRCGWiRgPUgDaAi98yogSFWzcGE9YFGoTLFhnjUvM4JaGlkiO0uA4965O3g7awJBsLqJQNhjjUgdxLh5R3Cq5tgB58McSSqNOZQNm0ggszlCP3oMw+Qww0Dg2L3KMBoNJD2Bxjn62K2xkrwpwVnmBCU1b//t2rIh8tIE3s9dQENpNulz3vLKjT5yuRrBR/PRMG9DE5AbQCtzG9KP5gCuN232AWdBEU6fD7OwWCz25uDFrs4bRVUzA4/O3umV8TBOzbb65uWFSAShr8O74hL9XGXYD+AjPsdReNwzpcwiU2Itle5m7Mf7CsxaWmVoAm7x2smb9xcwh5ejiUi2pv5fBDy+OP/57NfLM7bL3NTN3+FoMprwkbOBamm2XN27mN4f3fUd5f+v7rE9bREuaey0VJH+Y6bWPW9fb66tIhHp9hV2mojKBmKR9XomA/7uddvy8ecGPS+IaSLm0is5Y3a7XotcBX7ON1fRR3P0/Lf+VvsCvuw2/CCggZwNM/Nc6obfRCJucXXvWt5O22RgaI64kzjJMnS0pbu3tHc23+nZxdnVmUiEbDiD28vhNi6H/oEdPBja7tboYuBfXl4PKnzP/fMWVz9sxLsvjyr0EAdpTtO0bdt/AIaut2k=",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:"eJzNVttu20YQ/ZXJvjQBaEl2nBQliqJubaRGjCaoXQSoIxgrckhuvNzd7A51gcC3fkk/rV9SzJKUJcs2GqAI+iKRy7mduZzZtSBZBpFeiyusnZaEQUwTkWPIvHKkrBGpuKoQTlEjIQxScPL+HJy3c5VjgJVtYKGoAqoQ5ExpRSsgCx5rO0eQEBxmqlAZ0KBfeFtH8eEkjOC8AHknoQIYC9qaEj0YxBxzkQjr0EuO6zwXqchjVENQIhFOelkjoWdMa2FkjSIVg80bxSYUY3KSKnEf6Pkp2GInKqBKUvQeGNAMoXPJdjx+bpTHXKTkG0xEoJVmb0HVTnMwuHTa5ijSQurAAlmFtRTpWtDKRUnyypQiEYX1taS7k7adsv3grAkYWONoMuG/e4UZouyDgtBkGYZQNFqvnolEZNYQGmJN6ZxWWUzd+FNg9fV+QHb2CTPiPHpONKnOeXfMGd8PHZcywk3FT8vqSAb3i3sp2qQvTX5CTysdTY5eHhxODibfXh2+To+/S1+9Hk0mkz9EIpa1Zt2+hjkXuE0EKdJ37+2eWHS7I9iftCx8/FAaL22NVClTwgINwcJbUybgNMqAQH4FspTKAGfa/4dZRe+tfzo7XxZZu4VaGa0M3gw9dHM8mdwcbpJw/EQvGUtQ2MbkXxfqQ/6fBnR883oD6NU+oHMzl1rlkamu7C2ar4tn2z117ve7VXVC8bvYAbt93oEMmDVe0SoS2/JAOnXQfU+vp0wX3Cn2jhQjGVIlUjEeyGy83iLCVrBJPx+osvFapKIiciEdj6VzI+vQBFUaLWdhlNl6LJ0azw9Fm9yXDiRLZcqDL9SSJp/Z5eMa0zvQl1yYLvc70DcVkE69xZVIhsxuS/WUX6HM0ccqKFPYqNzn+51Dc6lKE6s1P9xbDB9QZ7ZGXgG8HQbxv//8K2rkNmtqNBSb6Rm8azw4u0BfNBqkyaHQuFQz3W1NqbVddDuTLASUtcYQ9AqUISx9pHNVKpIaOCs8/Jl03VZVGFjMsraHrQ4OI/hQIVXo+dM3npdujnPU3LWgrb1lO2RBNmTr6KOPGRbW3xYcUgISZk1QBkOAgDiooKmkyRCGWiRgPUgDaAi98yogSFWzcGE9YFGoTLFhnjUvM4JaGlkiO0uA4965O3g7awJBsLqJQNhjjUgdxLh5R3Cq5tgB58McSSqNOZQNm0ggszlCP3oMw+Qww0Dg2L3KMBoNJD2Bxjn62K2xkrwpwVnmBCU1b//t2rIh8tIE3s9dQENpNulz3vLKjT5yuRrBR/PRMG9DE5AbQCtzG9KP5gCuN232AWdBEU6fD7OwWCz25uDFrs4bRVUzA4/O3umV8TBOzbb65uWFSAShr8O74hL9XGXYD+AjPsdReNwzpcwiU2Itle5m7Mf7CsxaWmVoAm7x2smb9xcwh5ejiUi2pv5fBDy+OP/57NfLM7bL3NTN3+FoMprwkbOBamm2XN27mN4f3fUd5f+v7rE9bREuaey0VJH+Y6bWPW9fb66tIhHp9hV2mojKBmKR9XomA/7uddvy8ecGPS+IaSLm0is5Y3a7XotcBX7ON1fRR3P0/Lf+VvsCvuw2/CCggZwNM/Nc6obfRCJucXXvWt5O22RgaI64kzjJMnS0pbu3tHc23+nZxdnVmUiEbDiD28vhNi6H/oEdPBja7tboYuBfXl4PKnzP/fMWVz9sxLsvjyr0EAdpTtO0bdt/AIaut2k=",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={},b=[{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:"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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,l.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,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.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)(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)(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)(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)(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)(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,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/a88a3db3.b940c425.js b/assets/js/a88a3db3.b940c425.js deleted file mode 100644 index e87551ede..000000000 --- a/assets/js/a88a3db3.b940c425.js +++ /dev/null @@ -1 +0,0 @@ -"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.538897d0.js b/assets/js/ada7accb.538897d0.js deleted file mode 100644 index 3098056ce..000000000 --- a/assets/js/ada7accb.538897d0.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:()=>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/ada7accb.774fa7a2.js b/assets/js/ada7accb.774fa7a2.js new file mode 100644 index 000000000..e61494eeb --- /dev/null +++ b/assets/js/ada7accb.774fa7a2.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:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,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:"eJy9V+lu20YQfpXJ/mkC0DocJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0MdEPivT9JH65MUs5RkykdQF0H+SCLnvr4ZrQXJKoj0QvxqdYFezBJRYMi9cqSsEak4rxFOkKCnw/G7U5Ba20WAlW2BLHgkr3COUCBJpQPIzLYEEoLDXJUqhzKKjkQirEMvWfFpIVJRIfUkkQgnvWyQ0LMza2FkgyIVPflSFSIRir1xkmpx00WbfcScTguwJewUevzUKo+FSMm3mIhAK80qg2qcRpEIXDptCxRpKXVghrzGRop0LWjlIid5ZSqRiNL6RtLwDS5l1JIK99s0q/PD2mWi62ZsNjhrAgZWdDiZ8Ne+t6HNcwyhbDXs0iESkVtDaIj5pXNa5ZEw/hhYaH3buz5ozpxnNaR6k9tcPDiOeprVy8OPTnTJJu1vYg0epsbgYluCLhYVDfWd83CXXh4aGZ5dqXd4U9f/9Sy02cC73KMkLI7pLlXXgoeTw6cH08nB5Nvz6fP06Pv02fPRZDL5UyRi2WiW3TRrISl6Sor08Ll1xVewM3ixmRqPQXQdE47u6sMz2yDVylSwQEOw8NZUCTiNMiCQX4GspDKgJaF/9OUaFL23/vOZeJhnw8iV0crg5XYIL48mk8vpLglHt5PQpwqMJShta4rRVwj0c11625/Ph3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxWDo3sg5NUJXRMguj3DZj6dR4PhVdcpM7kKyUqQ4eKCVNkdnl/RKz62jPuCJ90vdi3qVeOvUKVyLZpnTItVmcNcoIex0/lzYKbxL91qE5U5WJZZpPb63X96hz2yDveqoRtuz//PV3lChs3jZoKHbRI3jbenB2gZ4XnDQFlBqXKtN4x+kQUDYaQ9ArUIaw8pIQClUpkho4K4wBuXQyU1px3zGbZWkPg9YNI3hfI9XomfSNR5BQ4Bw1tytoa69YD1mQLdkm2tj4DAvrr0p2KQEJWRuUwRAgIG5F0NTS5AjbWiRgPUgDaAi98yogSNUwc2k9YFmqXLFiHjIvc4JGGlkhG0uA/eYsOG/nqsAA3mZtIAhWtzEQttggUh+iQSzCCH5Rc+wD55f9lYUFVC2rSCC3BcJm5jgMU0CGgcCxeZVjVBpIegKNc/SxW2Mly1ZrcJbBQEnN19OwtqyIvDSB8ap3aFuaXfqct3zLRBuFXI3gg/lgGL6hDcgNoJW5CukHcwAXuzZ7j1lQhLPH21lYLBa35uDJvsyJorrNwKOz13JVfBmnZii+e3giEkHom/C2PEM/VzluBvAem+PIPN5ApMwjRGIjle5n7KebAgxXWuVoAg4A7fjk3WuYw9PRRCSDqf8PDo9fn/784s3ZC9bL2NTP33Q0GU3iCWQDNdIMTF0f5jendn0N81/2hN9ADuGSxk5LFTE7Rrne4O2F2B3h6fUBP0tEbQMxeb3OZMA/vO46fv2pRc+IPkvEXHolM0ali7UoVODfxe5CvzfAx79vjv0ncOd/gTt93mKnYeCcS93yk0jEFa72/nl0sy7Zwie71dOP8xwdDSRvrdK9fXTy4lwkQracnyFsX0XY3vxg7Xd6tY/nvQP8yWvlToEfuMavcPXjjr2n3CuwiW/LzRmadV33L3634Ws=",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/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:"eJy9V+lu20YQfpXJ/mkC0DocJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0MdEPivT9JH65MUs5RkykdQF0H+SCLnvr4ZrQXJKoj0QvxqdYFezBJRYMi9cqSsEak4rxFOkKCnw/G7U5Ba20WAlW2BLHgkr3COUCBJpQPIzLYEEoLDXJUqhzKKjkQirEMvWfFpIVJRIfUkkQgnvWyQ0LMza2FkgyIVPflSFSIRir1xkmpx00WbfcScTguwJewUevzUKo+FSMm3mIhAK80qg2qcRpEIXDptCxRpKXVghrzGRop0LWjlIid5ZSqRiNL6RtLwDS5l1JIK99s0q/PD2mWi62ZsNjhrAgZWdDiZ8Ne+t6HNcwyhbDXs0iESkVtDaIj5pXNa5ZEw/hhYaH3buz5ozpxnNaR6k9tcPDiOeprVy8OPTnTJJu1vYg0epsbgYluCLhYVDfWd83CXXh4aGZ5dqXd4U9f/9Sy02cC73KMkLI7pLlXXgoeTw6cH08nB5Nvz6fP06Pv02fPRZDL5UyRi2WiW3TRrISl6Sor08Ll1xVewM3ixmRqPQXQdE47u6sMz2yDVylSwQEOw8NZUCTiNMiCQX4GspDKgJaF/9OUaFL23/vOZeJhnw8iV0crg5XYIL48mk8vpLglHt5PQpwqMJShta4rRVwj0c11625/Ph3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxWDo3sg5NUJXRMguj3DZj6dR4PhVdcpM7kKyUqQ4eKCVNkdnl/RKz62jPuCJ90vdi3qVeOvUKVyLZpnTItVmcNcoIex0/lzYKbxL91qE5U5WJZZpPb63X96hz2yDveqoRtuz//PV3lChs3jZoKHbRI3jbenB2gZ4XnDQFlBqXKtN4x+kQUDYaQ9ArUIaw8pIQClUpkho4K4wBuXQyU1px3zGbZWkPg9YNI3hfI9XomfSNR5BQ4Bw1tytoa69YD1mQLdkm2tj4DAvrr0p2KQEJWRuUwRAgIG5F0NTS5AjbWiRgPUgDaAi98yogSNUwc2k9YFmqXLFiHjIvc4JGGlkhG0uA/eYsOG/nqsAA3mZtIAhWtzEQttggUh+iQSzCCH5Rc+wD55f9lYUFVC2rSCC3BcJm5jgMU0CGgcCxeZVjVBpIegKNc/SxW2Mly1ZrcJbBQEnN19OwtqyIvDSB8ap3aFuaXfqct3zLRBuFXI3gg/lgGL6hDcgNoJW5CukHcwAXuzZ7j1lQhLPH21lYLBa35uDJvsyJorrNwKOz13JVfBmnZii+e3giEkHom/C2PEM/VzluBvAem+PIPN5ApMwjRGIjle5n7KebAgxXWuVoAg4A7fjk3WuYw9PRRCSDqf8PDo9fn/784s3ZC9bL2NTP33Q0GU3iCWQDNdIMTF0f5jendn0N81/2hN9ADuGSxk5LFTE7Rrne4O2F2B3h6fUBP0tEbQMxeb3OZMA/vO46fv2pRc+IPkvEXHolM0ali7UoVODfxe5CvzfAx79vjv0ncOd/gTt93mKnYeCcS93yk0jEFa72/nl0sy7Zwie71dOP8xwdDSRvrdK9fXTy4lwkQracnyFsX0XY3vxg7Xd6tY/nvQP8yWvlToEfuMavcPXjjr2n3CuwiW/LzRmadV33L3634Ws=",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 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:"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 y(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/bbdfc22d.e7c6d9cb.js b/assets/js/bbdfc22d.e7c6d9cb.js deleted file mode 100644 index 01482dc36..000000000 --- a/assets/js/bbdfc22d.e7c6d9cb.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:()=>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/bbdfc22d.f156ca0b.js b/assets/js/bbdfc22d.f156ca0b.js new file mode 100644 index 000000000..f3795fdee --- /dev/null +++ b/assets/js/bbdfc22d.f156ca0b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(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),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:"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/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhfNTp4MoWQCNkdHqEZba2mAQy3Fhxqh14vQlyLr9cDm3ELKJUyQ2MmIm0AQdsiZcJpT0iE2FaZiKgg44BqM5Vi+qwrFM1iqGqpsCkKCqjWc93qvcVLP4N1Jr3fxVW5tZUYHB7yqBqpCacRMFnxiBqkqDzICrLLpI8hRo8NEpGWaz2EushlaA1xmkKpqCanqKy0yyS0mUPEZgqzLCWpQU6KyHAAvjGqQuDXExtNjgnjz+h+O6F7vJRaqg14jmLqqlLaYEQ/EcJTDqNejNa9UWSoJFde8REsmoKYRwYgA+iTmZYWjXg9OZCZSMgOHiUZb6IEHJeIJ9CzI1YOusSSDDRE3cy4tqakqeIoOVCOpxIprXEe8SGBJiF+jVJGCXGnxq5KWF06U16itSHkBqVI6E9JR6iUIxnLtzLJSQto4GnaAfwbB1sYTkQUtE2kZiaUU0s0YhGte1GgCVfMEcqLqJ6w0GmdeAa/NHU05ilm+cz+eva+NXUMMtSEyu1SEvTR+qIXGzIkXndimvDAIYromy5JfYWc3UM4H8GIAL5eQ4ZTXhU1A2C8NWF3jAH5UFnhVFSJ1h53OMZkypyPad1oOBhEIkbx0On6j1bXIkE5kJqZT1Cgt0KRDEa0wUEfGWLkFxF6pNNHIJSjZUfRwAL1es7cz0V9++WUsb8YSYMyIljEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuwqZHjhjLy+oOQmj69ycifnrVGRp0O9NYNAMaJP15WJoh0dNoQxZNrFqGHhNDQgoreGF28xQhHh5bLWUbnB0TZ1hyUexmy00/PJ4CWRsMPRm052wHPx7FQ2PH/9rg5ilx815NwApb3MFSA/Lw+OqQtsHcM2IuVWXF5XI3awHg4THWELbB1nNiK+P2DnXR7MNjKFAVJ8KF5+cOj/vDJ/2jw6PjDsRU6ZIHgLLsZ1l/uVwuxwxaiYDjn+6+gI6uv3j/+buaYsypVuWW4MbFHi1UiAXc7xgQ/EBhwCTekG201oannsr1O9yqjC+/NB5VXBouaQ/fhmLLDpluiuhYUlSb5kqkgXiCCYKHCQWTAxJCn+SYHfzww4GXTNIO9ssyiMvrgkbpu+8k2R0ty0GWDTZhuwLvjpaQZQlsGd8+kWVQluWucT9BJj6Wfxm4d8PCTtRit2kHgIdn3S1hWw08XApxLhcyTATrgA0AjbO64BoXFL4aoaTj/pYz2LD8aPg8mqKPXV3Y514Gnkj46jSEno+CURI96who5P51t8jsItE4w4XD4d+sRIzIwuPR1GlO71T3yqXIU8liGZ4iJvFfKa8EvSEKtNaNok0H60SM5fDQ+fkc06s7LSdCPDzT6VAWJ/2Tg6bPx6zk4eJlU2x/K5ujHrOLZo3BAlOLWWctbFsMFx0r4xlJmoDdk6UlLxcZFnyCRTvXIS6oscMqTZRCeiKiGA4jPjfLFxuzYXK1xag9E11rit4v2mSUGhTCxLfougi6q8MbzmUiJPoUxAQhLoBJ4723GbmXUud9R6rcfN4ZtOuEcQNx6ZYnnpNpPH1B1vfsQHDgAJvnc9xs1waBhTXNdOVCOEohRVmXndRGxBolVoZbsCsuWkm5qbhDV7u3duCLe3YI2aEdG4zl0L1AM62qTM2lO+WwPfYJIA/vmHco+y3HfO1a8XC/5RhFqrrHaMuNQqD+LmmOkNl9hgZwSv6bUgh+kTDA0xQri9mGAx+617zmmVAwqa1VcrcL70I9PP1uUPcH6JgY/jgtd2n7szQ9lkOf6Ch9KnJXlqN0+nxo2g1kbVdDuOIkS5iqXJ5dyZOMjZjP2ccMNkvcVmjsS5Ut2eiGpUpalJZ+hkQfLT14b6g2cMNMmmPJ6VckkaoJU1EQKsq1oTYsYe79S6UFEiIbMTV5j6llCQWXFeVe0RAOt250E6GM1ULOWBLeWWzEfOaaJQwXvKwIOAwBylTR68ehWMUd78LVjLS4jPvR5PMJD6WMPxONW7raKKd8FqYuhlUr1xYZ15ov2WblJuaKYwTv1zVZ3WIZr29hKRSI4YUHYwkTFsvuLju0ptWnSzpFRZy4FNanrnVq4eUn70nrqlzJz1oYctJbZP6RUvKztzdeV9kLemxgFqPBfptOT8ClZgf3WUyEd9zyWXdPH9zc2vPtrjJLpxJgclUXGeX6keuBq3Z8flmLSoW8SGtXrWu8+RpnDakNZ8NVwhb3M7PwFTFfw4GvCpxaqKsKNaRKS9SPuqmWB8Pc0fHxKmHL+9lb/k+y94yUN7+fu59d8astDP4ZtD5+vkpYfj+t3zbluT+R2OOnq/au27jLLycqW15Gv7W6DzBeKgRnUGYn8lRnqDuCmChVIJfd/d0L7h7Mfus2PKD4xQ2YSknjnePR4SH92/BLawV9qv43xf5i+QVLPj42udsz+2GKhm5759axvsyPvjWVLNOcPGuJxqw71y1L7mGgKzchCyHxMgrl8ujw8PIJSW6VsONtwjlTJdqc0lJzqp3OtZKzBKoCORWi9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9JlelyPx1t1hfKP5bS7vfXbE6mL0oU0PkRhwgO5ebbGbHfcM2kwrbWwSzY6v2GLPq9E38+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbsTu9EK/EwfWQrZJNaGP5TMhZ/xNXcZlRxmfniouW1TNSh5f4GsNtmFWJ75DirCDPLlTCBJlBjpw8FUmQtPxT+4L5Ouoqvi22PhdapWw+AGL8vxbSb94EW4L0Tox+HgNkF/M2IS9rOWJNWEo/m0DzvDW9JqaLId3QxUJHx8cuaHg2dLfr4+fu4jp+urrwEu44ce+oSV5T5YQbGD6tUJ6Jme/nuh7evpGxSFWJLt+XI0Tw//zr325FbAlyR+wLOK01VGqOmvqxqIdlWuBCUGdIp12MHhwuGcnLAo2hV4i0OPOtVmLm8unEMXmQlFd8IgpBh5LAlK87dc61GcDPOVJ6gqa+1L60cI0FnWUolLpyPTEKeG1V2W3ngrnSV1MiKQEOE2qeQWPAIMYlKHMuU8oqeFtNQGngElBa1JUWBoGLkoApi4HTqUgFISYPpHlqoeSSz5A2S1xkQFKoYuuLVhNKWhpV1D4VQg04iNaz6LIaA3hN3UyOcRrM0HJRYAazmlAkQEYMwSERGzKDCRoLFW0vUjRtEbHAa9TuNDtN0h0ElSJPKXhBYUxXt4TIai4NxR6eoKiaRnyVVnSZuT0yvhwAJVDI+VMgRAZQCHlFnWB9OG/M7GecGGGxjYrm8/ktP/Fofc03wub1BDRWql03c4POq3SXNx+P6FSjLs3p9Az1tUgxOKgdex444INwf/DU3R/xrPJK/H1zAfnyQqQoDXa8/Ytv3nwP1/B4cMiSjlf8CIIPvj959fWPZ18TXvLd/vwNB4eDQ/eUU8aWXHa2euW7Ld+2vmoj0dBchPsWzn0L576Fc9/CuW/h3Ldw7ls4HxJP+xbOfQvnvoXz92xh2Ldw7ls4x/sWTti3cO5bOPctnPsWzn0L576Fc9/CuW/h3Ldw/h+1cIa6IEVMB1XBhSssu2rDTagJn282dl4kLKei8eic3dxQ9vidLlYrGv5Qo6aK80XCrrkWlAV09eYk1lWpEnmFSyo5+IpC/y3tn3irc+WRjTI7lYT9ihdOTXfCduvab07P3rKETULzaakyWqP5nBpT+ZyNKDplronVSdi1H3LXWVRwOatdcZR5vFQO5rXN12vJV66WHH50aqxcLjtUrheZPSv0lxjbuuCvVKP4Dpd/a8D9zM4FQbYRmlR4sVqt/gvY9QeY",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/ZL9tP2SRfHobsmSPTMJEu9CL7aaLBbrYrFYVTfM8plho3P2Fsuq4BYNu0hYhibVorJCSTZib3OEOA2vNHIahxdvToAXhZobqA1qA1ZBSpMIaW2sKsWvfFIg2Ig4gXku0hwM6msEbmBS1FhpIa2BqdIwQ4maWyFnkKm0LpEm5sLmUGnMcCokZmCsrlNbazQDeFcpCaZOUzRmWhfNTp4MoWQCNkdHqEZba2mAQy3Fhxqh14vQlyLr9cDm3ELKJUyQ2MmIm0AQdsiZcJpT0iE2FaZiKgg44BqM5Vi+qwrFM1iqGqpsCkKCqjWc93qvcVLP4N1Jr3fxVW5tZUYHB7yqBqpCacRMFnxiBqkqDzICrLLpI8hRo8NEpGWaz2EushlaA1xmkKpqCanqKy0yyS0mUPEZgqzLCWpQU6KyHAAvjGqQuDXExtNjgnjz+h+O6F7vJRaqg14jmLqqlLaYEQ/EcJTDqNejNa9UWSoJFde8REsmoKYRwYgA+iTmZYWjXg9OZCZSMgOHiUZb6IEHJeIJ9CzI1YOusSSDDRE3cy4tqakqeIoOVCOpxIprXEe8SGBJiF+jVJGCXGnxq5KWF06U16itSHkBqVI6E9JR6iUIxnLtzLJSQto4GnaAfwbB1sYTkQUtE2kZiaUU0s0YhGte1GgCVfMEcqLqJ6w0GmdeAa/NHU05ilm+cz+eva+NXUMMtSEyu1SEvTR+qIXGzIkXndimvDAIYromy5JfYWc3UM4H8GIAL5eQ4ZTXhU1A2C8NWF3jAH5UFnhVFSJ1h53OMZkypyPad1oOBhEIkbx0On6j1bXIkE5kJqZT1Cgt0KRDEa0wUEfGWLkFxF6pNNHIJSjZUfRwAL1es7cz0V9++WUsb8YSYMyIljEbjVkDMmYJ+DkysTEbDRMIA4sxG8Hjo2cRYEnfT4+ex+85fQ+Hx/E7p++j4ViuwqZHjhjLy+oOQmj69ycifnrVGRp0O9NYNAMaJP15WJoh0dNoQxZNrFqGHhNDQgoreGF28xQhHh5bLWUbnB0TZ1hyUexmy00/PJ4CWRsMPRm052wHPx7FQ2PH/9rg5ilx815NwApb3MFSA/Lw+OqQtsHcM2IuVWXF5XI3awHg4THWELbB1nNiK+P2DnXR7MNjKFAVJ8KF5+cOj/vDJ/2jw6PjDsRU6ZIHgLLsZ1l/uVwuxwxaiYDjn+6+gI6uv3j/+buaYsypVuWW4MbFHi1UiAXc7xgQ/EBhwCTekG201oannsr1O9yqjC+/NB5VXBouaQ/fhmLLDpluiuhYUlSb5kqkgXiCCYKHCQWTAxJCn+SYHfzww4GXTNIO9ssyiMvrgkbpu+8k2R0ty0GWDTZhuwLvjpaQZQlsGd8+kWVQluWucT9BJj6Wfxm4d8PCTtRit2kHgIdn3S1hWw08XApxLhcyTATrgA0AjbO64BoXFL4aoaTj/pYz2LD8aPg8mqKPXV3Y514Gnkj46jSEno+CURI96who5P51t8jsItE4w4XD4d+sRIzIwuPR1GlO71T3yqXIU8liGZ4iJvFfKa8EvSEKtNaNok0H60SM5fDQ+fkc06s7LSdCPDzT6VAWJ/2Tg6bPx6zk4eJlU2x/K5ujHrOLZo3BAlOLWWctbFsMFx0r4xlJmoDdk6UlLxcZFnyCRTvXIS6oscMqTZRCeiKiGA4jPjfLFxuzYXK1xag9E11rit4v2mSUGhTCxLfougi6q8MbzmUiJPoUxAQhLoBJ4723GbmXUud9R6rcfN4ZtOuEcQNx6ZYnnpNpPH1B1vfsQHDgAJvnc9xs1waBhTXNdOVCOEohRVmXndRGxBolVoZbsCsuWkm5qbhDV7u3duCLe3YI2aEdG4zl0L1AM62qTM2lO+WwPfYJIA/vmHco+y3HfO1a8XC/5RhFqrrHaMuNQqD+LmmOkNl9hgZwSv6bUgh+kTDA0xQri9mGAx+617zmmVAwqa1VcrcL70I9PP1uUPcH6JgY/jgtd2n7szQ9lkOf6Ch9KnJXlqN0+nxo2g1kbVdDuOIkS5iqXJ5dyZOMjZjP2ccMNkvcVmjsS5Ut2eiGpUpalJZ+hkQfLT14b6g2cMNMmmPJ6VckkaoJU1EQKsq1oTYsYe79S6UFEiIbMTV5j6llCQWXFeVe0RAOt250E6GM1ULOWBLeWWzEfOaaJQwXvKwIOAwBylTR68ehWMUd78LVjLS4jPvR5PMJD6WMPxONW7raKKd8FqYuhlUr1xYZ15ov2WblJuaKYwTv1zVZ3WIZr29hKRSI4YUHYwkTFsvuLju0ptWnSzpFRZy4FNanrnVq4eUn70nrqlzJz1oYctJbZP6RUvKztzdeV9kLemxgFqPBfptOT8ClZgf3WUyEd9zyWXdPH9zc2vPtrjJLpxJgclUXGeX6keuBq3Z8flmLSoW8SGtXrWu8+RpnDakNZ8NVwhb3M7PwFTFfw4GvCpxaqKsKNaRKS9SPuqmWB8Pc0fHxKmHL+9lb/k+y94yUN7+fu59d8astDP4ZtD5+vkpYfj+t3zbluT+R2OOnq/au27jLLycqW15Gv7W6DzBeKgRnUGYn8lRnqDuCmChVIJfd/d0L7h7Mfus2PKD4xQ2YSknjnePR4SH92/BLawV9qv43xf5i+QVLPj42udsz+2GKhm5759axvsyPvjWVLNOcPGuJxqw71y1L7mGgKzchCyHxMgrl8ujw8PIJSW6VsONtwjlTJdqc0lJzqp3OtZKzBKoCORWi9RL4jAsJtL3+HWWFWit9N9efRtldQjg+PLwcNkJ4clsIJ9JlelyPx1t1hfKP5bS7vfXbE6mL0oU0PkRhwgO5ebbGbHfcM2kwrbWwSzY6v2GLPq9E38+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbsTu9EK/EwfWQrZJNaGP5TMhZ/xNXcZlRxmfniouW1TNSh5f4GsNtmFWJ75DirCDPLlTCBJlBjpw8FUmQtPxT+4L5Ouoqvi22PhdapWw+AGL8vxbSb94EW4L0Tox+HgNkF/M2IS9rOWJNWEo/m0DzvDW9JqaLId3QxUJHx8cuaHg2dLfr4+fu4jp+urrwEu44ce+oSV5T5YQbGD6tUJ6Jme/nuh7evpGxSFWJLt+XI0Tw//zr325FbAlyR+wLOK01VGqOmvqxqIdlWuBCUGdIp12MHhwuGcnLAo2hV4i0OPOtVmLm8unEMXmQlFd8IgpBh5LAlK87dc61GcDPOVJ6gqa+1L60cI0FnWUolLpyPTEKeG1V2W3ngrnSV1MiKQEOE2qeQWPAIMYlKHMuU8oqeFtNQGngElBa1JUWBoGLkoApi4HTqUgFISYPpHlqoeSSz5A2S1xkQFKoYuuLVhNKWhpV1D4VQg04iNaz6LIaA3hN3UyOcRrM0HJRYAazmlAkQEYMwSERGzKDCRoLFW0vUjRtEbHAa9TuNDtN0h0ElSJPKXhBYUxXt4TIai4NxR6eoKiaRnyVVnSZuT0yvhwAJVDI+VMgRAZQCHlFnWB9OG/M7GecGGGxjYrm8/ktP/Fofc03wub1BDRWql03c4POq3SXNx+P6FSjLs3p9Az1tUgxOKgdex444INwf/DU3R/xrPJK/H1zAfnyQqQoDXa8/Ytv3nwP1/B4cMiSjlf8CIIPvj959fWPZ18TXvLd/vwNB4eDQ/eUU8aWXHa2euW7Ld+2vmoj0dBchPsWzn0L576Fc9/CuW/h3Ldw7ls4HxJP+xbOfQvnvoXz92xh2Ldw7ls4x/sWTti3cO5bOPctnPsWzn0L576Fc9/CuW/h3Ldw/h+1cIa6IEVMB1XBhSssu2rDTagJn282dl4kLKei8eic3dxQ9vidLlYrGv5Qo6aK80XCrrkWlAV09eYk1lWpEnmFSyo5+IpC/y3tn3irc+WRjTI7lYT9ihdOTXfCduvab07P3rKETULzaakyWqP5nBpT+ZyNKDplronVSdi1H3LXWVRwOatdcZR5vFQO5rXN12vJV66WHH50aqxcLjtUrheZPSv0lxjbuuCvVKP4Dpd/a8D9zM4FQbYRmlR4sVqt/gvY9QeY",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 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 Template"})}),"\n",(0,a.jsx)(r(),{method:"post",path:"/createtemplate"}),"\n",(0,a.jsxs)(n.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)(n.strong,{children:"template_id"})," that can be used to generate documents based on the specified template."]}),"\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.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)(o.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 file"}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(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:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample description"}}),(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)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,a.jsx)(n.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)(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:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,a.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(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:"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)(l.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(n.p,{children:"Template created successfully!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(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",example:"Bh2Hspnmch"}}),(0,a.jsx)(c.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)(d.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)(n.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)(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)(d.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)(o.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)(d.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/bfe4b778.b61a7ff2.js b/assets/js/bfe4b778.b61a7ff2.js new file mode 100644 index 000000000..9206eb814 --- /dev/null +++ b/assets/js/bfe4b778.b61a7ff2.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:()=>y,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),t=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),d=(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+tu2zYUfpXT82ctoNhOmnaYMAzr2qINWrRBk6LAEiOgpSObDUWyJGXHMPRvT7JH25MMh5Js2bm0GYoN2J/Aoc7t+3huXGEQU4/pGb4wWVWSDh7HCebkMydtkEZjiqczgo82F4Ggk4Jnx0cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGeioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHuWYYuOkw4cJbhxherZCLUrCFDtbFzLHBCXTY0WY4S5nRy8Y8Jb3iFET5RHUhFpcbMfRl0o6yjENrqIEfVgq9uZlaRVhgnRllckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1Qj52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzs2dvqeuhm8pmyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMMUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8bm+jjXWdYJBhy9RFLzcvJnzVdc1yjrw12jesHoxG1zNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8NofH762TEgb0rNwt9LB6ODx3v5ob/Tj6f7T9PCn9MnTwWg0+h0TvCrVJp+QrWGfvfh/70BqJTVddKxdHIxGF49bKg9vYq/NFtuW0VwomUMhSeXAPv13JJCcM+4fZvMd8d0FnyF34A/vSB1uwoWpdP5fw70porsBHl4criE+uQ7xSDeU8WQ6NZek/w2EGzx996Fxz6FuZ7VshOJ33ALbP29AesoqJ8MyjrWrPWHlXvM9PRvzsCgpzAyPRFs1czDMMMVh112Gq16fqZHtuXk3JSunMMVZCNanw6GwdmAsae6eSkz8IDPlUFg5nO9jnexK+yCmUk/37qkldD4xV7drjDeIT/hWGuK3cK/pF1a+oSUmHa19qXbaz0jk5OIV8GV/2EzWl92VrW9ldxx10+jbBszuSnHjyOhPDOSbl7owEVGbAe8t6RM2zvkz379m9ROpzJTE0563lU78rz/+jBqd05jeD+B95cCaBbmiUjHuQtGVnCjqL4S8lgUDnkSpyHu1BKkDTR2vErmcyiBUxCv1FDJhxUQqyQXBYoa1HfRqyg/g04zCjBx/+sHxIpjTnBTXEShjLtlOMCCqYMrooyNqYdxlwSElIGBSeanJe/BEnQrpmeBFsUuQBIwDoYF0IGed9ARClixcGAdUFDKTbJir34ksQCm0mBI7S4DjZhbaRuvBmUnlA3ijqggk7shEoYEYN8EBvJBzaoDzYbMsUw7Tik0kkJmcoG0GDEPnMCEfwLJ7mVE06oNwvJfNycUSatbgSimwhruUFIq30f7dsqHghPbcSpuAuqtZ02ed4S0g+sjFcgDn+lyfcLJUnjgBlNSXPj3Xe3C2TrNPNPEy0PhhV6CLxeJacT7a1nklw6yagCNrNnrTeBhLua++/odXzUCu9O+LE3JzmVHbFW7xOYzCw7Z3iyz2biqFVE3h/7qrwNWkZEba92v62avjtzCHx4MRJr1W9A0BD98ePX/57uQl2+WG2dTf/mA0GPGRNT6UQvdc7by5dkt3tRlC/9cnWtuWA12FoVVCxtkWSV+1c+kMe/0y7b/OxgnOjA8sslpNhKePTtU1H3+pyPH0Gyc4F06KCTfKsxXm0vPvfP3KupXuhx+69w7c76F3I6Bu+GiePHOhqrjiJ3hJy50XZz2uk24CccSNxPMmrr1TtrOxcG0v4eHZaDzLMrLhTtn+InD88RQTnLSvxzI+RNGJBb9cxQJTPMdzjC/q2OdYKJ6vUAk9rcSU5RuzPDdFxTfXH7qXcei2PxjYjZRsT+MGCf9lXDcq/MyZ+oaWv6zFmy+3KrTUdtJ8PeO6rv8Gwy39SA==",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+tu2zYUfpXT82ctoNhOmnaYMAzr2qINWrRBk6LAEiOgpSObDUWyJGXHMPRvT7JH25MMh5Js2bm0GYoN2J/Aoc7t+3huXGEQU4/pGb4wWVWSDh7HCebkMydtkEZjiqczgo82F4Ggk4Jnx0cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGeioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHuWYYuOkw4cJbhxherZCLUrCFDtbFzLHBCXTY0WY4S5nRy8Y8Jb3iFET5RHUhFpcbMfRl0o6yjENrqIEfVgq9uZlaRVhgnRllckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1Qj52Zy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzs2dvqeuhm8pmyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMMUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8bm+jjXWdYJBhy9RFLzcvJnzVdc1yjrw12jesHoxG1zNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8NofH762TEgb0rNwt9LB6ODx3v5ob/Tj6f7T9PCn9MnTwWg0+h0TvCrVJp+QrWGfvfh/70BqJTVddKxdHIxGF49bKg9vYq/NFtuW0VwomUMhSeXAPv13JJCcM+4fZvMd8d0FnyF34A/vSB1uwoWpdP5fw70porsBHl4criE+uQ7xSDeU8WQ6NZek/w2EGzx996Fxz6FuZ7VshOJ33ALbP29AesoqJ8MyjrWrPWHlXvM9PRvzsCgpzAyPRFs1czDMMMVh112Gq16fqZHtuXk3JSunMMVZCNanw6GwdmAsae6eSkz8IDPlUFg5nO9jnexK+yCmUk/37qkldD4xV7drjDeIT/hWGuK3cK/pF1a+oSUmHa19qXbaz0jk5OIV8GV/2EzWl92VrW9ldxx10+jbBszuSnHjyOhPDOSbl7owEVGbAe8t6RM2zvkz379m9ROpzJTE0563lU78rz/+jBqd05jeD+B95cCaBbmiUjHuQtGVnCjqL4S8lgUDnkSpyHu1BKkDTR2vErmcyiBUxCv1FDJhxUQqyQXBYoa1HfRqyg/g04zCjBx/+sHxIpjTnBTXEShjLtlOMCCqYMrooyNqYdxlwSElIGBSeanJe/BEnQrpmeBFsUuQBIwDoYF0IGed9ARClixcGAdUFDKTbJir34ksQCm0mBI7S4DjZhbaRuvBmUnlA3ijqggk7shEoYEYN8EBvJBzaoDzYbMsUw7Tik0kkJmcoG0GDEPnMCEfwLJ7mVE06oNwvJfNycUSatbgSimwhruUFIq30f7dsqHghPbcSpuAuqtZ02ed4S0g+sjFcgDn+lyfcLJUnjgBlNSXPj3Xe3C2TrNPNPEy0PhhV6CLxeJacT7a1nklw6yagCNrNnrTeBhLua++/odXzUCu9O+LE3JzmVHbFW7xOYzCw7Z3iyz2biqFVE3h/7qrwNWkZEba92v62avjtzCHx4MRJr1W9A0BD98ePX/57uQl2+WG2dTf/mA0GPGRNT6UQvdc7by5dkt3tRlC/9cnWtuWA12FoVVCxtkWSV+1c+kMe/0y7b/OxgnOjA8sslpNhKePTtU1H3+pyPH0Gyc4F06KCTfKsxXm0vPvfP3KupXuhx+69w7c76F3I6Bu+GiePHOhqrjiJ3hJy50XZz2uk24CccSNxPMmrr1TtrOxcG0v4eHZaDzLMrLhTtn+InD88RQTnLSvxzI+RNGJBb9cxQJTPMdzjC/q2OdYKJ6vUAk9rcSU5RuzPDdFxTfXH7qXcei2PxjYjZRsT+MGCf9lXDcq/MyZ+oaWv6zFmy+3KrTUdtJ8PeO6rv8Gwy39SA==",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"}},y={},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:"Update Document"})}),"\n",(0,l.jsx)(r(),{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)(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 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)(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)(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)(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)(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)(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)(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)(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)(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 v(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/bfe4b778.e4c5eb7c.js b/assets/js/bfe4b778.e4c5eb7c.js deleted file mode 100644 index d602f25aa..000000000 --- a/assets/js/bfe4b778.e4c5eb7c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2087],{67554:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>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.7bf95e17.js b/assets/js/f0ff4a36.7bf95e17.js new file mode 100644 index 000000000..ef41bae95 --- /dev/null +++ b/assets/js/f0ff4a36.7bf95e17.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:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const x={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/onschz5znfOeSKeT51LL5ir3VaFqi8Y+OIZehSK4wXWrGYXeYIp+ihJYGT92eAiicSHSx1CV6DRW8FzhAy9FxIBzzRpQcOzmAqJiKFrOHusYhpg5aT9LOMxWyKvt1kETPc8gI9WjJrxRQvkMWsJbgWGYuYILMM9zm7batOPmPqzzLQk7W9LGIWv5TCYsZib0uMmPNLSWKdKIxEFjFcGKkzZPGES0cEaY4FZ/GK+aUJlN4KNWURm2hbcN9dwQUPUmJmfhkmeXqYm4RV1ZjUOqOVQ0eCDgcD+rdtryvTFJ2blBLWQWERS7XyZHm8YtwYKdKw0f/siGm1a13tNkXPkhgvapVtNPb14+dTcXN4lOQffmVVxCaCFveTkHtvXNzvNyullb1UFyTNC7+/OBd+UA6RCKX93hKMRO4QnJiqdSoG57TM0H6rUNbZvJ+E2kIIrNUmgJuSaFyoIqbnasuXr5L/WSMkiMRP0QmFt5bAreVLqjiPhXs8SlbffbYbbSnqhwJxp1lYcCEfpU4QXzULba6ZXKtH1IyeHx8Oj16+GBL9XGRT9P/C/3p3V9920Z9IqeeYwYzLEh0chKzkvrQYgfO8ML3HyqGlJ6MXHYWqLBK0Xe71ypr7cDSqIrbck+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YbFhKtJXLVVRhaRRWx1CL3mJ34hzPtcHB4dDAcHAxeXA6P49H38fPj3mAw+INFbFGE9G57HffIuoXefJcm+wZ6qh2yDlrexh4KZxWx0V2t7UIX6HOhpjCnoWFutZpG0OCwt0vgUy4UUPztk/+u56G1+k4M3ERoP8u6CSOUFAqv275+PRoMrofrIIx2g7CemZT2MNGlyr6tq3fpf9ih0fXR2qHnuw6dqRmXIgsz4KW+QfVt/emq97X63YwVNVHYZ1vOdtdrJx2mpRV+GYbNxQE34qDej6/GNMJRpuhmSg3Tqc9ZzPptAfRXncm0YiTPztrZtbSyMwpxY3raoCLwljxx1KT63Ij+jHrPbWrn+VSo6cGeXFxliV7czzHeeHxBp1IHfsvvTe8z4i1S82vC2qVqZvAceRg9Kvqe6MDcBPvcoCJYDUc1G+40wY8oU10gXR58jtCS//3nX4GjDWvIpCdwXloweo6WJmWuMphIXIhEYiDm1FDXdxGHvJDonFyCUB6nlnuETEyF5zK0Wqr8lBueCCko94hME7eFTvq6HnzM0edoaes7i8AhwxlKSlmQWt+QHK+Bl14XQUdbbHNtbyZkUgQcktIJhc6BQ2xZUOVcpQjtWUSgLXAFqDxaY4VD4KIg4om2gJOJSAUJpkKzPPVQcMWnSMoiILspCsbqmcjQgdVJ6Tw4LcvgCGksEH3tokLMXA9eixnWjtNifW3DDKYliYgg1RlCU3fkhsogQefBkHqRYhDqPLceJM7QhmwNJzkppQSjCRAEl3QR654tCfKWK0edvDaoPZp1+IzVdCkKOjK+7MEn9UkRaEPpkBJACnXj4k/qAK7WafYREyc8jp+2tTCfz3fq4Nk2z6nweZmARaM3fNOwGKqmy77+eMYi5tEW7nxygXYm0va+c4/OfiDuNzDJ0wCTzUhLNfbqNgNBlhQpKocdUDs5ff8OZnDUG7CoU/VfYXD/3dlPb367eENyCZvq+hv2Br1BGJK18wVXHVXdy/7tul1twP5/eBhokMfjwveN5CLAd3B21UDvFeu8FcTdZ4FxxHLtPJGsVgl3+MHKqqLlLyVaAvhxxGbcCrIv4HMmHP3O1rf+ez19+nvzgPAM7nlhuNPyFkgVoWiY9lnMWMRucHnrTaMa06RcoymZVlOcpCka3+Hd6a5bLer0zSWLGC99vo3iNwHFmx8k/U67tuG9NoD+Upe5k+EHOu63uPxxTV7v3MvQ+NdSU4zGVVX9A8dpXxs=",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/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/onschz5znfOeSKeT51LL5ir3VaFqi8Y+OIZehSK4wXWrGYXeYIp+ihJYGT92eAiicSHSx1CV6DRW8FzhAy9FxIBzzRpQcOzmAqJiKFrOHusYhpg5aT9LOMxWyKvt1kETPc8gI9WjJrxRQvkMWsJbgWGYuYILMM9zm7batOPmPqzzLQk7W9LGIWv5TCYsZib0uMmPNLSWKdKIxEFjFcGKkzZPGES0cEaY4FZ/GK+aUJlN4KNWURm2hbcN9dwQUPUmJmfhkmeXqYm4RV1ZjUOqOVQ0eCDgcD+rdtryvTFJ2blBLWQWERS7XyZHm8YtwYKdKw0f/siGm1a13tNkXPkhgvapVtNPb14+dTcXN4lOQffmVVxCaCFveTkHtvXNzvNyullb1UFyTNC7+/OBd+UA6RCKX93hKMRO4QnJiqdSoG57TM0H6rUNbZvJ+E2kIIrNUmgJuSaFyoIqbnasuXr5L/WSMkiMRP0QmFt5bAreVLqjiPhXs8SlbffbYbbSnqhwJxp1lYcCEfpU4QXzULba6ZXKtH1IyeHx8Oj16+GBL9XGRT9P/C/3p3V9920Z9IqeeYwYzLEh0chKzkvrQYgfO8ML3HyqGlJ6MXHYWqLBK0Xe71ypr7cDSqIrbck+vFkOKzJ9PRyypi+Z5Mo2M6OT7FPfmG3eLwWBjJPV5f1Cl93R5t9RBVqC+HKjtT53YbFhKtJXLVVRhaRRWx1CL3mJ34hzPtcHB4dDAcHAxeXA6P49H38fPj3mAw+INFbFGE9G57HffIuoXefJcm+wZ6qh2yDlrexh4KZxWx0V2t7UIX6HOhpjCnoWFutZpG0OCwt0vgUy4UUPztk/+u56G1+k4M3ERoP8u6CSOUFAqv275+PRoMrofrIIx2g7CemZT2MNGlyr6tq3fpf9ih0fXR2qHnuw6dqRmXIgsz4KW+QfVt/emq97X63YwVNVHYZ1vOdtdrJx2mpRV+GYbNxQE34qDej6/GNMJRpuhmSg3Tqc9ZzPptAfRXncm0YiTPztrZtbSyMwpxY3raoCLwljxx1KT63Ij+jHrPbWrn+VSo6cGeXFxliV7czzHeeHxBp1IHfsvvTe8z4i1S82vC2qVqZvAceRg9Kvqe6MDcBPvcoCJYDUc1G+40wY8oU10gXR58jtCS//3nX4GjDWvIpCdwXloweo6WJmWuMphIXIhEYiDm1FDXdxGHvJDonFyCUB6nlnuETEyF5zK0Wqr8lBueCCko94hME7eFTvq6HnzM0edoaes7i8AhwxlKSlmQWt+QHK+Bl14XQUdbbHNtbyZkUgQcktIJhc6BQ2xZUOVcpQjtWUSgLXAFqDxaY4VD4KIg4om2gJOJSAUJpkKzPPVQcMWnSMoiILspCsbqmcjQgdVJ6Tw4LcvgCGksEH3tokLMXA9eixnWjtNifW3DDKYliYgg1RlCU3fkhsogQefBkHqRYhDqPLceJM7QhmwNJzkppQSjCRAEl3QR654tCfKWK0edvDaoPZp1+IzVdCkKOjK+7MEn9UkRaEPpkBJACnXj4k/qAK7WafYREyc8jp+2tTCfz3fq4Nk2z6nweZmARaM3fNOwGKqmy77+eMYi5tEW7nxygXYm0va+c4/OfiDuNzDJ0wCTzUhLNfbqNgNBlhQpKocdUDs5ff8OZnDUG7CoU/VfYXD/3dlPb367eENyCZvq+hv2Br1BGJK18wVXHVXdy/7tul1twP5/eBhokMfjwveN5CLAd3B21UDvFeu8FcTdZ4FxxHLtPJGsVgl3+MHKqqLlLyVaAvhxxGbcCrIv4HMmHP3O1rf+ez19+nvzgPAM7nlhuNPyFkgVoWiY9lnMWMRucHnrTaMa06RcoymZVlOcpCka3+Hd6a5bLer0zSWLGC99vo3iNwHFmx8k/U67tuG9NoD+Upe5k+EHOu63uPxxTV7v3MvQ+NdSU4zGVVX9A8dpXxs=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Document from Template",permalink:"/docs/API-docs/createdocumentwithtemplateid"},next:{title:"Update Document",permalink:"/docs/API-docs/update-document"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Get Document"})}),"\n",(0,l.jsx)(t(),{method:"get",path:"/document/{document_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(c.Z,{className:"paramsItem",param:{name:"document_id",in:"path",description:"objectId of Document",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"folder"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"widgets"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Document not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function 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/f0ff4a36.9fb55142.js b/assets/js/f0ff4a36.9fb55142.js deleted file mode 100644 index 5b4aaf4a0..000000000 --- a/assets/js/f0ff4a36.9fb55142.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:()=>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.a3e642f7.js b/assets/js/fa40969b.a3e642f7.js new file mode 100644 index 000000000..47d55eb43 --- /dev/null +++ b/assets/js/fa40969b.a3e642f7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var n=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const u={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5mKbYCSNbDnpDhaLGk3WcFtsgthFgI0FgzNzpGHMIVmSox8Ic7dP0kfrkywOZ0YaWXZidYtc9cbWkOef3/khN8zzuWPJR/ZaZ1WJyjs2jViOLrPCeKEVS9izZ8+g24brtUGX3Kj36K3ABQIHKZwHPYO8EwEpd5iDVuDXBm/UjRoP4cWL15bP/FaSS168uFEAAIPdGviCe+AWIausReXlGoSCPHA6z33lhiTvhORdqsE7q+cWnftDUk3LHCSeksQfdGkkesyfIq/gC4QUUYGrsgydm1VSriHbylgKXwCXEiz+WgmLOTgxV9xXFhudE9L5ZmXC3lM1YkvPVR5cUhqkVnO0wIMVIpUYpJ+FmGMmhTrWobzjStfgC4TKoR3eKBYxbdBywsVlzhI2R98dOoGARcxwy0v0aAlUG6Z4iSxhuc4ICSxiggBluC/YfZRdFxjgso8kr8G2SGMR6wLJEm8rjJjza0nynaCYs4jhykidI0tmXDoiyAosOUs2LOhPmPNWqDlRqqok3AdoBcM6OLCIbc+wERlUkr1NVNi0rqOtb1KUwnee/VqhXe8Z2hnSWjrTtuzb2fqxNbPkK1GSZWdxHHVGq6pM0bKa+HjwNBnHPRPcnTB/mgWP64zrKcl1RiuHjmhP4pj+7R/kLhtgi5YQU+VReaLnxkiRhY3RJ0dMm0MDdPoJswApS2K8aFRadJX0PTpuLSeHhcfSfZm/WSb0HmKCQsP9Hko639m/LsTdyWla/PIjxWQmaPE4CYX3xiWjUbtSWTnMdEnSvPDHi3PhB6UKiVDaHy3BSOQOQ1HaZlxwTssc7dcKZYPh4yQ0FkJgrXcBZJ0Xt60LdcT0Uu358iT5n3QohMRP0QnV7I8CzuqHz3anLUP9uUA8aBaWXMgvUqeI37cLHdZModUX1EzOXp6MT797NSb6pcjn6P8P/5vdQ337ReNcSr3EHBZcVuhgsGuVEfX90gy/lA4dPRm9OixkPe7typb7ZDKpI7Y+kuvVmOJzJNPpd3XEiiOZJi/p5Pgcj+Qb95PDY2kk93h71UD6tjva+nNUIb8cqvxSvbX7ZSHVWiJXfYWh19QRyyxyj/m5/zzSTuKT08E4HsSvrscvk8nfk7OXwziO/8MitioDvLsBgntk/URvvyuTfwU99QFZr1rerz374RSKRobbrmvensTx7YRI6ohN4slh93yPRlsPSnvgCy4kTyV+8+e1T7RWP1gOd8F62ILPOTWJJ7dnW6fODp26VAsuRQ7n7y7hWt+h+roe9dX7Rv3hmYqGKOyzPWf7642TDrPKCr8OM+5qwI0YNPvJxykNSSX6QrcDchiKfcESNurPyqNNOxTXjOTZRTcyV1b2hgVuzFAbVFTeJE8dlfERN2K0oOp8n9p5PhdqPjiSi6s81avHOaY7j6/oVJrA7/m96w5G/ITUHtqw9qnaEbVAHppzTd8zHZjbYL81qKjwhKNajA/axAeUmS6RrgV0L+nIf//vb4GjC3BA0jfwtrJg9BItzaJ0X5pJXNH9KBBzajkO1roicQ55KdG5cDX0OLfcI+RiLjyXoRkJNYeMG54KKQh7RKaJ20IPvm4IHwr0BVra+pul+3GOC5QEWZBa35Ecr4FXXpdBR3ezXmp7NyOTIuCQVk4outg6xI4FVcFVhtCdRQTaAleAyqM1VjgELkoinmkLOJuJTJBgSjTLMw8lV3yOpCwCspuiYKxeiBwdWJ1WzoPTsgqOkMYS0TcuKsTcDeG1WGDjOC3m6LmQmMO8IhERZDqnC2rIO3JD5ZCi82BIvcgwCHWeWw8SF2gDWsNJ0t0ZjKaCILikO2D/bEmQt1w56nWNQd3RbMNnrKZrR9CR8/UQ6A58RWCpHBIApFB39HIxgI9bmH3A1AmP02+7XFgulwd58Hyf50L4okrBotE7vnlYDFnTZ99+PGcR82hL93Z2hXYhsu5G8IjOUSAetWWSZ6FMtkMf5dj39xmoZEmRoXLYK2rnF+9+hgWcDmMW9bL+CQaPfr784c2/r96QXKpNTf6Nh/EwDmOkdr7kqqfqAndvO82T0Mzqsn20uZ/Im131/+t56a/npe3zUttEPK78yEguQicOuN20XfQju/filHSPS9OIFdp5ItlsCCK/WFnXtNy8iVBzzYWjcWb3KnKH694bTrh9sISFJvkIbfvYsiOd0ocVRPuwjkeR/+379uSew1Nevx4MTtd21bpvVGdsF5t6SreOpu+Sjc3ueZah6ft9MIftDTMXb65ZxHjli/1+fxf6ffuDpD9o0/4g0BhAfynUDzL8g9rTT7j+55a82XmUofWvo6b4TOu6/h9h3txv",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWN1uGzcWfpVT5mKbYCSNbDnpDhaLGk3WcFtsgthFgI0FgzNzpGHMIVmSox8Ic7dP0kfrkywOZ0YaWXZidYtc9cbWkOef3/khN8zzuWPJR/ZaZ1WJyjs2jViOLrPCeKEVS9izZ8+g24brtUGX3Kj36K3ABQIHKZwHPYO8EwEpd5iDVuDXBm/UjRoP4cWL15bP/FaSS168uFEAAIPdGviCe+AWIausReXlGoSCPHA6z33lhiTvhORdqsE7q+cWnftDUk3LHCSeksQfdGkkesyfIq/gC4QUUYGrsgydm1VSriHbylgKXwCXEiz+WgmLOTgxV9xXFhudE9L5ZmXC3lM1YkvPVR5cUhqkVnO0wIMVIpUYpJ+FmGMmhTrWobzjStfgC4TKoR3eKBYxbdBywsVlzhI2R98dOoGARcxwy0v0aAlUG6Z4iSxhuc4ICSxiggBluC/YfZRdFxjgso8kr8G2SGMR6wLJEm8rjJjza0nynaCYs4jhykidI0tmXDoiyAosOUs2LOhPmPNWqDlRqqok3AdoBcM6OLCIbc+wERlUkr1NVNi0rqOtb1KUwnee/VqhXe8Z2hnSWjrTtuzb2fqxNbPkK1GSZWdxHHVGq6pM0bKa+HjwNBnHPRPcnTB/mgWP64zrKcl1RiuHjmhP4pj+7R/kLhtgi5YQU+VReaLnxkiRhY3RJ0dMm0MDdPoJswApS2K8aFRadJX0PTpuLSeHhcfSfZm/WSb0HmKCQsP9Hko639m/LsTdyWla/PIjxWQmaPE4CYX3xiWjUbtSWTnMdEnSvPDHi3PhB6UKiVDaHy3BSOQOQ1HaZlxwTssc7dcKZYPh4yQ0FkJgrXcBZJ0Xt60LdcT0Uu358iT5n3QohMRP0QnV7I8CzuqHz3anLUP9uUA8aBaWXMgvUqeI37cLHdZModUX1EzOXp6MT797NSb6pcjn6P8P/5vdQ337ReNcSr3EHBZcVuhgsGuVEfX90gy/lA4dPRm9OixkPe7typb7ZDKpI7Y+kuvVmOJzJNPpd3XEiiOZJi/p5Pgcj+Qb95PDY2kk93h71UD6tjva+nNUIb8cqvxSvbX7ZSHVWiJXfYWh19QRyyxyj/m5/zzSTuKT08E4HsSvrscvk8nfk7OXwziO/8MitioDvLsBgntk/URvvyuTfwU99QFZr1rerz374RSKRobbrmvensTx7YRI6ohN4slh93yPRlsPSnvgCy4kTyV+8+e1T7RWP1gOd8F62ILPOTWJJ7dnW6fODp26VAsuRQ7n7y7hWt+h+roe9dX7Rv3hmYqGKOyzPWf7642TDrPKCr8OM+5qwI0YNPvJxykNSSX6QrcDchiKfcESNurPyqNNOxTXjOTZRTcyV1b2hgVuzFAbVFTeJE8dlfERN2K0oOp8n9p5PhdqPjiSi6s81avHOaY7j6/oVJrA7/m96w5G/ITUHtqw9qnaEbVAHppzTd8zHZjbYL81qKjwhKNajA/axAeUmS6RrgV0L+nIf//vb4GjC3BA0jfwtrJg9BItzaJ0X5pJXNH9KBBzajkO1roicQ55KdG5cDX0OLfcI+RiLjyXoRkJNYeMG54KKQh7RKaJ20IPvm4IHwr0BVra+pul+3GOC5QEWZBa35Ecr4FXXpdBR3ezXmp7NyOTIuCQVk4outg6xI4FVcFVhtCdRQTaAleAyqM1VjgELkoinmkLOJuJTJBgSjTLMw8lV3yOpCwCspuiYKxeiBwdWJ1WzoPTsgqOkMYS0TcuKsTcDeG1WGDjOC3m6LmQmMO8IhERZDqnC2rIO3JD5ZCi82BIvcgwCHWeWw8SF2gDWsNJ0t0ZjKaCILikO2D/bEmQt1w56nWNQd3RbMNnrKZrR9CR8/UQ6A58RWCpHBIApFB39HIxgI9bmH3A1AmP02+7XFgulwd58Hyf50L4okrBotE7vnlYDFnTZ99+PGcR82hL93Z2hXYhsu5G8IjOUSAetWWSZ6FMtkMf5dj39xmoZEmRoXLYK2rnF+9+hgWcDmMW9bL+CQaPfr784c2/r96QXKpNTf6Nh/EwDmOkdr7kqqfqAndvO82T0Mzqsn20uZ/Im131/+t56a/npe3zUttEPK78yEguQicOuN20XfQju/filHSPS9OIFdp5ItlsCCK/WFnXtNy8iVBzzYWjcWb3KnKH694bTrh9sISFJvkIbfvYsiOd0ocVRPuwjkeR/+379uSew1Nevx4MTtd21bpvVGdsF5t6SreOpu+Sjc3ueZah6ft9MIftDTMXb65ZxHjli/1+fxf6ffuDpD9o0/4g0BhAfynUDzL8g9rTT7j+55a82XmUofWvo6b4TOu6/h9h3txv",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"}},g={},f=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(l.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"folder"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"widgets"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(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,n.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(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,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.d61efa9d.js b/assets/js/fa40969b.d61efa9d.js deleted file mode 100644 index ae02d32da..000000000 --- a/assets/js/fa40969b.d61efa9d.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:()=>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.ee8e94a9.js b/assets/js/runtime~main.a02f3159.js similarity index 84% rename from assets/js/runtime~main.ee8e94a9.js rename to assets/js/runtime~main.a02f3159.js index 511090877..666b0eb11 100644 --- a/assets/js/runtime~main.ee8e94a9.js +++ b/assets/js/runtime~main.a02f3159.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:"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{"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:"a3e642f7",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:"7bf95e17",1477:"b31b2642",1512:"9637e502",1520:"cfa8a05d",1531:"f156ca0b",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"b61a7ff2",2121:"c8df990c",2125:"9a2b70d2",2207:"d6937815",2213:"d47dd20f",2241:"5104cb4f",2245:"cf280f35",2267:"a4846e2b",2362:"ebdb1814",2403:"a09d80c4",2529:"2079a565",2535:"f3b6b0ab",2542:"d72b2598",2546:"665b04f4",2617:"56321ade",2832:"70560ad8",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"f275f83a",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"774fa7a2",4651:"48542eac",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"41c168b1",6103:"ebc8482f",6113:"7c32856a",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"08d2a181",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"ab6ff70c",7964:"c742feb2",7971:"79523427",8055:"27482879",8087:"cde5db0f",8106:"6a7b09a1",8140:"901b2f91",8141:"60a9b3b8",8163:"4ca525ce",8215:"c6b04c16",8468:"34673f6d",8474:"a75e5064",8475:"d27b3009",8489:"7764bd79",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"6ace34db",8781:"8ef3818e",8784:"5f29f05d",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"ab27f80c",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"7973af60",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 3dff88f43..2c8c39065 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 ad83d7429..dea4069f7 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 cf007235a..20a81e88a 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 f8aebff06..d85dd2b8d 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 5c59398b1..116e618a1 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 eab0af8de..23cde5b8a 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 cfafb6a2b..6137fa097 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 9ea1d5755..4b9a43424 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 c8a4005ac..32ef047ed 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 2ddfc0284..1fe846499 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 4a32a75bf..62037b687 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 352f42e89..d9cbe722d 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 d9aa59b5d..740232f05 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 47435737a..79c06e002 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 df362b568..4e126898a 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 78133667d..3df88488b 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 32df597b6..70a8e20bc 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 a9fdbac1a..94aaf38dc 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 9bb07fee6..ad17c569f 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 0f48191c8..c0222b5df 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 b15df24c0..7b0fc9ad8 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 da566682e..49396e2f5 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 b618659fc..f8e9421ec 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 dbee59ddf..9109a0473 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 1938ee25b..084bc3b7e 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 a19e7e816..ae562913b 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 19633ec66..392d27a6c 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 20ee0c50b..9876e865d 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 3185677e5..8545d5043 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 b05dc4e5d..036127448 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 4b89c74e4..b7715bbad 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 1da0bdd1e..eb6ee9d58 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 435ff1ba8..104ba80de 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 43673961d..79124a112 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 a48017b33..aab753973 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 53004d104..9213f35f6 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 30dcf8736..6f2db938f 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 9ec0f8257..ee3ad5049 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 0da93c8d4..4e584d6b1 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 acf260d16..95f750d15 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 6e1e0468b..e70a6bb41 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 63e7c08ce..04f8cd914 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 9e1b21824..6c965fb9e 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 b1314763d..95171dec0 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 82da33472..48269c988 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 f413e93fc..e31aee62e 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 cc7603a46..007e0832a 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 b1133c8de..299140ed4 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 d9dedcba7..33f06e356 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 903e7a54d..4ffbae5bf 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 bf75e59e9..f4514c2cc 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 b99c7a865..e0383ee0f 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 68f07d07b..e97376798 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 02a11cecc..b269878d9 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 9751fce77..e39b151c2 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 a43709499..c98f00127 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 3cddf2d6b..793dec651 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 75c58b49f..daf7b5236 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 3851e306d..464c96d63 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 2878e6a50..b209a3557 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 1ea94a5d9..7a05f2f06 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 e47bc586b..ec0ebef38 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 26acb7093..371cd18c0 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 1ade9f839..d61c55dc4 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 219cff13d..1ca1b7f76 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 aaaea4351..5cb97db10 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 2fafc733e..5a55fa3e1 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 ac4570a43..0fe589b1f 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 17d019f6c..c0d028e44 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 1b14a571f..1f5d63728 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 dc2aa7524..7652a8f7b 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 c83f77487..621124e52 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 2ff38623f..d8f160b26 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 2cd5a38fb..c595b03b3 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 64ded9f4a..d45ba3d44 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 39ec6e72e..ab7b80af7 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 79b9ac1a6..db14bad1a 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 b92164c1f..8fcfaf74b 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 7f61773da..bd3d2ad3d 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 1c58e152c..f4d7015c5 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 181a0cfc9..575ad9025 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 54b6b2468..81c40ae9c 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 089cd054d..987ea5c26 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 5c9e03e17..4a8d7855a 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +