diff --git a/404.html b/404.html index fdfcfe924..56d7aa3e8 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.8538abf4.js similarity index 60% rename from assets/js/05632a52.48542eac.js rename to assets/js/05632a52.8538abf4.js index e4a159bfc..9412ec976 100644 --- a/assets/js/05632a52.48542eac.js +++ b/assets/js/05632a52.8538abf4.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>v,frontMatter:()=>x,metadata:()=>u,toc:()=>f});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),p=s(4667),m=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxAw55N23p7ZmWfmNoJkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnUn4lEOOlljYSeI9oII2sUqejPr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0tafgGVzJaSYX7ZZpV+XHlMtG2M3YbnDUBAxs6nkz43364oclzDGHeaNhlRCQRLBpieemcVnk8GN8EVto8jK5DzbnzbIZU53KbjEfjqKZZtTq+caJN+vw/zsCNRcgQWR1rqfT/0M8QX/UvRrmt2ZSrrHl0KCfT59Pj+Mcmco+SsDilQ2bulI4nx8+PppOjyfeX05fpyQ/pi5ejyWTyp0jEqo5o+qosJEWUpEgPnxtXfAM/7X2xvuL7BhwqbHuhbVnr5FAtXtgaqVKmhCUagqW3pkzAaZQBgfwaZCmVAS0J/ZOvV6TovfVfTtPjImsHsJXRyuD1thGvTyaT6+kuCScPk7ClN2MJ5rYxxbdFesD9l+GcXB/v4Lx4COfcLKRWRWTrS3uL5tvCGbqnzv3DolWdUDwXe2CH7zuQAfPGK1rHybA6kk4ddefp1YwZl+vE9hMljhKqRCrGffWPN3dTpBVszS+2Y6bxWqSiInIhHY+DNEVmVyPr0ARVGi2zwDQ0lk6NF0wl9zWkc4+QDiRLZcqjL2rN7vBe8J10ad9DvUu+dOpXXIstXe9J9fOyQlmgjxegzNxG5T7V7xyaC1WaeFGL6YOp+gF1bmvkKU8Vwlb8n7/+jhqFzZsaDcU6egLvGg/OLtHzWJOmgLnGlco0HlgaAspaYwh6DcoQll4SQqFKRVIDZ4W7PpdOZkorrjwWs6ztYVC8YQQfKqQKPR995xEkFLhAzQUL2tpbtkMWZEO2jj76mGFp/e2cQ0pAQtYEZTAECIhbFTSVNDnC9i4SsB6kATSE3nkVEKSqWXhuPeB8rnLFhrnWPDdzLY0skZ0lwHFzFpy3C1VgAG+zJhAEq5sIhD3WiNRBNIhFGMHPaoEdcH7Z0TsWUDZsIoHcFgh91zEMU0CGgcCxe5VjNBpIegKNC/Sx9uJNzhutwVmmAyU1L03Du2VD5KUJPGC7gLZXs0uf85Y3mOijkOsRfDQfDRM2NAG5ALQytyH9aI7galdmHzALinD2dNsPy+XyQR8829c5U1Q1GXh09k6vjC9j1wzVdw/PRCIIfR3ezS/QL1SOfRN+xuc4Co97kuSByUTXrTDcY6/uKzBhaZWjCTigtNOz929hAc9HE5EMOv8/BDx+e/76zW8Xb9guc1PXf9PRZDSJK5ANVEszcDXYye+37eaO6b/2+t6zDuGKxk5LFYk7At30pHsl7tbvdLC8zxJR2UAssNlkMuAfXrctv/7UoGdinyViIb2SGVPT1UYUKvD3Yrecfxbk09/7Pf8ZHP4dcDDsLYMaps+F1A0/iUTc4nr/d0c7a5Mti3JgncBpnqOjgeqDmbo3mM7eXIpEyIZzNGTv28je/Re2fjCsfVrvAuBPnjAHFX7ki/4V1z/txLuTzyr0+LbSnKJZ27b/AmTU4Ws=",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/getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",source:"@site/docs/API-docs/getcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getcontact",permalink:"/docs/API-docs/getcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9V21r3EYQ/iuT/dIE5HtxnJSKUmLS4JqGJtQugTqHWUlz0tqr3c3u6F449K2/pD+tv6TMSnfW2ZdQlxAw55N23p7ZmWfmNoJkGUR6JV5bQzKnIGaJKDDkXjlS1ohUXFYIZ0jQS8Dp+3OQWttlgLVtgCx4JK9wgVAgSaUDyMw2BBKCw1zNVQ55pzsSibAOvWTT54VIRYnUn4lEOOlljYSeI9oII2sUqejPr1UhEqE4IiepEvfDtNkN5nRegJ3DnUmPnxrlsRAp+QYTEWit2WhQtdMoEoErp22BIp1LHVggr7CWIt0IWrsoSV6ZUiRibn0tafgGVzJaSYX7ZZpV+XHlMtG2M3YbnDUBAxs6nkz43364oclzDGHeaNhlRCQRLBpieemcVnk8GN8EVto8jK5DzbnzbIZU53KbjEfjqKZZtTq+caJN+vw/zsCNRcgQWR1rqfT/0M8QX/UvRrmt2ZSrrHl0KCfT59Pj+Mcmco+SsDilQ2bulI4nx8+PppOjyfeX05fpyQ/pi5ejyWTyp0jEqo5o+qosJEWUpEgPnxtXfAM/7X2xvuL7BhwqbHuhbVnr5FAtXtgaqVKmhCUagqW3pkzAaZQBgfwaZCmVAS0J/ZOvV6TovfVfTtPjImsHsJXRyuD1thGvTyaT6+kuCScPk7ClN2MJ5rYxxbdFesD9l+GcXB/v4Lx4COfcLKRWRWTrS3uL5tvCGbqnzv3DolWdUDwXe2CH7zuQAfPGK1rHybA6kk4ddefp1YwZl+vE9hMljhKqRCrGffWPN3dTpBVszS+2Y6bxWqSiInIhHY+DNEVmVyPr0ARVGi2zwDQ0lk6NF0wl9zWkc4+QDiRLZcqjL2rN7vBe8J10ad9DvUu+dOpXXIstXe9J9fOyQlmgjxegzNxG5T7V7xyaC1WaeFGL6YOp+gF1bmvkKU8Vwlb8n7/+jhqFzZsaDcU6egLvGg/OLtHzWJOmgLnGlco0HlgaAspaYwh6DcoQll4SQqFKRVIDZ4W7PpdOZkorrjwWs6ztYVC8YQQfKqQKPR995xEkFLhAzQUL2tpbtkMWZEO2jj76mGFp/e2cQ0pAQtYEZTAECIhbFTSVNDnC9i4SsB6kATSE3nkVEKSqWXhuPeB8rnLFhrnWPDdzLY0skZ0lwHFzFpy3C1VgAG+zJhAEq5sIhD3WiNRBNIhFGMHPaoEdcH7Z0TsWUDZsIoHcFgh91zEMU0CGgcCxe5VjNBpIegKNC/Sx9uJNzhutwVmmAyU1L03Du2VD5KUJPGC7gLZXs0uf85Y3mOijkOsRfDQfDRM2NAG5ALQytyH9aI7galdmHzALinD2dNsPy+XyQR8829c5U1Q1GXh09k6vjC9j1wzVdw/PRCIIfR3ezS/QL1SOfRN+xuc4Co97kuSByUTXrTDcY6/uKzBhaZWjCTigtNOz929hAc9HE5EMOv8/BDx+e/76zW8Xb9guc1PXf9PRZDSJK5ANVEszcDXYye+37eaO6b/2+t6zDuGKxk5LFYk7At30pHsl7tbvdLC8zxJR2UAssNlkMuAfXrctv/7UoGdinyViIb2SGVPT1UYUKvD3Yrecfxbk09/7Pf8ZHP4dcDDsLYMaps+F1A0/iUTc4nr/d0c7a5Mti3JgncBpnqOjgeqDmbo3mM7eXIpEyIZzNGTv28je/Re2fjCsfVrvAuBPnjAHFX7ki/4V1z/txLuTzyr0+LbSnKJZ27b/AmTU4Ws=",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,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)(m.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)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,t.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,t.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,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)(m.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)(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,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)(m.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)(p.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)(m.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)(p.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 v(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.53df0513.js b/assets/js/13fdae3b.53df0513.js new file mode 100644 index 000000000..1d86f7d3e --- /dev/null +++ b/assets/js/13fdae3b.53df0513.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6113],{21598:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>j,contentTitle:()=>u,default:()=>f,frontMatter:()=>p,metadata:()=>x,toc:()=>b});var a=s(85893),o=s(11151),n=s(58219),t=(s(62316),s(51039)),i=s.n(t),d=(s(82723),s(9487)),r=(s(41429),s(5397)),c=s(4667),h=s(9472),m=s(85162);const p={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/rV9SzFLUzY3RFkVfdNk5czmzM4fcioClF+lMPFBWGbMU80QU5HMnbZBGi1TcVwTXpCgQ7DDw7tMtoFJmBRvTQDBQ9PbVzt44JRJhLDnkILeFSEUPGbIkwpG3RnvyIt2K15MJf50mnjZ5Tt4vGgX7UCIRudGBdGA8WqtkHg3jL56dtsLnFdXIv8LGkkiFyb5QHkQirOMwQfYpHflGhSOcD07qUiSC1lhbxUcD3772Avy+IrW5EF2XiCBDREqtpKangdTT68nk6XvRdYx5M3nznNxnTw60CbAwjS4u/jte5JxxL9M6z/0SES5+oPH2OY1b3aKSRZyIe7Mk/f8yOU4f+vRc6rpW7Kex7ilFULSLE6rH5z1JT3njZNiIdLYV60u08rK3p7N5N09ETaEyh3HmmjFUIhXj1X6yPbmWnI8heBNSUYVgfToee9RFZtYjY0l7WWqFmR/lph6jleP2SnTJuQda+w/QPmApdXn5otf8wHLKN9E3+4TrvuVo5QfaiGRo5TEqEZInoCIsyMW2S70w0XnX4I+W9FSWOl5PeyXOleWBVG5qYgEJFcEA/+O336NHYfKmJh3i9FzAx8aBNStyLAioC1goWstM0UGO/KBHnrBW5L3agNSBSoeBoJClDKiAuyJ1CTlazKSSPG8MM+zt4Ghk/QgeKgoVOTZ94wgQCmpJ8ZiCMmbJcYIBbIKpY45dzbAybrngkhJAyBovNXkPnmhwIV2hzgmGu0jAOEANpAM566QnQFkzeGEc0GIhc8mBebkc5gFq1FgSJ0uA6+YuWGdaWZAHZ7LGB/BGNZEIZ6yJQk9RExV+BNeypZ44HxYUUCoqoGw4RAK5KQh2u8Y0dAEZ+QCW08ucYlAf0AVQ1JKLsxdvkgUSrGERkKjALE7ulgMFh9ovjKv7goar2bfPOsNKG3MUuBnBo37UUx6WxhMPgJJ66dNHfQmz/Zg9UOZloPm3wz6sVqtne/Dq1Oe9DFWTgSNrDn5lPIxbc+y+//NKJCKQq/3HxZRcK3PaLeFXco4jeLyTRsyjNFKNUvU79tO5A8uUkjlpT0dC9u79pzto4bvRRCRHm/83Ch7f3f5888v0huOyNvX7dzWajCZ8ZI0PNeqjVKcP/PPN3R4k/t+/HuwkJtA6jK1CGbU5struRHUmVoeXksr4wEfbbYaePjvVdXz8a0OO1XqeiBadxIyVZzbvkkGYWIWXtOH25TlZfsy0qJpe3c4eTicKf31zd3N/IxKBDRdzrInLqIm7H5xgMOnNUfhTsexr4E/W7b90+IEb94E2P+7hveWrDjuKA5pbOO+67k+/h3Ic",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/rV9SzFLUzY3RFkVfdNk5czmzM4fcioClF+lMPFBWGbMU80QU5HMnbZBGi1TcVwTXpCgQ7DDw7tMtoFJmBRvTQDBQ9PbVzt44JRJhLDnkILeFSEUPGbIkwpG3RnvyIt2K15MJf50mnjZ5Tt4vGgX7UCIRudGBdGA8WqtkHg3jL56dtsLnFdXIv8LGkkiFyb5QHkQirOMwQfYpHflGhSOcD07qUiSC1lhbxUcD3772Avy+IrW5EF2XiCBDREqtpKangdTT68nk6XvRdYx5M3nznNxnTw60CbAwjS4u/jte5JxxL9M6z/0SES5+oPH2OY1b3aKSRZyIe7Mk/f8yOU4f+vRc6rpW7Kex7ilFULSLE6rH5z1JT3njZNiIdLYV60u08rK3p7N5N09ETaEyh3HmmjFUIhXj1X6yPbmWnI8heBNSUYVgfToee9RFZtYjY0l7WWqFmR/lph6jleP2SnTJuQda+w/QPmApdXn5otf8wHLKN9E3+4TrvuVo5QfaiGRo5TEqEZInoCIsyMW2S70w0XnX4I+W9FSWOl5PeyXOleWBVG5qYgEJFcEA/+O336NHYfKmJh3i9FzAx8aBNStyLAioC1goWstM0UGO/KBHnrBW5L3agNSBSoeBoJClDKiAuyJ1CTlazKSSPG8MM+zt4Ghk/QgeKgoVOTZ94wgQCmpJ8ZiCMmbJcYIBbIKpY45dzbAybrngkhJAyBovNXkPnmhwIV2hzgmGu0jAOEANpAM566QnQFkzeGEc0GIhc8mBebkc5gFq1FgSJ0uA6+YuWGdaWZAHZ7LGB/BGNZEIZ6yJQk9RExV+BNeypZ44HxYUUCoqoGw4RAK5KQh2u8Y0dAEZ+QCW08ucYlAf0AVQ1JKLsxdvkgUSrGERkKjALE7ulgMFh9ovjKv7goar2bfPOsNKG3MUuBnBo37UUx6WxhMPgJJ66dNHfQmz/Zg9UOZloPm3wz6sVqtne/Dq1Oe9DFWTgSNrDn5lPIxbc+y+//NKJCKQq/3HxZRcK3PaLeFXco4jeLyTRsyjNFKNUvU79tO5A8uUkjlpT0dC9u79pzto4bvRRCRHm/83Ch7f3f5888v0huOyNvX7dzWajCZ8ZI0PNeqjVKcP/PPN3R4k/t+/HuwkJtA6jK1CGbU5struRHUmVoeXksr4wEfbbYaePjvVdXz8a0OO1XqeiBadxIyVZzbvkkGYWIWXtOH25TlZfsy0qJpe3c4eTicKf31zd3N/IxKBDRdzrInLqIm7H5xgMOnNUfhTsexr4E/W7b90+IEb94E2P+7hveWrDjuKA5pbOO+67k+/h3Ic",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={},b=[{value:"Request",id:"request",level:2}];function k(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)(i(),{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)(n.Z,{children:[(0,a.jsxs)(m.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)(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)(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)(m.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)(m.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)(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)(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)(m.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)(m.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)(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)(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)(m.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 f(e={}){const{wrapper:l}={...(0,o.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(k,{...e})}):k(e)}}}]); \ No newline at end of file diff --git a/assets/js/13fdae3b.7c32856a.js b/assets/js/13fdae3b.7c32856a.js deleted file mode 100644 index 6b45d5b6f..000000000 --- a/assets/js/13fdae3b.7c32856a.js +++ /dev/null @@ -1 +0,0 @@ -"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 deleted file mode 100644 index b08bd4e06..000000000 --- a/assets/js/1f73ca32.70560ad8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>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.e34356e0.js b/assets/js/1f73ca32.e34356e0.js new file mode 100644 index 000000000..1e69f101f --- /dev/null +++ b/assets/js/1f73ca32.e34356e0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2832],{8484:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>g});var i=a(85893),l=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),c=(a(41429),a(5397)),d=a(4667),m=a(9472),p=a(85162);const u={id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLZL33BvvnuNCkCyDSG/FdUAvxokoMOReOVLWiFRcVQhnSMCncPrhHNDITGOAuW2ALJRI/OnBzgzIPLeNISiQpNJhIBJhHXrJus4LkYoSKZpJhMfgrAkYRLoQB6MR/21bvmzyHEOYNBrWSkQicmsIDbG8dE6rPB4M7wODFiLkFdaSv2juUKTCZveYk0iE86yGVGey22an1pKBvDKlSMTE+lrS5g4+yNppFvr1TE0PDrPq+q1YJsLIGp+r4a1F+AmR4VhLpZ+Lv7eYIb5ebQxyW7MqV1nzbFeOjk9efXd4sH9wyCrubXalSD9bS4Etw3NbO2nmz0Vbhyao0kQVHiVhcUqfUvIIORgdHO7tj/ZGr672T9Kj79Pjk8FoNPpdJOKhjvns7kUUkmKeqQtrvW5c8RXsLHfFGi79DbFuvWTBo9HR0w6IPWcswcQ2pnjx/xU/em/9l2Pftb3c8FsZrQx+7Fv4Izvfh3H8NIxz00qtisgeV3aK5utGsmmeOvNPr0Z1QvFcbIW6ud8FGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxw5LqkQqhiVS03FfQN+iDxHfeC1SURG5kA6HQZoisw+Dvim0zAJ3+FA6NWz3xTLZRUjnniEdSJbKlHtfRI0fQ7zka+gyvRXoOt/SqXc4Fz0TbkklQvH1VyiLWOe8ntgIXmX3wqG5VKWJd9Pui93hc4M6tzXynKEKoRf/+8+/IqKweVOjoVg6L+Ci8eDsDD2PDGkKmGh8UJnGKCy1trP12Aooa40h6DkoQ1h6SQiFKhVJDZwVZUrIpZOZ0oqLjcVsN+k26jUM4KZCqtDz0TceQUKBLWquUdDWTlkPWZAN2TraWPkMM+unE3YpAQlZE5TBECAg9hA0lTQ5Qn8XCVgP0gAaQu+8CghS1Sw8sR5wMlG5YsXcWV7mBLU0skQ2lgD7zVlw3raqwADeZk0gCFY3MRC2WGM/zA1iEQbwi2qxC5w3u6mOBZQNq0ggtwXCqtE4DFNAhoHAsXmVY1QaSHoCjS36WHvxJieN1uAsM4CSGuxk625ZEXlpAs+NzqH+atbpc97y6yDaKOR8AHfmzlxysTQBuQC0MtOQ3pk9uF2X2Q1mQRGOv+37YTabPemDl9uYM0VVk4FHZx9xZdyMXbMJXy9eikQQ+jpcTC7RtyrHVRN+xuYwCg9XvCjzyIur1wH32OtdAHOUVjmagBssdnr24T20cDgYiWSj8/+Fw8P35z+/+e3yDetlbur6b38wGozi68IGqqXZMHXWl8rOm2+3hxePTP+f35IrziF8oKHTUkWmjmEuVix7K3qWHSeisoF4a7HIZMBrr5dL3v6jQc/cPU5EK71iDyJzJz1TMS1Pcc75zHN0zOGt1E1Hdzujaovvz95ciUTIhj3ZZMhpZMjVB2vvj8x8Q/c2dXYO8C+z+CcBP3AK3+H8x7V4d/JZwCq+XprzN14ul/8AL/4hhw==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},h=void 0,x={id:"API-docs/get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",source:"@site/docs/API-docs/get-user.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-user",permalink:"/docs/API-docs/get-user",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-user",title:"Get your account details",description:"The Get User API enables you to get your own account details.",sidebar_label:"Get your account details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/itXftkKKLbz2k0YhmZbF6QtlgJJEGCJUVDSWWJMkRx5kmMY/rZfsp+2XzIcZTm20xYLNvSLLZL33BvvnuNCkCyDSG/FdUAvxokoMOReOVLWiFRcVQhnSMCncPrhHNDITGOAuW2ALJRI/OnBzgzIPLeNISiQpNJhIBJhHXrJus4LkYoSKZpJhMfgrAkYRLoQB6MR/21bvmzyHEOYNBrWSkQicmsIDbG8dE6rPB4M7wODFiLkFdaSv2juUKTCZveYk0iE86yGVGey22an1pKBvDKlSMTE+lrS5g4+yNppFvr1TE0PDrPq+q1YJsLIGp+r4a1F+AmR4VhLpZ+Lv7eYIb5ebQxyW7MqV1nzbFeOjk9efXd4sH9wyCrubXalSD9bS4Etw3NbO2nmz0Vbhyao0kQVHiVhcUqfUvIIORgdHO7tj/ZGr672T9Kj79Pjk8FoNPpdJOKhjvns7kUUkmKeqQtrvW5c8RXsLHfFGi79DbFuvWTBo9HR0w6IPWcswcQ2pnjx/xU/em/9l2Pftb3c8FsZrQx+7Fv4Izvfh3H8NIxz00qtisgeV3aK5utGsmmeOvNPr0Z1QvFcbIW6ud8FGTBvvKK5SG8X4mFPOrXXnae34+U4ETVSZVdsxw5LqkQqhiVS03FfQN+iDxHfeC1SURG5kA6HQZoisw+Dvim0zAJ3+FA6NWz3xTLZRUjnniEdSJbKlHtfRI0fQ7zka+gyvRXoOt/SqXc4Fz0TbkklQvH1VyiLWOe8ntgIXmX3wqG5VKWJd9Pui93hc4M6tzXynKEKoRf/+8+/IqKweVOjoVg6L+Ci8eDsDD2PDGkKmGh8UJnGKCy1trP12Aooa40h6DkoQ1h6SQiFKhVJDZwVZUrIpZOZ0oqLjcVsN+k26jUM4KZCqtDz0TceQUKBLWquUdDWTlkPWZAN2TraWPkMM+unE3YpAQlZE5TBECAg9hA0lTQ5Qn8XCVgP0gAaQu+8CghS1Sw8sR5wMlG5YsXcWV7mBLU0skQ2lgD7zVlw3raqwADeZk0gCFY3MRC2WGM/zA1iEQbwi2qxC5w3u6mOBZQNq0ggtwXCqtE4DFNAhoHAsXmVY1QaSHoCjS36WHvxJieN1uAsM4CSGuxk625ZEXlpAs+NzqH+atbpc97y6yDaKOR8AHfmzlxysTQBuQC0MtOQ3pk9uF2X2Q1mQRGOv+37YTabPemDl9uYM0VVk4FHZx9xZdyMXbMJXy9eikQQ+jpcTC7RtyrHVRN+xuYwCg9XvCjzyIur1wH32OtdAHOUVjmagBssdnr24T20cDgYiWSj8/+Fw8P35z+/+e3yDetlbur6b38wGozi68IGqqXZMHXWl8rOm2+3hxePTP+f35IrziF8oKHTUkWmjmEuVix7K3qWHSeisoF4a7HIZMBrr5dL3v6jQc/cPU5EK71iDyJzJz1TMS1Pcc75zHN0zOGt1E1Hdzujaovvz95ciUTIhj3ZZMhpZMjVB2vvj8x8Q/c2dXYO8C+z+CcBP3AK3+H8x7V4d/JZwCq+XprzN14ul/8AL/4hhw==",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={},g=[{value:"Request",id:"request",level:2}];function v(e){const s={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get your account details"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,i.jsx)(s.p,{children:"The Get User API enables you to get your own account details."}),"\n",(0,i.jsx)(s.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)(s.p,{children:"Successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(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)(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:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "name": "Joe Bee",\n "email": "joebee@example.com",\n "phone": "4567832123",\n "jobTitle": "dev",\n "company": "opensign",\n "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)(s.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)(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:"User not found!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.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)(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)(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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/2304e9ae.c742feb2.js b/assets/js/2304e9ae.4e6965bb.js similarity index 51% rename from assets/js/2304e9ae.c742feb2.js rename to assets/js/2304e9ae.4e6965bb.js index f59336560..975c97c15 100644 --- a/assets/js/2304e9ae.c742feb2.js +++ b/assets/js/2304e9ae.4e6965bb.js @@ -1 +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 +"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),i=s(58219),t=(s(62316),s(51039)),n=s.n(t),d=(s(82723),s(9487)),o=(s(41429),s(5397)),m=s(4667),c=s(9472),p=s(85162);const h={id:"createfolder",title:"Create Folder",description:"The Create Folder API allows you to create folder.",sidebar_label:"Create Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJzNV9tuGzcQ/RVmXtoAa12cS9FFUdRN08BNEBu1iwCVBWN2d7RixCUZkitZEPTWL+mn9UuKIbW2Lo5RF0XQF0FLzvXMzJndFQSsPeQj+NmoihyMM6jIl07aII2GHC6nJF45wkAiiYiT81OBSpmFF0vTimBEme4n8b4HGRhLDtnAaQU5pOt0Cxk4+tSSDz+aagn5as/duTNzWZEoSJmFsOiwoUDuwAtkUBodSAe2gdYqWUaP/Y+eDa3Al1NqkP+xQ+mo4jSTtsaGONWwtAQ5mOIjlQEysI4jD5I86yXZ9yybrzpZH5zUNWQwMa7BsH1CN9hYxUKaFl2c6wwsOtIhoceAPM4WrNcZBBniQzJ6XTB2a764yy24luKBt0b7lMHxYHAIcbKxgbMSvi1L8n7SKrV88hhYHwYvHT8+XTsdFtOb44+Wkft/VOCXY43+xUyeE9va4HYS7jNzp3Q8OH52NBwcDb65HL7Mn3+bv3jZGwwGv0MGN41i3diEOVQYot2uxN1za6sv4Ge9L5ZAqyigVB4OWo+7bp3B8/sa68I0FKZS12JBOoiFM7rOhFWEnkRwS4E1Si0UBnL/YaeRc8Y9DNLjItseOKmV1HTdTdX188HgengLwotDEE71HJWsIktemhnpL5vptvuQ3B/WWCaheA87yW6fpyQ9la2TYQn5aAU3R2jlUbrPR+P1OAMG1jDLW+NjxBimkEN/j/Q9uTk5H620TkEO0xCsz/t9j7oqzE3PWNJe1lph4XulafpoZX8+hHW2r4HWPkLaB6ylro8e1BrfJXrBxUh476R7izpa+ZaWkHVobktlILkJpoRpVjLgGv96t/Fed5XaXS/bfHVIV8BFknpiYhSbYp1Z0hey1rHU8yHsL+4PpErTEG/OMCXRif/1x59RozJl25AOsROfiLPWCWsW5CatEqgrMVF0IwtF96x7T9go8l4thdSBasdruZK1DKgEw8uDVqLFQirJvctihrWd2Gp/3xMfphSm5PjqK0cCRUVzUtzyQhkzYzvBCGyDaaKPTcxiYdxswiFlAkXReqnJe+GJOhXSU9Qlia6omTBOoBakAznrpCeBsmHhiXGCJhNZSjbMg+qwDKJBjTWxs0xw3IyCTe8mXjhTtD4Ib1QbE2GPDVFIKWqiyvfET3JOKXE+TIRKlahbNpGJ0lQkNnPLaehKFOSDsOxelhSN+oAuCEVzcrGJYyV5UwtrmFAkKmEmO7VlQ8Gh9rzRUkBdaW7hs87wyo8+Klz2xJW+0syRovXEDaCknvn8Sh+J0W2bfaDCy0Djr7vBWiwWBwP1dFfnjQzTthCOrLnTq+NhHL9t9duHp5BBINf4s8kFubksaTPNn/HZj8L9Dc1iGWmWGpQqDesP+wo8TUqWpD1tkeLJm/N3Yi6e9QaQbVHIPwi4/+701ev3F6/ZLpNcmr9hb9AbxJcP40ODesvVzvv0/uCu7rbFv3v53tBUoJvQtwplpPiY0GrDzqPdV/JxBlMm73wEq1WBnn5zar3m408tOWb+cQZzdBILZp7ReJ11DMd0PqMl55SCPrpk7yyu2kSWe+uOCTppnJQl2fCg7PZ+OT+7uIQMis1nQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhTbrD6LrL75w5l1V3q5FeUu3adU+JcTu1fhO67ZW1p+fyuebj6rsMG2k+YCjtfr9d+wVLvj",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:"eJzNV9tuGzcQ/RVmXtoAa12cS9FFUdRN08BNEBu1iwCVBWN2d7RixCUZkitZEPTWL+mn9UuKIbW2Lo5RF0XQF0FLzvXMzJndFQSsPeQj+NmoihyMM6jIl07aII2GHC6nJF45wkAiiYiT81OBSpmFF0vTimBEme4n8b4HGRhLDtnAaQU5pOt0Cxk4+tSSDz+aagn5as/duTNzWZEoSJmFsOiwoUDuwAtkUBodSAe2gdYqWUaP/Y+eDa3Al1NqkP+xQ+mo4jSTtsaGONWwtAQ5mOIjlQEysI4jD5I86yXZ9yybrzpZH5zUNWQwMa7BsH1CN9hYxUKaFl2c6wwsOtIhoceAPM4WrNcZBBniQzJ6XTB2a764yy24luKBt0b7lMHxYHAIcbKxgbMSvi1L8n7SKrV88hhYHwYvHT8+XTsdFtOb44+Wkft/VOCXY43+xUyeE9va4HYS7jNzp3Q8OH52NBwcDb65HL7Mn3+bv3jZGwwGv0MGN41i3diEOVQYot2uxN1za6sv4Ge9L5ZAqyigVB4OWo+7bp3B8/sa68I0FKZS12JBOoiFM7rOhFWEnkRwS4E1Si0UBnL/YaeRc8Y9DNLjItseOKmV1HTdTdX188HgengLwotDEE71HJWsIktemhnpL5vptvuQ3B/WWCaheA87yW6fpyQ9la2TYQn5aAU3R2jlUbrPR+P1OAMG1jDLW+NjxBimkEN/j/Q9uTk5H620TkEO0xCsz/t9j7oqzE3PWNJe1lph4XulafpoZX8+hHW2r4HWPkLaB6ylro8e1BrfJXrBxUh476R7izpa+ZaWkHVobktlILkJpoRpVjLgGv96t/Fed5XaXS/bfHVIV8BFknpiYhSbYp1Z0hey1rHU8yHsL+4PpErTEG/OMCXRif/1x59RozJl25AOsROfiLPWCWsW5CatEqgrMVF0IwtF96x7T9go8l4thdSBasdruZK1DKgEw8uDVqLFQirJvctihrWd2Gp/3xMfphSm5PjqK0cCRUVzUtzyQhkzYzvBCGyDaaKPTcxiYdxswiFlAkXReqnJe+GJOhXSU9Qlia6omTBOoBakAznrpCeBsmHhiXGCJhNZSjbMg+qwDKJBjTWxs0xw3IyCTe8mXjhTtD4Ib1QbE2GPDVFIKWqiyvfET3JOKXE+TIRKlahbNpGJ0lQkNnPLaehKFOSDsOxelhSN+oAuCEVzcrGJYyV5UwtrmFAkKmEmO7VlQ8Gh9rzRUkBdaW7hs87wyo8+Klz2xJW+0syRovXEDaCknvn8Sh+J0W2bfaDCy0Djr7vBWiwWBwP1dFfnjQzTthCOrLnTq+NhHL9t9duHp5BBINf4s8kFubksaTPNn/HZj8L9Dc1iGWmWGpQqDesP+wo8TUqWpD1tkeLJm/N3Yi6e9QaQbVHIPwi4/+701ev3F6/ZLpNcmr9hb9AbxJcP40ODesvVzvv0/uCu7rbFv3v53tBUoJvQtwplpPiY0GrDzqPdV/JxBlMm73wEq1WBnn5zar3m408tOWb+cQZzdBILZp7ReJ11DMd0PqMl55SCPrpk7yyu2kSWe+uOCTppnJQl2fCg7PZ+OT+7uIQMis1nQ2Mq1nG44E8KXEAOV3AF8eMjDmV88+fzFSjUdYs1yye7TMzYMhTbrD6LrL75w5l1V3q5FeUu3adU+JcTu1fhO67ZW1p+fyuebj6rsMG2k+YCjtfr9d+wVLvj",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 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:"Create Folder"})}),"\n",(0,l.jsx)(n(),{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)(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)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.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)(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)(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:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"parentFolderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"J2nas5kiPe"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "objectId": "ph1bhx2jp",\n "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)(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)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"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)(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)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(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/28b19cd2.41c168b1.js b/assets/js/28b19cd2.41c168b1.js deleted file mode 100644 index e66782243..000000000 --- a/assets/js/28b19cd2.41c168b1.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[6033],{99442:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>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.7cf37f7d.js b/assets/js/28b19cd2.7cf37f7d.js new file mode 100644 index 000000000..28ec13a90 --- /dev/null +++ b/assets/js/28b19cd2.7cf37f7d.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:()=>x,contentTitle:()=>f,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var i=s(85893),l=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),o=(s(82723),s(9487)),m=s(41429),d=s(5397),c=s(4667),p=s(9472),h=s(85162);const u={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:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76qjfCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el976tD+Q9/I6d5cGT719BmrYf/UZR6TPQh1GNg8p1suSLFyfNXCMOYPqJIyjMbGI2CP+HZWprT9VB820F5Tb+DFx5fb2mzY10J51Ey8O/zCgSuMdk3Xvzw/5//tunKtwZVJQs5BR9w0Jr7WGXkorQKptx9lcCI0B1Su61NM0hkHhtvbSjoCo1UVpHTTOoKcnHOY8Sj+5in5+jTrZH/vDF88yct/rJPl5S0XTmlfn3DHBLTQaW/OsYfs4HdK68FpmABtUualUtWbnQEntZKaZl1CZpfn57NLzn8diQ9HU9xkbIFL0iceME1hJdOMvAsToR00nMGuqhjtadOhXupJUBmdAQM5bh7SAgOJwBlq8L+WUbLW2O+N360idDw/fVlsPWkE/14MP5yfz5KkD+LHY/dkiUqmYXO4N8+k3/wB7m6dG6r3jXo2dZ2Hom2hs2yIwnex4+3wvHHSUVJa6asAvddnWMiz5vvkYcqANie/MAziC+OCxYzBJ2K824fGm0EjqgWLtcsO0Icb1V8ShzqNzfpwx8BCjpcXoo72OY5uJC9SO4+Z1NnZq1zTreN3nJwm/jvubzF1IX8iLuo2ukOqdjFZEPKc4Xhyzn/ZLgFfuswN0PpDB7yH6LoH1weIuVfcoeIeFA+R73SIZYXYxavNCrSHv4TYxRUdUz8128Xo2GC8+Fiz63MT4tSW101BmrF1KM7lxcG0/EoqMc3AZMjRkf/7n/8KHF0thbvzBm5KC4VZkZ2XKvSnuaK1jBUdWdodYa7IOVWFFTcLC3wqM+lRQQsUIMECY6kk3zYmM80QHlxYN4KvW0x+YsPmTUtSfElBGfMcFl8DWHqTBx1dr14Z+zxnkyJAiHlD5knqiDoW0gvUCbelpuwi7q2ogXglLywPSZQ5EzPGpflcJpIFc2uxmHjIUWNGrCwCtpuj0PZlB9bE/DrhjCqDI6wxJ/KNi/yc4EbwWS6pcTyAD/IoFaWQlSwigsSkDFNC4bEbOoWYwpMHJl4mFIQ6j9aD4veKcM0a8FgqBYXhFihRMbwZ5pYFeYvaheePBvi0qenDV1jDUy7oSLEawaN+1HdcLKUjLgAl9bObPOozeOjL7CvFTnraPl2sVquDK3+6y/Oj9Isy5ncTs+XLwmFoEEP2/sepiIQnm7ub+R3ZpUy6of+CznEgHreDAZtlp7veWMgf9hm4SSuZkHY0aOOffrz9GZbwfnQuokGT+waDxz9fX335+90XlsttuLl/F6Pz0XnYqY3zOeqBqv13sfBkNHhN2bnIg2eN/z+q/YGPau088rT240Kh1AO42ozlh731QERiMnxHm0ZiwWN88iA2Gw7Yr7w88fFvJVnGANNILNFKjLmjP2xEKh3/nfbT4MVKePtLu3ScwgtPckft74as5gkbHi+aSfRM1d4jYD2to27SsmkNxVVjwNk9y9lKOIBhDBQajk9JQoV/lXaIe25v7u5FJLrdOw9vhsLiih8ZcSUm4lE8ivDmGVpveFfj841QqLMybACikcsAAUvO1BBdPAd00f7Bnh2NyS7saFzhf9mxowx/5nv4E1V/6cmbLy8ytLHtqDk/07qu/wP6UESh",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},f=void 0,j={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:"eJztWM1uG8kRfpVyX2QZI1KS7RyIIFhHNjbCLiJhpYUPEkHUzBSHLfV0z3b3kJwQc8uT5NHyJEH1/HD4I60NBHtJgIVX7Kn/qq76qjfCY+bE5EF8NkmZk/ZOTCORkkusLLw0WkzE/YLgyhJ6go4KPt1eAyplVg4qU4I3kJEmyzSaVpB20iCu4Kl0HgprljKVOgNPeaHQ00ymILXzhCmYOZSFMhgIMIiYS0VvpQa/IJgbmzNNjI7+9AGMhVhqtNUp0JJsBV7mFOzQRCkbkzTmYm/ICO5btY6lgaWCKVJVQekoDdocJKghppY7hbk1OX+2ILUnO8eEAD08vHv3meIyg1+v372bvl14X7jJeIxFMTIFaSczrTB2o8Tk45QJi3R+ykaXLvi/DWdnE4dz9KhFJEzBQZRGX6diIlpDWh9W0i+64MlURKJAizl5spzBjdCYk5iIQXxFJCRnsEC/EPtpNfETJf46BL8zRETC0m+ltJSKibclRcL5SrFYJ/NCMQGtC2VSEpM5KscEyYJyFJON8FURKL2VOhOR4LShH57QGoOUiSj+dhEvkstFEYu6njZqyfm/mrRiUYnRnrTnP7EolExCUMZPjk3fDHRuzX0QHHkOxjTqTGl85FBZjqyX5AJ7S7i1Ga3FisPlKR+evyDAGnbi0OOtf5+SxJReo/aijgTlKNWrIQoEQwFPhn5of3ElsZQmwa9pfTIEMRETFwujf4f64vI9//f+QtR1JLz04XS36AbVNLtrw8bUc6NSslylr2lgQxzpdLYfgNgYRagPivJ+IR30db3XYlxBiZxXsFqQX5ANxyvUHoJ0xyQxgeP+xNSNtSPg/pXSHEvlYYmqJJAOHgWX96MYwfU8XMnmi+EfOyYMaAF1CtrASdA3c2UojpNx+zs2aXWy5XSAllqbJaW9CYG474IOVlIptpv7UNME+vix2q56OnXHAr4bw6vSeZNDUNMyhZ7HAUFfWoL2so3gCjVInagypbbRcsC5S8Fm05XALFRGXcNmw7kkO+NCrOtoe8C6dg5C9TUnlhKSyx2u/oi2jP3ZgJXWhbTVLEXfHiQmL1BXQwNkpqXOZqVVdT06KL5tZr45bgdhajPGQv4HIsbmXOsbm5I9el976tD+Q9/I6d5cGT719BmrYf/UZR6TPQh1GNg8p1suSLFyfNXCMOYPqJIyjMbGI2CP+HZWprT9VB820F5Tb+DFx5fb2mzY10J51Ey8O/zCgSuMdk3Xvzw/5//tunKtwZVJQs5BR9w0Jr7WGXkorQKptx9lcCI0B1Su61NM0hkHhtvbSjoCo1UVpHTTOoKcnHOY8Sj+5in5+jTrZH/vDF88yct/rJPl5S0XTmlfn3DHBLTQaW/OsYfs4HdK68FpmABtUualUtWbnQEntZKaZl1CZpfn57NLzn8diQ9HU9xkbIFL0iceME1hJdOMvAsToR00nMGuqhjtadOhXupJUBmdAQM5bh7SAgOJwBlq8L+WUbLW2O+N360idDw/fVlsPWkE/14MP5yfz5KkD+LHY/dkiUqmYXO4N8+k3/wB7m6dG6r3jXo2dZ2Hom2hs2yIwnex4+3wvHHSUVJa6asAvddnWMiz5vvkYcqANie/MAziC+OCxYzBJ2K824fGm0EjqgWLtcsO0Icb1V8ShzqNzfpwx8BCjpcXoo72OY5uJC9SO4+Z1NnZq1zTreN3nJwm/jvubzF1IX8iLuo2ukOqdjFZEPKc4Xhyzn/ZLgFfuswN0PpDB7yH6LoH1weIuVfcoeIeFA+R73SIZYXYxavNCrSHv4TYxRUdUz8128Xo2GC8+Fiz63MT4tSW101BmrF1KM7lxcG0/EoqMc3AZMjRkf/7n/8KHF0thbvzBm5KC4VZkZ2XKvSnuaK1jBUdWdodYa7IOVWFFTcLC3wqM+lRQQsUIMECY6kk3zYmM80QHlxYN4KvW0x+YsPmTUtSfElBGfMcFl8DWHqTBx1dr14Z+zxnkyJAiHlD5knqiDoW0gvUCbelpuwi7q2ogXglLywPSZQ5EzPGpflcJpIFc2uxmHjIUWNGrCwCtpuj0PZlB9bE/DrhjCqDI6wxJ/KNi/yc4EbwWS6pcTyAD/IoFaWQlSwigsSkDFNC4bEbOoWYwpMHJl4mFIQ6j9aD4veKcM0a8FgqBYXhFihRMbwZ5pYFeYvaheePBvi0qenDV1jDUy7oSLEawaN+1HdcLKUjLgAl9bObPOozeOjL7CvFTnraPl2sVquDK3+6y/Oj9Isy5ncTs+XLwmFoEEP2/sepiIQnm7ub+R3ZpUy6of+CznEgHreDAZtlp7veWMgf9hm4SSuZkHY0aOOffrz9GZbwfnQuokGT+waDxz9fX335+90XlsttuLl/F6Pz0XnYqY3zOeqBqv13sfBkNHhN2bnIg2eN/z+q/YGPau088rT240Kh1AO42ozlh731QERiMnxHm0ZiwWN88iA2Gw7Yr7w88fFvJVnGANNILNFKjLmjP2xEKh3/nfbT4MVKePtLu3ScwgtPckft74as5gkbHi+aSfRM1d4jYD2to27SsmkNxVVjwNk9y9lKOIBhDBQajk9JQoV/lXaIe25v7u5FJLrdOw9vhsLiih8ZcSUm4lE8ivDmGVpveFfj841QqLMybACikcsAAUvO1BBdPAd00f7Bnh2NyS7saFzhf9mxowx/5nv4E1V/6cmbLy8ytLHtqDk/07qu/wP6UESh",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"}},x={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={a:"a",h2:"h2",p:"p",strong:"strong",...(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:"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)(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)(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)(a.p,{children:"Body"})}),(0,i.jsx)("strong",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"object[]"})}),(0,i.jsx)("span",{className:"openapi-schema__divider"}),(0,i.jsx)("span",{className:"openapi-schema__required",children:(0,i.jsx)(a.p,{children:"required"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Accoutnant"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"mail",qualifierMessage:void 0,schema:{type:"string",format:"mail",example:"joe@example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"123123131"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(a.p,{children:"]"})})})]})]})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"send_email",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"This parameter allows you to specify whether you want emails to be sent to signers. The default value is \"true\". If the value of this parameter is \"true\" and no 'email_subject'/'email_body' parameters are specified default email templates will be used.\n",example:!0}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom mail subject for signature request. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body. Can include the following {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"timeToCompleteDays",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",description:"time to complete days is used to calculate expiry date of your document",format:"number",example:15}})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(t.Z,{children:[(0,i.jsxs)(h.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Document sent successfully!"}})]})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com",\n "message": "Document sent successfully!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(a.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please setup template properly!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Please setup template properly!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(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)(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: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/2c586be5.7973af60.js b/assets/js/2c586be5.7973af60.js deleted file mode 100644 index 96a2b8115..000000000 --- a/assets/js/2c586be5.7973af60.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=s(85893),i=s(11151),r=s(58219),l=(s(62316),s(51039)),t=s.n(l),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/2c586be5.c16c326c.js b/assets/js/2c586be5.c16c326c.js new file mode 100644 index 000000000..48ee52eb5 --- /dev/null +++ b/assets/js/2c586be5.c16c326c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>j,contentTitle:()=>x,default:()=>y,frontMatter:()=>p,metadata:()=>u,toc:()=>g});var 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+sqFfmfX3nRbazRcZpT5veGO8EocXo3YKtlcsdV52QltLJ8LOR/cuuq8Y/UtqcNLfI3hLtaqxHdIwVaQZx8qYYLMIEdOdxlJkLT8Y5c3+SbqKmY0tiUpOp1sph02348tiYSYR1hLDWzPDIwe92Lysxheu4i5DZi3xcAt6zGqbYPaXpzaC1PPOpttI8IYEI5cJHV8cuJCjqcj55s/eubc3pMnK2dlnQvI2Lqb5xJdm84KY+uPcFzUPjH+GSFdzZRTbJD26wrlWzGX7vxcjW6GBFikyidL6B2O4P/517/diqgld7y/gNe1hkotUM9q37A4K3ApqOWu18UaHU7kZYHGFA0IaXHu+lkzMXd1w/B6Uh2RT0Uh6EIgMOUTML07xQzh585lfaB9CfUKC7pHoFDq0jUbKuC1VaXbIz56C6UvZ0RSAhym1JWIxoBBjEtQ5lym5PX6c5KA0sAloLSoKy0MAhclAbvWuNlMpMK9pkpazVMLJZd8jrRZ4kITkkIVewq1mlJxxqii9ilf6mxEtJ5Fl70dwktqE3WMu8QTWi4KzGBeE4oE6ABBsFNiQ2YwJV+qou1FiqZrlijwCrW7F7xHVRcFVIpuacEL8s37uiVEVnNp6HENSa+gmlZ8lVbkK7g9Mt4Mgao99PCQt00GUAh56Rtsz1oz+xmnRljswrLFYnHjjnq4vuZbYfN6Chor1a2bu0F3o/WXtx8P6QJAXZrXs7eor0Qa3YEdex464MPwdnEfAcQLgVfiq80F9I4UIkVpsPfSPP/2zfdwBY+GRyzp3cofQPDh96cvvvnh7TeEl94Nf/5Gw6PhkcslKWNLLntbbTSKbx7dXrJ631e+7yvf95Xv+8r3feX3rz657yvf95Xv+8r3feX7vvJ9X/m+r3zfV77vK9/3le/7yrcY9b6vfN9Xvu8r3/eVw76vfN9X/vl1e1dfeaj+kZ90WBVcyF4Hgy8Zn212m58nLKea8viMXV9Thvon6h2h4V9r1FSQPk/YFdeCko2uHJ3EsivVGy+RCn8vfNJ/8I72T7ytuQrGRhWeqsZ+xXOnnFth+2XvN6/fvmMJi80+pcpojeYL6pbnCzYmn5S5znonWdfEzF33YcHlvHYlUObxUrWY1zZfLzVfulJz+NGrpHLZ9Khcr0F7VugvMbZ1wV+p4vEdNn9rwf3MzgVBthGaVHi+Wq3+C/8Hi2M=",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+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+sqFfmfX3nRbazRcZpT5veGO8EocXo3YKtlcsdV52QltLJ8LOR/cuuq8Y/UtqcNLfI3hLtaqxHdIwVaQZx8qYYLMIEdOdxlJkLT8Y5c3+SbqKmY0tiUpOp1sph02348tiYSYR1hLDWzPDIwe92Lysxheu4i5DZi3xcAt6zGqbYPaXpzaC1PPOpttI8IYEI5cJHV8cuJCjqcj55s/eubc3pMnK2dlnQvI2Lqb5xJdm84KY+uPcFzUPjH+GSFdzZRTbJD26wrlWzGX7vxcjW6GBFikyidL6B2O4P/517/diqgld7y/gNe1hkotUM9q37A4K3ApqOWu18UaHU7kZYHGFA0IaXHu+lkzMXd1w/B6Uh2RT0Uh6EIgMOUTML07xQzh585lfaB9CfUKC7pHoFDq0jUbKuC1VaXbIz56C6UvZ0RSAhym1JWIxoBBjEtQ5lym5PX6c5KA0sAloLSoKy0MAhclAbvWuNlMpMK9pkpazVMLJZd8jrRZ4kITkkIVewq1mlJxxqii9ilf6mxEtJ5Fl70dwktqE3WMu8QTWi4KzGBeE4oE6ABBsFNiQ2YwJV+qou1FiqZrlijwCrW7F7xHVRcFVIpuacEL8s37uiVEVnNp6HENSa+gmlZ8lVbkK7g9Mt4Mgao99PCQt00GUAh56Rtsz1oz+xmnRljswrLFYnHjjnq4vuZbYfN6Chor1a2bu0F3o/WXtx8P6QJAXZrXs7eor0Qa3YEdex464MPwdnEfAcQLgVfiq80F9I4UIkVpsPfSPP/2zfdwBY+GRyzp3cofQPDh96cvvvnh7TeEl94Nf/5Gw6PhkcslKWNLLntbbTSKbx7dXrJ631e+7yvf95Xv+8r3feX3rz657yvf95Xv+8r3feX7vvJ9X/m+r3zfV77vK9/3le/7yrcY9b6vfN9Xvu8r3/eVw76vfN9X/vl1e1dfeaj+kZ90WBVcyF4Hgy8Zn212m58nLKea8viMXV9Thvon6h2h4V9r1FSQPk/YFdeCko2uHJ3EsivVGy+RCn8vfNJ/8I72T7ytuQrGRhWeqsZ+xXOnnFth+2XvN6/fvmMJi80+pcpojeYL6pbnCzYmn5S5znonWdfEzF33YcHlvHYlUObxUrWY1zZfLzVfulJz+NGrpHLZ9Khcr0F7VugvMbZ1wV+p4vEdNn9rwf3MzgVBthGaVHi+Wq3+C/8Hi2M=",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.6a7b09a1.js b/assets/js/377084eb.ab7168d2.js similarity index 77% rename from assets/js/377084eb.6a7b09a1.js rename to assets/js/377084eb.ab7168d2.js index bf52cbd43..af2a50c88 100644 --- a/assets/js/377084eb.6a7b09a1.js +++ b/assets/js/377084eb.ab7168d2.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(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),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),p=s(4667),d=s(9472),h=s(85162);const u={id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"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+atdeDZh2kyVO7GVmHhgu4lmngRjWWTo1X3H/uI6Rzz5AOJAtlipNHUYs7iy/5VFrHH9h91/uc+hm5+XVuHUp1I3OJMg4tDT8vbQR3zn7n0HBZjUe1mh41wQ+oM1shj9FUIvTif/77PxHRT/4xkr6Bd7UHZ9foebqVJoelxo1K9UN3kYCy0hiC3oIyhIXn+M9VoUjq2Go58zPpZKq04thjMctoD4PwDSP4UCKV6PnV3zyChBxXqDlkQVt7y/uQBVmTraKOjjOsrb9dMqUEJKR1UAYD33awh6AppckQ+rNIwHqQBtAQeudVQJCqYmG+DuFyqTLFG3OieZkRVNLIAllZAsybveC8XakcA3ib1oEgWF1HQ1hjhUitifH2MoKf1Apbw3mxvbZhDkXNWySQ2Ryhyzs2w+SQYiBwrF5lGDcNJD2BxhX6GHvxJJe11uAsFwQlNd+ehmfLG5GXJnAnbwn1R7N3n/OWLzJRRy63I/hoPhou2lAH5ADQytyG+UdzAtf7MPuAaVCEi2/7fFiv10d58OIQ81ZRWafg0dk7XBEXY9YM4fuHFyIRhL4K75aX6Fcq6yfyz+gcR+FxVyZlFstkN9Jyjv14H8AlS6sMTcBBUTt/+/4XWMHL0UQkg8z/AsLjXy7+8ebXyze8L9emNv+mo8loEodkG6iSZqBqeNe/n7e7u2L/f/BdoKtkhBsaOy1VbAfRebuulF/fzTKJmA+/CiwSUdpALLLbpTLgv7xuGl7+o0bPDWORiJX0SqZc8K53IleBf+f7G/5nPfftb93Hghfw5R8YHjSmr9WGC3W8UIi5EIm4xe29rxzNgofxtmAz21biPMvQ0QB71MAPuuDbN1ciEbKm8rBR3MZG0f3g3R/kddhBWgL8l5vZg4DvOaJ+xu0Pe/H2zWcBnX29NPto0TTNfwHUj4mq",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",source:"@site/docs/API-docs/get-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/get-template",permalink:"/docs/API-docs/get-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"get-template",title:"Get Template",description:"The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures.",sidebar_label:"Get Template",hide_title:!0,hide_table_of_contents:!0,api:"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+atdeDZh2kyVO7GVmHhgu4lmngRjWWTo1X3H/uI6Rzz5AOJAtlipNHUYs7iy/5VFrHH9h91/uc+hm5+XVuHUp1I3OJMg4tDT8vbQR3zn7n0HBZjUe1mh41wQ+oM1shj9FUIvTif/77PxHRT/4xkr6Bd7UHZ9foebqVJoelxo1K9UN3kYCy0hiC3oIyhIXn+M9VoUjq2Go58zPpZKq04thjMctoD4PwDSP4UCKV6PnV3zyChBxXqDlkQVt7y/uQBVmTraKOjjOsrb9dMqUEJKR1UAYD33awh6AppckQ+rNIwHqQBtAQeudVQJCqYmG+DuFyqTLFG3OieZkRVNLIAllZAsybveC8XakcA3ib1oEgWF1HQ1hjhUitifH2MoKf1Apbw3mxvbZhDkXNWySQ2Ryhyzs2w+SQYiBwrF5lGDcNJD2BxhX6GHvxJJe11uAsFwQlNd+ehmfLG5GXJnAnbwn1R7N3n/OWLzJRRy63I/hoPhou2lAH5ADQytyG+UdzAtf7MPuAaVCEi2/7fFiv10d58OIQ81ZRWafg0dk7XBEXY9YM4fuHFyIRhL4K75aX6Fcq6yfyz+gcR+FxVyZlFstkN9Jyjv14H8AlS6sMTcBBUTt/+/4XWMHL0UQkg8z/AsLjXy7+8ebXyze8L9emNv+mo8loEodkG6iSZqBqeNe/n7e7u2L/f/BdoKtkhBsaOy1VbAfRebuulF/fzTKJmA+/CiwSUdpALLLbpTLgv7xuGl7+o0bPDWORiJX0SqZc8K53IleBf+f7G/5nPfftb93Hghfw5R8YHjSmr9WGC3W8UIi5EIm4xe29rxzNgofxtmAz21biPMvQ0QB71MAPuuDbN1ciEbKm8rBR3MZG0f3g3R/kddhBWgL8l5vZg4DvOaJ+xu0Pe/H2zWcBnX29NPto0TTNfwHUj4mq",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)(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 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.78b7485b.js b/assets/js/38c56221.78b7485b.js new file mode 100644 index 000000000..17a222351 --- /dev/null +++ b/assets/js/38c56221.78b7485b.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:()=>x,contentTitle:()=>u,default:()=>y,frontMatter:()=>h,metadata:()=>g,toc:()=>f});var n=a(85893),i=a(11151),t=a(58219),r=(a(62316),a(51039)),l=a.n(r),o=(a(82723),a(9487)),d=(a(41429),a(5397)),c=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/2r3T9Ej0Zm9vELFDPHRs3Xp2KXPOV4DvN8ndoHLJUpT17kWh08veZs9AE/8vfQyhv1A3EvH8I5pUqE4ldQEXIX4wBykv96GNifxlSNo/S56XhIydN59xTrPjPBxgF2NJMmI2m5ny7PDYy9V+MI2E+AaVNfPenWfUdm5wsbIzWYf9mQYSwW3+P69AvzP5PObR1REqOgkfzf//xX5BjdjuXyDVy2Dhq7IVe0OiKwQtOjynQEbT0s3cP7EZXqLgLr0jHYl6pUAXWEg9wNcmwwU1pxgTHZgA4nNepn8LmiiPg72/7OESNOWpPmugRt7QPLCRawDbaOOsYBsrHuoWCTEkDIWq8Mg2RPNLKQqdDkBOPDS4DxtAHiRaBxyhOgqkegTUWhchUnkzWBt4lhb2FlSVwjOAqNs2slyYOzWesDeKvb6AhrrIlC76Ihkn4GH3kjiY5HVEwBlSYJZcsiEuAXCcPrYDeMhIw8rwO8zOTk+/UBXQBNa3Kx0GImeVxCY7nrKdS8S0xzy4LitsCDakDkQ2omK0dcQ6IOid0MeG3gRs7bEj8AxtH97rDcP7PPlHkVaPV2LP7NZvPlenTM870KVZuBo8Ye+Mp4GFvElH3/5R3XKLnaXxbX5NYqH0frV3TOI/F8mAWYhwnI44by7VMG7sta5WQ8TTr3+fdXP8Ia3s8WIpm0uV9g8PzHi+8+/XT9ieUOKyGX9GwxW0SUZ32o0UxUHW/QTyt3snX8tm//tm//n+/bw2AP9BjmjUZlJti6BzTL4x2D9+SKAU+6FNstT/C/Ob3b8fHPLTlGS6tErNEproGIlZIRFPAAfqBOpOK7voROblg9k+u2xxdPICJjmp7jPM+pCS/STjHZ1eX1jUhENvxQUFvJPA43/CMCbkQqbsWtiD84xBkRfyTg863QaMoWy4gEolzGMthyLKZA6CECoeEDezZemW5i5TFC6l3hv+zYswx/5LL5gbo/7cn7m68yDLEdqTmDq91u9x/zYRZV",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/2r3T9Ej0Zm9vELFDPHRs3Xp2KXPOV4DvN8ndoHLJUpT17kWh08veZs9AE/8vfQyhv1A3EvH8I5pUqE4ldQEXIX4wBykv96GNifxlSNo/S56XhIydN59xTrPjPBxgF2NJMmI2m5ny7PDYy9V+MI2E+AaVNfPenWfUdm5wsbIzWYf9mQYSwW3+P69AvzP5PObR1REqOgkfzf//xX5BjdjuXyDVy2Dhq7IVe0OiKwQtOjynQEbT0s3cP7EZXqLgLr0jHYl6pUAXWEg9wNcmwwU1pxgTHZgA4nNepn8LmiiPg72/7OESNOWpPmugRt7QPLCRawDbaOOsYBsrHuoWCTEkDIWq8Mg2RPNLKQqdDkBOPDS4DxtAHiRaBxyhOgqkegTUWhchUnkzWBt4lhb2FlSVwjOAqNs2slyYOzWesDeKvb6AhrrIlC76Ihkn4GH3kjiY5HVEwBlSYJZcsiEuAXCcPrYDeMhIw8rwO8zOTk+/UBXQBNa3Kx0GImeVxCY7nrKdS8S0xzy4LitsCDakDkQ2omK0dcQ6IOid0MeG3gRs7bEj8AxtH97rDcP7PPlHkVaPV2LP7NZvPlenTM870KVZuBo8Ye+Mp4GFvElH3/5R3XKLnaXxbX5NYqH0frV3TOI/F8mAWYhwnI44by7VMG7sta5WQ8TTr3+fdXP8Ia3s8WIpm0uV9g8PzHi+8+/XT9ieUOKyGX9GwxW0SUZ32o0UxUHW/QTyt3snX8tm//tm//n+/bw2AP9BjmjUZlJti6BzTL4x2D9+SKAU+6FNstT/C/Ob3b8fHPLTlGS6tErNEproGIlZIRFPAAfqBOpOK7voROblg9k+u2xxdPICJjmp7jPM+pCS/STjHZ1eX1jUhENvxQUFvJPA43/CMCbkQqbsWtiD84xBkRfyTg863QaMoWy4gEolzGMthyLKZA6CECoeEDezZemW5i5TFC6l3hv+zYswx/5LL5gbo/7cn7m68yDLEdqTmDq91u9x/zYRZV",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"}},x={},f=[{value:"Features:",id:"features",level:3},{value:"Note:",id:"note",level:3},{value:"Request",id:"request",level:2}];function j(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)(c.Z,{collapsible:!1,name:"file",required:!0,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"title",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,n.jsx)(c.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)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,n.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(c.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)(c.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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,n.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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.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)(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,n.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.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)(c.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)(d.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)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/38c56221.a09d80c4.js b/assets/js/38c56221.a09d80c4.js deleted file mode 100644 index 3df4d8606..000000000 --- a/assets/js/38c56221.a09d80c4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2403],{75548:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>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.0072a94c.js similarity index 79% rename from assets/js/451a5132.08d2a181.js rename to assets/js/451a5132.0072a94c.js index 76aaf288a..0d4c59c13 100644 --- a/assets/js/451a5132.08d2a181.js +++ b/assets/js/451a5132.0072a94c.js @@ -1 +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 +"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:()=>y,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var l=a(85893),r=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),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+nk33Bqv5VhWRC6Mh8MApsjscmAdmqBKoyELg9zWQ3BqOB9J7uuHHODcI6gDQalMefRJrsneykuOROvsA1v3DdapV8gdduvKPtV26FQIsWds+HtqI/PWwW8cmktVmhie+ejOGH+HOrc18qZBFYqO/O8//4ochc2bGg3F7Hki3jRexPWEpwuYQkw1LlWmMRKD1naxW1wCQq0xBL0SyhCWHghFoUpFoAV7hYsjBweZ0orzjcksc3vRS9kwEO8qpAo9X33jeREqcI6a01Roa2csh6yAhmwddWwxi4X1sylDSgSIrAnKYAgiIHYsaCowOYouFgmvU2AEGkLvvAooQNVMPLVe4HSqcsWCubg85CRqMFAiK0sE42YvOG/nqsAgvM2aQCJY3URDWGONSK2JBrEIA/GLmmNrOB8WSKA0FqJsWEQiclug2NYam2EKkWEg4Vi9yjEKDQSehMY5+ph7MZLTRmvhLDcBBZq3tH5sWRB5MIFHUguoC83Ofc5bXiSijgJWA/HevDfc10QTkBNAKzML4/fmSFzv0uwdZkERTr7t6mGxWNypg6eHPGeKqiYTHp3d85XxMFZNn3338VQmktDX4c30Ev1c5bgtwgd0DiPxcNsaIY+tEWtQuq2xn24zcJvSKkcTsNfITs/eXoi5eDZIZdKr/M8APLw4//nl68uXLJd7U1t/o0E6SOP+YAPVYHqqzpC6VX/b1Q5Kd73v8f/3Q2LbiQiXNHQaVGzh0fj1tv1e958Xk0RWNhCfrtcZBPzd682Gj9vtmJtyoQJkurcfP2jbvQ+NexHNcHXfI2YOummfDck9elum7hXxObTbdX9POuEPr5g2zqika8hsaMtzmufo+gruDOWDyXb28komEhp2bX8QzOIg2P7D0rsrs+rJPpwQLQD+yzbdy/AD58srXP24I29vHmTY2tdRs/snm83mH/CpKCM=",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+nk33Bqv5VhWRC6Mh8MApsjscmAdmqBKoyELg9zWQ3BqOB9J7uuHHODcI6gDQalMefRJrsneykuOROvsA1v3DdapV8gdduvKPtV26FQIsWds+HtqI/PWwW8cmktVmhie+ejOGH+HOrc18qZBFYqO/O8//4ochc2bGg3F7Hki3jRexPWEpwuYQkw1LlWmMRKD1naxW1wCQq0xBL0SyhCWHghFoUpFoAV7hYsjBweZ0orzjcksc3vRS9kwEO8qpAo9X33jeREqcI6a01Roa2csh6yAhmwddWwxi4X1sylDSgSIrAnKYAgiIHYsaCowOYouFgmvU2AEGkLvvAooQNVMPLVe4HSqcsWCubg85CRqMFAiK0sE42YvOG/nqsAgvM2aQCJY3URDWGONSK2JBrEIA/GLmmNrOB8WSKA0FqJsWEQiclug2NYam2EKkWEg4Vi9yjEKDQSehMY5+ph7MZLTRmvhLDcBBZq3tH5sWRB5MIFHUguoC83Ofc5bXiSijgJWA/HevDfc10QTkBNAKzML4/fmSFzv0uwdZkERTr7t6mGxWNypg6eHPGeKqiYTHp3d85XxMFZNn3338VQmktDX4c30Ev1c5bgtwgd0DiPxcNsaIY+tEWtQuq2xn24zcJvSKkcTsNfITs/eXoi5eDZIZdKr/M8APLw4//nl68uXLJd7U1t/o0E6SOP+YAPVYHqqzpC6VX/b1Q5Kd73v8f/3Q2LbiQiXNHQaVGzh0fj1tv1e958Xk0RWNhCfrtcZBPzd682Gj9vtmJtyoQJkurcfP2jbvQ+NexHNcHXfI2YOummfDck9elum7hXxObTbdX9POuEPr5g2zqika8hsaMtzmufo+gruDOWDyXb28komEhp2bX8QzOIg2P7D0rsrs+rJPpwQLQD+yzbdy/AD58srXP24I29vHmTY2tdRs/snm83mH/CpKCM=",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 v(e){const s={h2:"h2",p:"p",...(0,r.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get folder list"})}),"\n",(0,l.jsx)(n(),{method:"get",path:"/folderlist"}),"\n",(0,l.jsx)(s.p,{children:"The Folder List API empowers you to retrieve a list of folder with or without parentFolderId"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(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)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(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 y(e={}){const{wrapper:s}={...(0,r.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/52d5c0f9.34673f6d.js b/assets/js/52d5c0f9.7cfe3494.js similarity index 54% rename from assets/js/52d5c0f9.34673f6d.js rename to assets/js/52d5c0f9.7cfe3494.js index fb618e80e..c4c29b80c 100644 --- a/assets/js/52d5c0f9.34673f6d.js +++ b/assets/js/52d5c0f9.7cfe3494.js @@ -1 +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 +"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:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=a(85893),t=a(11151),n=a(58219),i=(a(62316),a(51039)),d=a.n(i),r=(a(82723),a(9487)),o=a(41429),c=a(5397),m=a(4667),p=a(9472),h=a(85162);const u={id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6mRIAlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9dASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDkd87MZUpgZh8pCVcpmGxrUDDQqhORcPSpko5SEQdXUSR8WClW5GVpFQNoaZVJScQZKs+ApKASRbwWYWUbZHBS5yISmXElhuEJLbG5JRa2OJkVJ+hTUddT1uqt0Z4833MymfDfrgN9OjpLU/BVkpD3WaXU6omIRGJ04EjFa4HWKpk0sRx/9Cy+3jezjQQH1nHkg2yV9wE65NDW/F+WbLz9zZ6KOupzdR4eFzqZnJweHU+OJt/fHL+Iz36In78YTSaTP0UklqVi2T6pGIjvDTKo7Xu9B2tzNgR2JzWDzw6F8dqUFAqpc1hwMBfO6DwCqwg9QXArwBylBoWB3H8YVXLOuMej83WW1QOvpVZS011fQ3dnk8nd8SYIZ4/UkjYBMlPp9Nu6ekj/4w6d3Z1uHHq+79CVnqOSaUNCN+ae9Lf1Z6g+tOr3q1W2oOa72HF2eN466SmpnAyrhumWR2jlUfs9vp0yXXClmC1LNuwYChGLcc9p4/WAGWvBV7p5z52VUyIWRQjWx+OxR53OzHJkLGkvc61w5keJKcdo5Xh+LOrooQRa+xVoHzCXOj96VGq6dfqaE9PGfsf1TQbQyle0ElEf2SGqmwEFYUquyYLUmWmEu3i/taSvZa6bbM2P9ybFe1KJKYmHQigIevg/f/3dSPRhbYrpCbytHFizIJdVClCnkClaypmiAwPRE5aKvFcrkDpQ7pAHqMxlQAUcFW7+BC3OpJJcfgwz7aQcVLAfwfuCQkGOP33nCBBSmpPiqgVlzD3fEwxgFUyJwyG9MO4+Y5MiQJhVXmryHjxRL0K6QJ0Q9LmIwDhADaQDOeukJ0BZMjgzDijLZCL5Yu41h0mAEjXmxMoiYLs5CradvR6cmVU+gDeqahxhjSVRaF3URKkfwYWcU+t4syFQQKkohbziKyJITErQtR67oVOYkQ9gWb1MqLnUB3QBFM3JNbXXZJInJVjDnCBR8QIwzC1fFBxqz1O720661GzCZ53hkdvoSHE1gg/6g2behsoTF4CS+t7HH/QR3G7K7D3NvAw0fdr3w2Kx2OuDZ7syL2Uoqhk4smYrlzeHTdcMxTcvz0QkArnSv82uyc1lQl0TfkbnuAGPO6bEpGFKKlGqtsd+fijArKVkQtrTgNfOX757DXM4HU1ENOj8LzB4/Prq18s315d8L3NT23/Ho8lowkfW+FCiHqjqds6L7VK407rrLeX/TytqR0CBlmFsFcqGyBuf1x0D34rByhoPt9NpJArjA0PW6xl6+sOpuubjTxU5pvppJOboJM6Yp27XIpWen9PNqvlZb5/+3m2tz+CLF92DvvQMq5le56gqfhORuKfVg2W7ntZRT7NsbIs4TxKyYSC7N3l3xtfF5evLm0sRCaw4eEOGv28YvntgBQdN26X+1gb+5Sl0UOBHLoJXtPppA2+/fFagc7FHc5imdV3/C4jaltA=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",source:"@site/docs/API-docs/deletedocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletedocument",permalink:"/docs/API-docs/deletedocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletedocument",title:"Delete Document",description:"The Delete document API allows you to remove specific document from your documents.",sidebar_label:"Delete Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vttu20YQ/ZXJvjQBaEm+JEWJoqhbG6mRIAlqFwHqCMaIHJIbL3c3u0tdIPCtX9JP65cUw4tEWYqRAG1eJHJ5Zud+ZtYiYO5FfCsuTFKVpIMX00ik5BMnbZBGi1jcFAQXpCgQpB0Kzt9dASplFh5WpoJgwFFp5gTeUiIzmWyhmTMlg9zmyI9EJIwlh6zhKhWxSJv7e4CIhEWHJQVybN1aaCyJYR3gTqYiEpKtsxgK8dDkd87MZUpgZh8pCVcpmGxrUDDQqhORcPSpko5SEQdXUSR8WClW5GVpFQNoaZVJScQZKs+ApKASRbwWYWUbZHBS5yISmXElhuEJLbG5JRa2OJkVJ+hTUddT1uqt0Z4833MymfDfrgN9OjpLU/BVkpD3WaXU6omIRGJ04EjFa4HWKpk0sRx/9Cy+3jezjQQH1nHkg2yV9wE65NDW/F+WbLz9zZ6KOupzdR4eFzqZnJweHU+OJt/fHL+Iz36In78YTSaTP0UklqVi2T6pGIjvDTKo7Xu9B2tzNgR2JzWDzw6F8dqUFAqpc1hwMBfO6DwCqwg9QXArwBylBoWB3H8YVXLOuMej83WW1QOvpVZS011fQ3dnk8nd8SYIZ4/UkjYBMlPp9Nu6ekj/4w6d3Z1uHHq+79CVnqOSaUNCN+ae9Lf1Z6g+tOr3q1W2oOa72HF2eN466SmpnAyrhumWR2jlUfs9vp0yXXClmC1LNuwYChGLcc9p4/WAGWvBV7p5z52VUyIWRQjWx+OxR53OzHJkLGkvc61w5keJKcdo5Xh+LOrooQRa+xVoHzCXOj96VGq6dfqaE9PGfsf1TQbQyle0ElEf2SGqmwEFYUquyYLUmWmEu3i/taSvZa6bbM2P9ybFe1KJKYmHQigIevg/f/3dSPRhbYrpCbytHFizIJdVClCnkClaypmiAwPRE5aKvFcrkDpQ7pAHqMxlQAUcFW7+BC3OpJJcfgwz7aQcVLAfwfuCQkGOP33nCBBSmpPiqgVlzD3fEwxgFUyJwyG9MO4+Y5MiQJhVXmryHjxRL0K6QJ0Q9LmIwDhADaQDOeukJ0BZMjgzDijLZCL5Yu41h0mAEjXmxMoiYLs5CradvR6cmVU+gDeqahxhjSVRaF3URKkfwYWcU+t4syFQQKkohbziKyJITErQtR67oVOYkQ9gWb1MqLnUB3QBFM3JNbXXZJInJVjDnCBR8QIwzC1fFBxqz1O720661GzCZ53hkdvoSHE1gg/6g2behsoTF4CS+t7HH/QR3G7K7D3NvAw0fdr3w2Kx2OuDZ7syL2Uoqhk4smYrlzeHTdcMxTcvz0QkArnSv82uyc1lQl0TfkbnuAGPO6bEpGFKKlGqtsd+fijArKVkQtrTgNfOX757DXM4HU1ENOj8LzB4/Prq18s315d8L3NT23/Ho8lowkfW+FCiHqjqds6L7VK407rrLeX/TytqR0CBlmFsFcqGyBuf1x0D34rByhoPt9NpJArjA0PW6xl6+sOpuubjTxU5pvppJOboJM6Yp27XIpWen9PNqvlZb5/+3m2tz+CLF92DvvQMq5le56gqfhORuKfVg2W7ntZRT7NsbIs4TxKyYSC7N3l3xtfF5evLm0sRCaw4eEOGv28YvntgBQdN26X+1gb+5Sl0UOBHLoJXtPppA2+/fFagc7FHc5imdV3/C4jaltA=",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)(d(),{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)(o.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)(h.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)(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)(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)(h.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)(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)(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)(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)(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)(s.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)(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)(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)(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)(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)(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 b(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.9bf52b52.js similarity index 73% rename from assets/js/5a2de241.4ca525ce.js rename to assets/js/5a2de241.9bf52b52.js index 2c9bb48e0..00615cbb0 100644 --- a/assets/js/5a2de241.4ca525ce.js +++ b/assets/js/5a2de241.9bf52b52.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>y,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),d=s.n(n),r=(s(82723),s(9487)),m=s(41429),p=s(5397),o=s(4667),c=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/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HHnWRmauRsaR5gyrM/Cg31RitHC/2RZPsaqC13yDtA86knu3dqTXdIj7hqrSJv4Z7k3608jWtRNKndSjVsf2csCAXS8DFfrdl1hd9yTZV2aWjno2+jmB2rxS3UsaQMQRXXurSRERdB7y1pE/YOPfPYv+G1Q+kclMRsz3fVnrxv/74M2r00cT2vgdvawfWLMmVtYpxl4quZKbaixkqZZabe5knrBR5r1YgdaCZi7HLmQyoIl6pZ5CjxUwqyQPBYoa1HQxmyo/gw5zCnBx/+sERIBS0IMVzBMqYS7YTDGAdTBV9dDHD0rjLkkNKACGrvdTkPXiiXoX0HHVO0DdIAsYBaiAdyFknPQHKioVL44DKUuaSDfP0O8wDVKhxRuwsAY6bs9AtWg/OZLUP4I2qI5B4WSUKLcR4ExzBc7mgFjgftrdWKmBWs4kEclMQdMuAYegCMvIBLLuXOUWjPqDje9mCXByIWEkmb7CGt5RExbfRYW3ZUHCoPa/SNqC+NJv0WWf4FhB9FLgawbk+1yfcLLUnbgAl9aVPz/UenG3a7ANlXgaa3u+HdLlc3hjOB9d1XsowrzNwZM1WbxYP4ygP1Tf/8FUzkKv82/KE3ELm1G2Gz/gcR+Fxt7sxj7ubKpSqHfxfdhV4mpTMSfvhTD99efwGFvBwNBHJYB19RcDjN0fPXvx28oLt8sJs529/NBlN+MgaHyrUA1c7b5/d0V1vSejffip16zHQVRhbhTJyTAS/7vjhTAy2XDp8JU0TMTc+sMh6naGn9041DR9/qskxC00TsUAnOdJIIoX0/LvYvHY+C/v+u/7dAd/24LoVUE8CmhlggaqOV+1EXNJq5+XXTJukZwKOuJV41sa1d8p2thZu3A+YyFqNp3lONtwpOyTk4/enIhFZ94qr4oNQOFzyCxKXIhXn4lzEl23cNywUz9dCoZ7VOGP51izzF9ZcuSH5XUby634wsFtTcp0VWyT8l3HdqvATt+JrWv28EW+/fFahS20vzeWZNk3zNzFrpuc=",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/C6ugR2etyA95bWTYRVp7WoPrdxrv6dnUyaLisLcMCXaOgbM9JaKcb9dxuvBnmkE23OLniVrp0Qq5iFYn47HHnWRmauRsaR5gyrM/Cg31RitHC/2RZPsaqC13yDtA86knu3dqTXdIj7hqrSJv4Z7k3608jWtRNKndSjVsf2csCAXS8DFfrdl1hd9yTZV2aWjno2+jmB2rxS3UsaQMQRXXurSRERdB7y1pE/YOPfPYv+G1Q+kclMRsz3fVnrxv/74M2r00cT2vgdvawfWLMmVtYpxl4quZKbaixkqZZabe5knrBR5r1YgdaCZi7HLmQyoIl6pZ5CjxUwqyQPBYoa1HQxmyo/gw5zCnBx/+sERIBS0IMVzBMqYS7YTDGAdTBV9dDHD0rjLkkNKACGrvdTkPXiiXoX0HHVO0DdIAsYBaiAdyFknPQHKioVL44DKUuaSDfP0O8wDVKhxRuwsAY6bs9AtWg/OZLUP4I2qI5B4WSUKLcR4ExzBc7mgFjgftrdWKmBWs4kEclMQdMuAYegCMvIBLLuXOUWjPqDje9mCXByIWEkmb7CGt5RExbfRYW3ZUHCoPa/SNqC+NJv0WWf4FhB9FLgawbk+1yfcLLUnbgAl9aVPz/UenG3a7ANlXgaa3u+HdLlc3hjOB9d1XsowrzNwZM1WbxYP4ygP1Tf/8FUzkKv82/KE3ELm1G2Gz/gcR+Fxt7sxj7ubKpSqHfxfdhV4mpTMSfvhTD99efwGFvBwNBHJYB19RcDjN0fPXvx28oLt8sJs529/NBlN+MgaHyrUA1c7b5/d0V1vSejffip16zHQVRhbhTJyTAS/7vjhTAy2XDp8JU0TMTc+sMh6naGn9041DR9/qskxC00TsUAnOdJIIoX0/LvYvHY+C/v+u/7dAd/24LoVUE8CmhlggaqOV+1EXNJq5+XXTJukZwKOuJV41sa1d8p2thZu3A+YyFqNp3lONtwpOyTk4/enIhFZ94qr4oNQOFzyCxKXIhXn4lzEl23cNywUz9dCoZ7VOGP51izzF9ZcuSH5XUby634wsFtTcp0VWyT8l3HdqvATt+JrWv28EW+/fFahS20vzeWZNk3zNzFrpuc=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},f={},g=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(a.p,{children:"Update Template"})}),"\n",(0,l.jsx)(d(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Path Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(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)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(0,l.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function 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/5c04ee3b.ab27f80c.js b/assets/js/5c04ee3b.5ef75d8a.js similarity index 59% rename from assets/js/5c04ee3b.ab27f80c.js rename to assets/js/5c04ee3b.5ef75d8a.js index 2d33b0ee2..461279d8a 100644 --- a/assets/js/5c04ee3b.ab27f80c.js +++ b/assets/js/5c04ee3b.5ef75d8a.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>u,contentTitle:()=>x,default:()=>g,frontMatter:()=>p,metadata:()=>j,toc:()=>f});var l=a(85893),o=a(11151),i=a(58219),t=(a(62316),a(51039)),n=a.n(t),r=(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:"eJy9Vm1v2zYQ/itXftkKKLbTtRhgDEOLLQiCFmsBp8gHxwhO0kliTZEcSfkFhr7tl+yn7ZcMR0mO7KzBNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3PLvz3M8R4eIHGm+e0rjRG1QyjzNxa9ak/18m4/ShS8+l7mrFOI11Ryk6xXNxQnVs70h6yhonw17Mlwexu0ArL7rz+XLVrhJRU6hMP9NcMIZKzMV0exxvT25Dzkc878LjLHnUeWp2E2NJe1lqhannOZqildPNpWiTcwRa+w+8fcBS6vLiWdTqkeKCr6Hr9AnRY7/Ryve0F8nQx7FXIiRff0WYk4s9l7owEdx396MlvZCljnezuRTnqnJHKjM1sX6EimBw/+O33yMiN1lTkw5xdF7Ax8aBNVtyrAqocygU7WSq6FGN/CBHnrBW5L3ag9SBSoeBIJelDKiAuyJ1CRlaTKWSPGzsZhjtYDSvfgJ3FYWKHB994wgQctqQ4hkFZcya4wQD2ARTxxx9zbA1bl1wSQkgpI2XmrwHTzRASFeoM4LhLhIwDlAD6UDOOukJUNbsXBgHVBQykxyYN8thFqBGjSVxsgS4bu6CdWYjc/LgTNr4AN6oJhLhjDVR6ChqotxP4Ge5oY44G3MKKBXlUDYcIoHM5AT9ojENnUNKPoDl9DKjGNQHdAEUbcjF2Ys3WTRKgTWsABIVmOLkbjlQcKh9YVzdFTRczbF91hl+AGKOHPcTuNf3esHD0njiAVBSr/38Xl/A8jhmd5R6GWj17bAP2+32yR68PMVcy1A1KTiy5hFXRmPcmjH8+MdLkYhArvYfiwW5jcyGB+MrOafRedrrImZRF6lGqbode3sOYI1SMiPtaaRi764/fYANfDeZiWS0+X+j4OmHm5+ufllccVzWpm7/LiezyYxN1vhQox6lGj3252t7eBT3f/N/Qa8sgXZhahXKqMeRzKHX0uXxgV4lojI+sOlwSNHTZ6fals2/NuRYoVeJ2KCTmLLgLFdtMugRi++a9ty1LCPLSr1B1XSidvYgnaj69dWtSAQ2XMlYB9dRB/sfHH040vtR7FOB7ArgT9bqvwT8wC17T/sfj+7dyVcBPb/Bm/u3atv2T/B/a9U=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/get-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+yn7ZcMR0mO7KzBNgz7YjvHe+7uOd49zEEELL2YL8UdpZUxa7FKRE4+c9IGabSYi9uK4JoC9A7w7tMNoFJmC3vTQDBQUoBtf9g4JRJhLDlk+E0u5qKkMARPhCNvjfbkxfwgXs1m/HWab9FkGXlfNAqOcUQiMqMD6cD+aK2SWTyYfvEMOgifVVQj/wp7S2IuTPqFsiASYR2HCbJL2Rc6cvTBSV2KRNAOa6vYVIVg/Xw63ZvGXfSIi8apt73LJDO1aNtEBBkiQGolNT0M5B5ezWYP34u2ZZ/Xs9dPSX725ECbAIVpdP7iv+NHzhn3PLvz3M8R4eIHGm+e0rjRG1QyjzNxa9ak/18m4/ShS8+l7mrFOI11Ryk6xXNxQnVs70h6yhonw17Mlwexu0ArL7rz+XLVrhJRU6hMP9NcMIZKzMV0exxvT25Dzkc878LjLHnUeWp2E2NJe1lqhannOZqildPNpWiTcwRa+w+8fcBS6vLiWdTqkeKCr6Hr9AnRY7/Ryve0F8nQx7FXIiRff0WYk4s9l7owEdx396MlvZCljnezuRTnqnJHKjM1sX6EimBw/+O33yMiN1lTkw5xdF7Ax8aBNVtyrAqocygU7WSq6FGN/CBHnrBW5L3ag9SBSoeBIJelDKiAuyJ1CRlaTKWSPGzsZhjtYDSvfgJ3FYWKHB994wgQctqQ4hkFZcya4wQD2ARTxxx9zbA1bl1wSQkgpI2XmrwHTzRASFeoM4LhLhIwDlAD6UDOOukJUNbsXBgHVBQykxyYN8thFqBGjSVxsgS4bu6CdWYjc/LgTNr4AN6oJhLhjDVR6ChqotxP4Ge5oY44G3MKKBXlUDYcIoHM5AT9ojENnUNKPoDl9DKjGNQHdAEUbcjF2Ys3WTRKgTWsABIVmOLkbjlQcKh9YVzdFTRczbF91hl+AGKOHPcTuNf3esHD0njiAVBSr/38Xl/A8jhmd5R6GWj17bAP2+32yR68PMVcy1A1KTiy5hFXRmPcmjH8+MdLkYhArvYfiwW5jcyGB+MrOafRedrrImZRF6lGqbode3sOYI1SMiPtaaRi764/fYANfDeZiWS0+X+j4OmHm5+ufllccVzWpm7/LiezyYxN1vhQox6lGj3252t7eBT3f/N/Qa8sgXZhahXKqMeRzKHX0uXxgV4lojI+sOlwSNHTZ6fals2/NuRYoVeJ2KCTmLLgLFdtMugRi++a9ty1LCPLSr1B1XSidvYgnaj69dWtSAQ2XMlYB9dRB/sfHH040vtR7FOB7ArgT9bqvwT8wC17T/sfj+7dyVcBPb/Bm/u3atv2T/B/a9U=",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"}},u={},f=[{value:"Request",id:"request",level:2}];function b(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)(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)(r.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)(r.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)(r.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 g(e={}){const{wrapper:s}={...(0,o.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.5bd0eb92.js b/assets/js/5ce9853b.5bd0eb92.js new file mode 100644 index 000000000..d47ec8276 --- /dev/null +++ b/assets/js/5ce9853b.5bd0eb92.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,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)),c=a(4667),m=a(9472),p=a(85162);const h={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT52VRFEmdIDAS1EGcIg+2IFC7oxVjLsnwogsW+9Yv6af1S4rhXrSyFCdp0fahL4ZMzu0MZ87MVszzwrH0hr3QWShRecdmCcvRZVYYL7RiKXuHDlUOFj8FdB5KLiR4DcGhhaW24EShhCogb02MbxVLmDZoOVm4zHsbrQmywBLW/vezzncsrVimlUfl6Sc3Roosak8+OgqiYi5bYcnpF+kJizmF3fmci5wlDKPlWcL8ziBLmV58xMyzhBlL4XiBjgwMldKqE3beClWQlS0vjaQjY/Va5NgjA5GzunNzQvMwb512TFTM2tLqMqYLraMUWhwdpbbJ3j4G0n7W/jvOdNkHMHehgffFQC6C861j7oPF3l+0A60dEAo8bv1k5UtJD1tyP4YLrkCoTIYcYaml1Bt66jW3gi8kOoCq6tPphZdY11BVhArtXPES6zrZH5C/gwOz0qoVsZihWB9o9Ue4V+zPBqq4NcLu5jn37UGmS8PVbhhAU6TzYGVdjw8yvM/ooi3Fv5VOMvI/zmWdsBg7S5mNTb/PbE2X++71NmA8cEYr17Tmk+k0duhBwlny9eTwcOdbdEGe7JjmjU7TQNMl1P8uZBk6twxS7sYHWIWSQuG8AzN/Mp3Oz6YEuU7Y+T+LCq3V9ltBXesS/YoKcEPINlar4mFI59Pp/EmP6PwY0WhPlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjgULLnHlz1bRVq2hiUUWyaogUpHAe9N5L5M//MrMnkqDtPZRfyvT5/KzP9NPjTF+qNZcih+dvL+G9vkP16F/AvEc4dO8b9xTqtoxTkYgigopC8Z4dgB2eNyAdZsEKv2PpTcW2I27EqLlPb2b1LGFUqpr2CKNdjJj7FUvZZM8wjIzYNVoXbQQrWcpW3huXTiaOq3yht2NtUFHVSL5wNEsn3IjJ+ozVyX0Nbsw3SDvPC6GK0YNasz3Ma3qKJtsHYPuccyNe444lXS6HUgkTVAIr5DnamHd64Xf7Zepl9073Np2T60y/zRwvGkd7BmOHgzJOTqGWOkbePu+VQXUtChWLY312ND0/oMx0ibT++BVCJ/7Hb79HjS62WLuP4CpYMHqDdhkkcJXDUuJWLCRGYU4z1MFOBzLnkJcSnZM0fj0WlnuEXBTCc9kvqRk3fCGkoGonMU3aFgYN48bwYYV+hZauvrMIHHJco6QmAan1HdnxGnjwuow+unxutL1bUkgJcFgEJxQ6Bw6xU0G14ipD6AohIWbgClB5tMYKh8BFScK0WONyKTJBhqm1Lc9oQ1S8QHKWAMVNWWif1YHVi+A8OC1DBEIeS0TfQFSIuRvDC7HGBjgd5ui5kJhDEchEApnOEdoqIBgqhwXtNobciwyjUee59SBxjTYWfnxJGopgNFGQ4JIYefi2ZMhbrhwxZxNQ9zR9+ozVNF2jj5zvxnCrbhXNKSJPKgAp1J1LaWbc9GX2ARdOeJx93zXjZrM5asLHhzqvhF+FBVg0eq9XxMPYskP1/p/HLGEebemultdo1yLDlgE+43MShSctMfNmUe+ajRvx7L4CdZMUGSqHAxp9/urtG1jDD+MpSwa08xUBT95cXrz85fol2SVibPrvbDwdT+mIqLTkauDqxIfe/fYdfKb9xe/CluHidmwkF3E2RFxVS+s3g8WRPuZWxPnpDauqBXf4Ky2ddPwpoKWBMUtYt0LHcZF01Ehz4A6Jpy6amEfvyTeJy9Cw7L0pSczeaDzPMjT+QdnhWHp7df2eJaz7fih1HvdfvqHPXL5hKbtltyx+FcfOjLsonVdMclUEXpB8Y5cYnQdKxHAc3MVx0P4gZN2V2g2iPJwTDRT6S8BOKvxIBPIadz/14s3NZxXa3HbS9Hyzuq7/BNpxzI0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT52VRFEmdIDAS1EGcIg+2IFC7oxVjLsnwogsW+9Yv6af1S4rhXrSyFCdp0fahL4ZMzu0MZ87MVszzwrH0hr3QWShRecdmCcvRZVYYL7RiKXuHDlUOFj8FdB5KLiR4DcGhhaW24EShhCogb02MbxVLmDZoOVm4zHsbrQmywBLW/vezzncsrVimlUfl6Sc3Roosak8+OgqiYi5bYcnpF+kJizmF3fmci5wlDKPlWcL8ziBLmV58xMyzhBlL4XiBjgwMldKqE3beClWQlS0vjaQjY/Va5NgjA5GzunNzQvMwb512TFTM2tLqMqYLraMUWhwdpbbJ3j4G0n7W/jvOdNkHMHehgffFQC6C861j7oPF3l+0A60dEAo8bv1k5UtJD1tyP4YLrkCoTIYcYaml1Bt66jW3gi8kOoCq6tPphZdY11BVhArtXPES6zrZH5C/gwOz0qoVsZihWB9o9Ue4V+zPBqq4NcLu5jn37UGmS8PVbhhAU6TzYGVdjw8yvM/ooi3Fv5VOMvI/zmWdsBg7S5mNTb/PbE2X++71NmA8cEYr17Tmk+k0duhBwlny9eTwcOdbdEGe7JjmjU7TQNMl1P8uZBk6twxS7sYHWIWSQuG8AzN/Mp3Oz6YEuU7Y+T+LCq3V9ltBXesS/YoKcEPINlar4mFI59Pp/EmP6PwY0WhPlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjgULLnHlz1bRVq2hiUUWyaogUpHAe9N5L5M//MrMnkqDtPZRfyvT5/KzP9NPjTF+qNZcih+dvL+G9vkP16F/AvEc4dO8b9xTqtoxTkYgigopC8Z4dgB2eNyAdZsEKv2PpTcW2I27EqLlPb2b1LGFUqpr2CKNdjJj7FUvZZM8wjIzYNVoXbQQrWcpW3huXTiaOq3yht2NtUFHVSL5wNEsn3IjJ+ozVyX0Nbsw3SDvPC6GK0YNasz3Ma3qKJtsHYPuccyNe444lXS6HUgkTVAIr5DnamHd64Xf7Zepl9073Np2T60y/zRwvGkd7BmOHgzJOTqGWOkbePu+VQXUtChWLY312ND0/oMx0ibT++BVCJ/7Hb79HjS62WLuP4CpYMHqDdhkkcJXDUuJWLCRGYU4z1MFOBzLnkJcSnZM0fj0WlnuEXBTCc9kvqRk3fCGkoGonMU3aFgYN48bwYYV+hZauvrMIHHJco6QmAan1HdnxGnjwuow+unxutL1bUkgJcFgEJxQ6Bw6xU0G14ipD6AohIWbgClB5tMYKh8BFScK0WONyKTJBhqm1Lc9oQ1S8QHKWAMVNWWif1YHVi+A8OC1DBEIeS0TfQFSIuRvDC7HGBjgd5ui5kJhDEchEApnOEdoqIBgqhwXtNobciwyjUee59SBxjTYWfnxJGopgNFGQ4JIYefi2ZMhbrhwxZxNQ9zR9+ozVNF2jj5zvxnCrbhXNKSJPKgAp1J1LaWbc9GX2ARdOeJx93zXjZrM5asLHhzqvhF+FBVg0eq9XxMPYskP1/p/HLGEebemultdo1yLDlgE+43MShSctMfNmUe+ajRvx7L4CdZMUGSqHAxp9/urtG1jDD+MpSwa08xUBT95cXrz85fol2SVibPrvbDwdT+mIqLTkauDqxIfe/fYdfKb9xe/CluHidmwkF3E2RFxVS+s3g8WRPuZWxPnpDauqBXf4Ky2ddPwpoKWBMUtYt0LHcZF01Ehz4A6Jpy6amEfvyTeJy9Cw7L0pSczeaDzPMjT+QdnhWHp7df2eJaz7fih1HvdfvqHPXL5hKbtltyx+FcfOjLsonVdMclUEXpB8Y5cYnQdKxHAc3MVx0P4gZN2V2g2iPJwTDRT6S8BOKvxIBPIadz/14s3NZxXa3HbS9Hyzuq7/BNpxzI0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Create Template",permalink:"/docs/API-docs/createtemplate"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",li:"li",p:"p",ul:"ul",...(0,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)(c.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,l.jsx)(c.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)(c.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)(c.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)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"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)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",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)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",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)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/5ce9853b.d72b2598.js b/assets/js/5ce9853b.d72b2598.js deleted file mode 100644 index f92ea70b1..000000000 --- a/assets/js/5ce9853b.d72b2598.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:()=>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.604707fe.js similarity index 58% rename from assets/js/70853c19.6ace34db.js rename to assets/js/70853c19.604707fe.js index 9f374ac68..8c870e0bd 100644 --- a/assets/js/70853c19.6ace34db.js +++ b/assets/js/70853c19.604707fe.js @@ -1 +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 +"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:()=>v,frontMatter:()=>m,metadata:()=>u,toc:()=>g});var a=n(85893),l=n(11151),i=n(58219),r=(n(62316),n(51039)),d=n.n(r),o=(n(82723),n(9487)),t=(n(41429),n(5397)),c=n(4667),h=n(9472),p=n(85162);const m={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/QSrCU5dYFCKIq6iZAKjS+IbPjBEhxqd7TLmktuSa5kQdBbv6Sf1i8phtyVVrKjJIjrooD8YEvkGXLOcDgkjxfM8dSy7jW7wnGm9S0bRSxBGxtROKEV67KLDMHyKYI2UBYJdwgVFo7P+8Cl1DOY6xKcDrhZ1VsaCbNMxBkIC6XFhBDOiDRFAzhF5exQPX/+vPrcHaqhOmzBixdTgTNMui9eDBUAwAFcZajAilShgdAJiY7LHJUDlwkbRoCZkLKeoBVs379/Hz4swh/6GTIPH7IuDFkYbsiiZv9ESAzdr89eXZ70Ti9uLt+93QIpnm+DTo9Petso7SrUuURuEQzSlMBV4hkF/2s2W8aNhQhjbPWHkFjqu163b5Dd9nXQf3Pae3ff0yowORdyA9g7Oe6/fQBZZFptDnn+69lpb8iawOX6y2jD8RD1X+YfmaoGHleLddE/6Q0ujk/Ot1CxQe4ehNWo5VC9pNSqkNu5tcomYaGCfGliVcPsM+tpM+uTUsFD1XeUEJ7oznwICBjP6wr0hYkRxtuKtx7/jrHrJ0PWbax6/3WT9T57Hi17Gmaje45/cblZUnYd+XKj80LiRwrOOsG4lFWS2Y9k2SfUn3rqfQX6d3LogxWoDvyjnFoeqr6nZEowluIjxarGPF65qkfcp9HTplEd90+4JNXQR0k4FjFdoOEU0X7Cuozu9F+Fi3/9RoiYwT9KtO4XncxZd7H1Yjg3eioS9A8Ap6sLFayNY60cKkeGvCikiP1k7d8tWS+YjTPMOX2iWYTBhN4nl0bS28TNC2Td6rxkESsMeesEWjIojaQ/Fcg6I1TKIjbRJueu2YJ3nHYp67LMucJ22+25Ls1B9XQ5KI38uYK0Yp2z5TJiTjhvUGFuxsR9uaQug7bQygYfXnY690MyKOMYrZ2UElbR/ZxI7KZt0JbSPcR8zbN+s4WVTMCuPJLzZxsEhaJsuqlJ3bzsdG5+qJgePUhO5+gyoVKY+SpjtEojKMJmdmYOPOVCgeQOzbPHY43GaLOb9Od5tisIR53OzeEqCIf3g3DVePVyaZAnc8A7YZ19Wsq7/NhN8PBmtiJ4dJ/gpUUDSjuY6FIlT0tqe+7dRI5WNL6/T6OvplyKxGsXF/oW1dMyaU7vwvTk6l3uCxcdQp6SB/l+tkG12R5IWoxLI9ycda8X7O6AF+Ig9HevR8tRxGgDaKrjhbbeY+4y1mXt2aocWzRTNNYP4AvoqiZarpKxvmvpAhUdpJKPLdXDNi9Ee3rIltG2BS+Kz0Bbx1Oh0oOdVqM1xwGtQwj1BtNVwHkhfsM5i+pANlERE7T+GfIEjQ86Le+79UHWqxdp283dRwONO9HeiWqZzgpUA7q40CJPD9m2onaFMtY5ejksQ6jhf//5l7eobzo+B5/BWWmg0DM0dHjQnWgi8U6MJa7lN7vS35DnEq2VcxDKYWro4E1EKhwPLwsqhTEv+FhIQVlLME3WBhqJb1t0s3QZGur62iBwSHCKkpIdpNa3NI7TwEuncz9HfQedaXM7IZci4DAurVBoLVjE2gRVxlWMUK9pRLoiV4DKoSmMsAhc5ASeaAM4mYhY0MC0RQ2PHeRc8RRpsgjIb4pCEW4cFowel9aB1bL0RGjGHNEFigoxsS14LaYYiFNjgo4LiQmkJQ0RQawThGqJiYZKYIzWQUHTixj9oNZx40DiFI3PYb+SdJhCoamUCC5BTzbWlgZyhitL15HgUL00q/AVRtOp7OdI+LwFJIrSKUYCKiWAFOqWpNIDuF6l2RWOrXA4+qZO2Nlsdm8/fbtp80a4rByDwUKv7VLf6Hdf03z15VsWMYcmt2eTAZqpiOsL1AfmbHtwuyqwPPYF1l+gw179eduAdpMUMSqLjXJ4/Ob8LUzhu1aHRY2t+QkOt9/2X/VOBz0al2pc2H+HrU6rQ01UEnOuGlMNKqH7ckPo3t7Bi/WBsZfH92+/vTy+l8f/J5m1l8f32bOXx/fy+F4e38vj/+s0+g/l8UprcHjn2oXkwks0lfIc1JXrWiQmxToj3aV7zRaLMbd4aeRySc1/lGhItBlFbMqN4GOSDq5Hy6hWKEiOucU567JX4bFxcEETE1yWQezYUqpIYAkWx3GMhduJbUpD52eDCxaxcaXm5zohG8NnpPTzGesyShz/nwH/qvaaM7UvmOQqLXlK+DAuCSu8pCg0VZlbr8pUH4hZ3aXmDS835ZpAhX4TsQcNfqQn1m84/2kFDz0fNKhiW6Np7UbL5fIfZT45kg==",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:"eJztWdtuGzcQ/ZUJA/QSrCU5dYFCKIq6iZAKjS+IbPjBEhxqd7TLmktuSa5kQdBbv6Sf1i8phtyVVrKjJIjrooD8YEvkGXLOcDgkjxfM8dSy7jW7wnGm9S0bRSxBGxtROKEV67KLDMHyKYI2UBYJdwgVFo7P+8Cl1DOY6xKcDrhZ1VsaCbNMxBkIC6XFhBDOiDRFAzhF5exQPX/+vPrcHaqhOmzBixdTgTNMui9eDBUAwAFcZajAilShgdAJiY7LHJUDlwkbRoCZkLKeoBVs379/Hz4swh/6GTIPH7IuDFkYbsiiZv9ESAzdr89eXZ70Ti9uLt+93QIpnm+DTo9Petso7SrUuURuEQzSlMBV4hkF/2s2W8aNhQhjbPWHkFjqu163b5Dd9nXQf3Pae3ff0yowORdyA9g7Oe6/fQBZZFptDnn+69lpb8iawOX6y2jD8RD1X+YfmaoGHleLddE/6Q0ujk/Ot1CxQe4ehNWo5VC9pNSqkNu5tcomYaGCfGliVcPsM+tpM+uTUsFD1XeUEJ7oznwICBjP6wr0hYkRxtuKtx7/jrHrJ0PWbax6/3WT9T57Hi17Gmaje45/cblZUnYd+XKj80LiRwrOOsG4lFWS2Y9k2SfUn3rqfQX6d3LogxWoDvyjnFoeqr6nZEowluIjxarGPF65qkfcp9HTplEd90+4JNXQR0k4FjFdoOEU0X7Cuozu9F+Fi3/9RoiYwT9KtO4XncxZd7H1Yjg3eioS9A8Ap6sLFayNY60cKkeGvCikiP1k7d8tWS+YjTPMOX2iWYTBhN4nl0bS28TNC2Td6rxkESsMeesEWjIojaQ/Fcg6I1TKIjbRJueu2YJ3nHYp67LMucJ22+25Ls1B9XQ5KI38uYK0Yp2z5TJiTjhvUGFuxsR9uaQug7bQygYfXnY690MyKOMYrZ2UElbR/ZxI7KZt0JbSPcR8zbN+s4WVTMCuPJLzZxsEhaJsuqlJ3bzsdG5+qJgePUhO5+gyoVKY+SpjtEojKMJmdmYOPOVCgeQOzbPHY43GaLOb9Od5tisIR53OzeEqCIf3g3DVePVyaZAnc8A7YZ19Wsq7/NhN8PBmtiJ4dJ/gpUUDSjuY6FIlT0tqe+7dRI5WNL6/T6OvplyKxGsXF/oW1dMyaU7vwvTk6l3uCxcdQp6SB/l+tkG12R5IWoxLI9ycda8X7O6AF+Ig9HevR8tRxGgDaKrjhbbeY+4y1mXt2aocWzRTNNYP4AvoqiZarpKxvmvpAhUdpJKPLdXDNi9Ee3rIltG2BS+Kz0Bbx1Oh0oOdVqM1xwGtQwj1BtNVwHkhfsM5i+pANlERE7T+GfIEjQ86Le+79UHWqxdp283dRwONO9HeiWqZzgpUA7q40CJPD9m2onaFMtY5ejksQ6jhf//5l7eobzo+B5/BWWmg0DM0dHjQnWgi8U6MJa7lN7vS35DnEq2VcxDKYWro4E1EKhwPLwsqhTEv+FhIQVlLME3WBhqJb1t0s3QZGur62iBwSHCKkpIdpNa3NI7TwEuncz9HfQedaXM7IZci4DAurVBoLVjE2gRVxlWMUK9pRLoiV4DKoSmMsAhc5ASeaAM4mYhY0MC0RQ2PHeRc8RRpsgjIb4pCEW4cFowel9aB1bL0RGjGHNEFigoxsS14LaYYiFNjgo4LiQmkJQ0RQawThGqJiYZKYIzWQUHTixj9oNZx40DiFI3PYb+SdJhCoamUCC5BTzbWlgZyhitL15HgUL00q/AVRtOp7OdI+LwFJIrSKUYCKiWAFOqWpNIDuF6l2RWOrXA4+qZO2Nlsdm8/fbtp80a4rByDwUKv7VLf6Hdf03z15VsWMYcmt2eTAZqpiOsL1AfmbHtwuyqwPPYF1l+gw179eduAdpMUMSqLjXJ4/Ob8LUzhu1aHRY2t+QkOt9/2X/VOBz0al2pc2H+HrU6rQ01UEnOuGlMNKqH7ckPo3t7Bi/WBsZfH92+/vTy+l8f/J5m1l8f32bOXx/fy+F4e38vj/+s0+g/l8UprcHjn2oXkwks0lfIc1JXrWiQmxToj3aV7zRaLMbd4aeRySc1/lGhItBlFbMqN4GOSDq5Hy6hWKEiOucU567JX4bFxcEETE1yWQezYUqpIYAkWx3GMhduJbUpD52eDCxaxcaXm5zohG8NnpPTzGesyShz/nwH/qvaaM7UvmOQqLXlK+DAuCSu8pCg0VZlbr8pUH4hZ3aXmDS835ZpAhX4TsQcNfqQn1m84/2kFDz0fNKhiW6Np7UbL5fIfZT45kg==",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 b(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)(d(),{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)(p.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)(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)(o.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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "result": "Webhook updated successfully!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.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)(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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(p.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)(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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "error": "Webhook url already exists!"\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)(o.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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.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)(o.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)(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)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(t.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,a.jsx)(s,{...e,children:(0,a.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.cfa8a05d.js b/assets/js/770b40a9.d1814002.js similarity index 86% rename from assets/js/770b40a9.cfa8a05d.js rename to assets/js/770b40a9.d1814002.js index 150e967b4..367d65a49 100644 --- a/assets/js/770b40a9.cfa8a05d.js +++ b/assets/js/770b40a9.d1814002.js @@ -1 +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 +"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:()=>y,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+NSw7trJuVKit79d5xlad6MdAGFdUAyVNHtW7IjRjOqITdZ3BjnoB2nk+Fmh48yhpv7Lyiu2jcvWXtpnwa8QapfrbO7KPauatAHvpeTd8THcitiy8NKsrMcEGz0U4dfY8y0yXS8OoLhA7+959/BUY3o4b4eQaXlQWj52hpwOIqh4nEhaCBenf+dshLic7JJQjlcWqpW+ZiKjyXoVrTDJxxw1MhBUUcwTSxLfSC1g3gfYG+QEtb31ma53OcoaRABan1XZixNfDK6zLIaHWGubZ3E1IpAg5p5YRC58AhdhRUBVcZQncXEWhLMz8qj9ZY4RC4KAk80RZwMhGZoIMpvSzPPJRc8SmSsAhIb/LC+vFgdVo5D07LKhhCEktE35ioEHM3gF/EDBvDaTFHz4XEHKYVHRFBpnOENtvIDJVDis6DIfEiw3Co89x6kDhDG2Iv3OSkkhKMpjIguKTXS/9u6SBvuXLUDBqFuqtZu89YTbN0kJHz5QA+qA/qioKlckgBIIW6c8kHdQA36zB7j6kTHsffd/kwn8938uD5Nudc+KJKwaLRG940LIas6dPXH89ZxDza0l1OruiFlnVD3QMyhwE8bIsjz0JxbKciyrFX9wlUqKTIUDnslbKz83dvYQZHg5hFvcz/AoWHby9+fv3b1Ws6l2pTk3+jQTyIw5ylnS+56onaeuS2dW0reVebOv8/fRW3JdDjwg+N5CJ0j+D1VVv5b9hW5R9HrNDO0/pqlXKHv1tZ17TcvE2pH+TCkbWb1+kdLntv6TBRsoSF2v4Atn30bqBj+rCCsKFRRV1NJoEN5yzL0PQF7HTmrfZ2/vqaRYxXvtjuBXehF7Q/6PRuSy17Z283iUYB+ks2fZbwI4XKG1z+tIY3Ow8SWvs6NF3NuK7rfwA8fiID",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+NSw7trJuVKit79d5xlad6MdAGFdUAyVNHtW7IjRjOqITdZ3BjnoB2nk+Fmh48yhpv7Lyiu2jcvWXtpnwa8QapfrbO7KPauatAHvpeTd8THcitiy8NKsrMcEGz0U4dfY8y0yXS8OoLhA7+959/BUY3o4b4eQaXlQWj52hpwOIqh4nEhaCBenf+dshLic7JJQjlcWqpW+ZiKjyXoVrTDJxxw1MhBUUcwTSxLfSC1g3gfYG+QEtb31ma53OcoaRABan1XZixNfDK6zLIaHWGubZ3E1IpAg5p5YRC58AhdhRUBVcZQncXEWhLMz8qj9ZY4RC4KAk80RZwMhGZoIMpvSzPPJRc8SmSsAhIb/LC+vFgdVo5D07LKhhCEktE35ioEHM3gF/EDBvDaTFHz4XEHKYVHRFBpnOENtvIDJVDis6DIfEiw3Co89x6kDhDG2Iv3OSkkhKMpjIguKTXS/9u6SBvuXLUDBqFuqtZu89YTbN0kJHz5QA+qA/qioKlckgBIIW6c8kHdQA36zB7j6kTHsffd/kwn8938uD5Nudc+KJKwaLRG940LIas6dPXH89ZxDza0l1OruiFlnVD3QMyhwE8bIsjz0JxbKciyrFX9wlUqKTIUDnslbKz83dvYQZHg5hFvcz/AoWHby9+fv3b1Ws6l2pTk3+jQTyIw5ylnS+56onaeuS2dW0reVebOv8/fRW3JdDjwg+N5CJ0j+D1VVv5b9hW5R9HrNDO0/pqlXKHv1tZ17TcvE2pH+TCkbWb1+kdLntv6TBRsoSF2v4Atn30bqBj+rCCsKFRRV1NJoEN5yzL0PQF7HTmrfZ2/vqaRYxXvtjuBXehF7Q/6PRuSy17Z283iUYB+ks2fZbwI4XKG1z+tIY3Ow8SWvs6NF3NuK7rfwA8fiID",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 v(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 y(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/78b2b753.d6937815.js b/assets/js/78b2b753.d6937815.js deleted file mode 100644 index 469b267d7..000000000 --- a/assets/js/78b2b753.d6937815.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:()=>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/78b2b753.f380f604.js b/assets/js/78b2b753.f380f604.js new file mode 100644 index 000000000..5c91674b7 --- /dev/null +++ b/assets/js/78b2b753.f380f604.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:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var a=s(85893),i=s(11151),t=s(58219),r=(s(62316),s(51039)),n=s.n(r),d=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOLNUWyJOULDP3bk+zR9iTDkSxfYqdYt2F/Eovn+p3LR65FwKkXya34waiMnBhHIiOfOmmDNFok4l1BkJGiQNCqwPnbS0ClzMLDylQQTCfPG3lfRMJYcsgOLjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8LzMRCcmBLYZCPMzGTD5QGi4zMDlsHTr6WElHmUiCqygSPqwUu/SytIpEJGhplclIJDkqzwppQSWKZC3CyjaawUk9FZHIjSsx7J/QEhsviZhcDdM8GxV2Iup6zGG9NdqTZ0ejOOZ/h9n6Kk3J+7xSsK2IiERqdCAdWB+tVTJtBIMPno3Wx9m1oLlyjt0E2YbsavG5OH6c+dFPlhaXVtTRpjnZeTjlZmc0ikfPe8O4F3/5bvgyOfs6efGyH8fxbyISy1Kx7aaPGQZiv0EGtfveO5BaSU33XfXuR3F8PxyJumals1Nl7G1aDdKDNgGotGEVAZcRpfaQmbQqSQcwrpvBO92DG1NSKKSewoKFC2f0NAKrCD1BcCvAKUoNCgO5J3f/qjFG03XO01xHax6Nx7CexfH98y3Us2OoG6CMMjeVzvr/3biQc8Z97qwc5/OpVp7FZ/dfbeG9OIZ3qeeoZNZQSDAz0k/+B3w7NCfCc6qHAyxbpUYuDsDun7cgPaWVk2HVENmyh1b2WnlyO+Y54AE0OwpsyC8UIhGDtrCD9Zb2asHu3LyjxcopkYgiBOuTwcCjziZm2TeWtJdTrXDi+6kpB2jlYD4UdfTQAq39DG0fcCr1tPdJq/EO8A03pa37Aext9dHKK1qJqKvqvtaG4AtC5m+uo9S5aYw3tb62pG/kVDedmg+ProH3pFJTEt89oSDo1P/8/Y/GoiOEZpCewHXlwJoFOSZi1BnkipZyoujEVeYJS0XeqxVIHWjqMBBkcioDKuCqMJ+kaHEileTRYzXD1g72ptf34X1BoSDHoi8cAUJGc1I8saCMmbGfYACrYMomRkdiC+NmOacUAcKk8lKT9+CJOhPSBeqUoOtFxLyHGkgHctZJT4CyZOXcOKA8l6lkx7xnDtMAJWqcEgeLgPPmKlhn5jIjD85MKh/AG1U1QDhiSRRaiJoo8314JefUAufDjAJKRRlMK3bBzJwRbNaOYegMJuQDWA4vU2qc+oAugKI5uWb2mk7mlVJgDfOBRMW3/H5v2VFwqD1TVptQ15pt+awzfOc2MTJc9eFO32m+CqDyxAOgpJ75hC+I2+2YvaeJl4HGT7t9WCwWR3vw7NDmtQxFNQFH1uzsps1hszX75tuPZyISgVzpr/MbcnOZ0mYJH4k5aJQHG5bEtGFJKlGqdse+e2jAjKVkStrTHqedv377BubwvB+LaG/z/0bCgzeX31/8fHPBfpmb2v0b9uN+zEfW+FCi3gv1av+t+HBx1zuy/2cPyw27BFqGgVUoG4ZuAK031Hortu/CZPemHEeiMD6weL2eoKdfnaprPv5YkWP+Hkdijk7ihAnodi0y6fl3tn00Pgrk6S+b9+czOPk8PZlzR5OaOXKOquIvEYkZrQ4ew/W4jjqm5LRa+Xmakg17lkcX58Ht8+rizcW7CxEJrLhE+yQ9a0h684MDnEzskL3bHPgvXyQnDb7hXl7R6tuteit51GADsdPmIo3ruv4L549hyA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOLNUWyJOULDP3bk+zR9iTDkSxfYqdYt2F/Eovn+p3LR65FwKkXya34waiMnBhHIiOfOmmDNFok4l1BkJGiQNCqwPnbS0ClzMLDylQQTCfPG3lfRMJYcsgOLjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8LzMRCcmBLYZCPMzGTD5QGi4zMDlsHTr6WElHmUiCqygSPqwUu/SytIpEJGhplclIJDkqzwppQSWKZC3CyjaawUk9FZHIjSsx7J/QEhsviZhcDdM8GxV2Iup6zGG9NdqTZ0ejOOZ/h9n6Kk3J+7xSsK2IiERqdCAdWB+tVTJtBIMPno3Wx9m1oLlyjt0E2YbsavG5OH6c+dFPlhaXVtTRpjnZeTjlZmc0ikfPe8O4F3/5bvgyOfs6efGyH8fxbyISy1Kx7aaPGQZiv0EGtfveO5BaSU33XfXuR3F8PxyJumals1Nl7G1aDdKDNgGotGEVAZcRpfaQmbQqSQcwrpvBO92DG1NSKKSewoKFC2f0NAKrCD1BcCvAKUoNCgO5J3f/qjFG03XO01xHax6Nx7CexfH98y3Us2OoG6CMMjeVzvr/3biQc8Z97qwc5/OpVp7FZ/dfbeG9OIZ3qeeoZNZQSDAz0k/+B3w7NCfCc6qHAyxbpUYuDsDun7cgPaWVk2HVENmyh1b2WnlyO+Y54AE0OwpsyC8UIhGDtrCD9Zb2asHu3LyjxcopkYgiBOuTwcCjziZm2TeWtJdTrXDi+6kpB2jlYD4UdfTQAq39DG0fcCr1tPdJq/EO8A03pa37Aext9dHKK1qJqKvqvtaG4AtC5m+uo9S5aYw3tb62pG/kVDedmg+ProH3pFJTEt89oSDo1P/8/Y/GoiOEZpCewHXlwJoFOSZi1BnkipZyoujEVeYJS0XeqxVIHWjqMBBkcioDKuCqMJ+kaHEileTRYzXD1g72ptf34X1BoSDHoi8cAUJGc1I8saCMmbGfYACrYMomRkdiC+NmOacUAcKk8lKT9+CJOhPSBeqUoOtFxLyHGkgHctZJT4CyZOXcOKA8l6lkx7xnDtMAJWqcEgeLgPPmKlhn5jIjD85MKh/AG1U1QDhiSRRaiJoo8314JefUAufDjAJKRRlMK3bBzJwRbNaOYegMJuQDWA4vU2qc+oAugKI5uWb2mk7mlVJgDfOBRMW3/H5v2VFwqD1TVptQ15pt+awzfOc2MTJc9eFO32m+CqDyxAOgpJ75hC+I2+2YvaeJl4HGT7t9WCwWR3vw7NDmtQxFNQFH1uzsps1hszX75tuPZyISgVzpr/MbcnOZ0mYJH4k5aJQHG5bEtGFJKlGqdse+e2jAjKVkStrTHqedv377BubwvB+LaG/z/0bCgzeX31/8fHPBfpmb2v0b9uN+zEfW+FCi3gv1av+t+HBx1zuy/2cPyw27BFqGgVUoG4ZuAK031Hortu/CZPemHEeiMD6weL2eoKdfnaprPv5YkWP+Hkdijk7ihAnodi0y6fl3tn00Pgrk6S+b9+czOPk8PZlzR5OaOXKOquIvEYkZrQ4ew/W4jjqm5LRa+Xmakg17lkcX58Ht8+rizcW7CxEJrLhE+yQ9a0h684MDnEzskL3bHPgvXyQnDb7hXl7R6tuteit51GADsdPmIo3ruv4L549hyA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Folder"})}),"\n",(0,a.jsx)(n(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,a.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(l.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,a.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsxs)(l.ul,{children:["\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsx)(m.default,{className:"openapi-tabs__schema",children:(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsxs)("div",{children:[(0,a.jsx)("span",{className:"badge badge--info",children:(0,a.jsx)(l.p,{children:"oneOf"})}),(0,a.jsxs)(m.default,{children:[(0,a.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,a.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})]})})]})})})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"folder not found."})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:l}={...(0,i.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/7b076186.35a41943.js b/assets/js/7b076186.35a41943.js new file mode 100644 index 000000000..ed73bdbdc --- /dev/null +++ b/assets/js/7b076186.35a41943.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8489],{91945:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});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/itXfmkLKLaTph0mDMOyNuiCFm2xZCiw1AjO4lliTZEsSfkFhr7tl+yn7ZcMJ8m2nDhBCwwF9iWxyHt97u45rkXEPIj0Wry0JmIWgxgnQlLIvHJRWSNScVUQvCJNkaATgrMPF4Ba20WAla0gWvBU2jkBQtaJTL0t+dJvTibWzgZwMW00jAVtTU4eDJEEBIc+qqzSuJV/HECZqfUlchwJxEKFxnGJMwqgIhCGFfuWbXCxIOXBU2a9HIhEWEe+0b2QIhWtUGdbJMKhx5Iiec5+LQyWJFLR3d8oKRKhOHuHsRC3Ifng7VxJAjv5TFm8kGCn28S3AYlEePpSKU9SpNFXlIgQV5rdBFU6zQK0dNpKEukUdWCBrKASRboWceUayeiVyUUiWiT6J7TExkoqXHEyKU4wSFHXY/YanDWBAts5GY343378mzq2gUoIVZZRCNNK69UjkTQwkImsiM5plTU4Dj8H1l7fjbLFgVH1jHpUre8NPIfy2UX/65Jjd7+5Z6JOujrJs/iw0sno5NnR8eho9MPV8Yv09Mf0+YvBaDT6UyRiWWrW7SoqMRLbjSrq3Xd9R6wtWV+wO6lZ+PQQipe2pFgok8OCTISFtyZPwGnCQBD9CjBHZUBjJP8fokreW/8wOt8WWd3LWhmtDN1sWujmdDS6Od6CcHp/KxkbYWorI79vpgfcP5zO6c3JNp3nd9O5MHPUSjZEc2VnZL5vOn33sXV/t1dVK9Tci71k++dtkoGyyqu4akhueYROHbX36fWYuYL7xO74sSHGWIhUDDs+G653nFgLNujnG9KsvBapKGJ0IR0OAxo5scuBdWSCyo3GSRhkthyiU8P5saiT2xro3DdIh4i5MvnRg1rjXcqXXJYW+b3Et/ijU29oJZINrn2pjv0LQkm+qQEvo0a5Q/u9I3OpctPUan58Z0d8JJ3ZkngfxIJgI/7PX383GtJmVUkmNq30CN5XHpxdkJ9WGtBImGpaqommA7s2EJaaQtArUCZS7jESSJWriBoYFR78DB1OlFbcfCxm22Xc698wgI8FxYI8Xz32vL0lzUlzz4K2dsZ2ogWsoi0bH13MsLB+NuWQEkCYVEEZCgEC0UaFTIEmI9jUIgHrAQ2QieSdV4EAVcnCU+uBplOVKTbMveZ5nks0mBM7S4DjZhRcu3UDeDupQoRgddUkwh5LotimyC+KMIBXak5t4nwoKaLSJCGv2EQCmZUE3eBxGkbChEIEx+5VRo3RENFH0DQn3/ReU0nekuAsM4JCzau/X1s2FD2awAu7DWhTmi18zltet40PiasBfDKfDHM2VIG4AbQys5B+MkdwvW2zjzQJKtL4yWYeFovFnTl4uq/zWsWimoAnZ3d6eXPYTE1fffvxVCQiki/D++kl+bnKqBvCe3wOG+Fhx5P8umKuK1HpdsZ+ua3AnKVVRiZQj9XOXn94C3N4NhiJpDf5XxHw8O3Fy/N3l+dsl7mpnb/jwWgw4iNnQyzR9Fztv2ZvT+56x/f/27dvx3CRlnHoNKpmTzSgrjuCvxa7t3Dae/aOE1HYEFlgvZ5goD+8rms+/lKR5z0yTsQcvcIJ0+D1WkgV+LfcPmLvRfPJ7917+Cl87Qv6YCIb/jZM3nPUFX+JRMxotf+Gr8d1suFwDrUVOMsycrGnemep723GV+dvz6/ORSKwYuD662PWrI/uBzs4GNn+Xmlj4L+84g4q/MSlfkOrn7fi7c29Cl2KG2lGaVzX9b+IN9VT",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/itXfmkLKLaTph0mDMOyNuiCFm2xZCiw1AjO4lliTZEsSfkFhr7tl+yn7ZcMJ8m2nDhBCwwF9iWxyHt97u45rkXEPIj0Wry0JmIWgxgnQlLIvHJRWSNScVUQvCJNkaATgrMPF4Ba20WAla0gWvBU2jkBQtaJTL0t+dJvTibWzgZwMW00jAVtTU4eDJEEBIc+qqzSuJV/HECZqfUlchwJxEKFxnGJMwqgIhCGFfuWbXCxIOXBU2a9HIhEWEe+0b2QIhWtUGdbJMKhx5Iiec5+LQyWJFLR3d8oKRKhOHuHsRC3Ifng7VxJAjv5TFm8kGCn28S3AYlEePpSKU9SpNFXlIgQV5rdBFU6zQK0dNpKEukUdWCBrKASRboWceUayeiVyUUiWiT6J7TExkoqXHEyKU4wSFHXY/YanDWBAts5GY343378mzq2gUoIVZZRCNNK69UjkTQwkImsiM5plTU4Dj8H1l7fjbLFgVH1jHpUre8NPIfy2UX/65Jjd7+5Z6JOujrJs/iw0sno5NnR8eho9MPV8Yv09Mf0+YvBaDT6UyRiWWrW7SoqMRLbjSrq3Xd9R6wtWV+wO6lZ+PQQipe2pFgok8OCTISFtyZPwGnCQBD9CjBHZUBjJP8fokreW/8wOt8WWd3LWhmtDN1sWujmdDS6Od6CcHp/KxkbYWorI79vpgfcP5zO6c3JNp3nd9O5MHPUSjZEc2VnZL5vOn33sXV/t1dVK9Tci71k++dtkoGyyqu4akhueYROHbX36fWYuYL7xO74sSHGWIhUDDs+G653nFgLNujnG9KsvBapKGJ0IR0OAxo5scuBdWSCyo3GSRhkthyiU8P5saiT2xro3DdIh4i5MvnRg1rjXcqXXJYW+b3Et/ijU29oJZINrn2pjv0LQkm+qQEvo0a5Q/u9I3OpctPUan58Z0d8JJ3ZkngfxIJgI/7PX383GtJmVUkmNq30CN5XHpxdkJ9WGtBImGpaqommA7s2EJaaQtArUCZS7jESSJWriBoYFR78DB1OlFbcfCxm22Xc698wgI8FxYI8Xz32vL0lzUlzz4K2dsZ2ogWsoi0bH13MsLB+NuWQEkCYVEEZCgEC0UaFTIEmI9jUIgHrAQ2QieSdV4EAVcnCU+uBplOVKTbMveZ5nks0mBM7S4DjZhRcu3UDeDupQoRgddUkwh5LotimyC+KMIBXak5t4nwoKaLSJCGv2EQCmZUE3eBxGkbChEIEx+5VRo3RENFH0DQn3/ReU0nekuAsM4JCzau/X1s2FD2awAu7DWhTmi18zltet40PiasBfDKfDHM2VIG4AbQys5B+MkdwvW2zjzQJKtL4yWYeFovFnTl4uq/zWsWimoAnZ3d6eXPYTE1fffvxVCQiki/D++kl+bnKqBvCe3wOG+Fhx5P8umKuK1HpdsZ+ua3AnKVVRiZQj9XOXn94C3N4NhiJpDf5XxHw8O3Fy/N3l+dsl7mpnb/jwWgw4iNnQyzR9Fztv2ZvT+56x/f/27dvx3CRlnHoNKpmTzSgrjuCvxa7t3Dae/aOE1HYEFlgvZ5goD+8rms+/lKR5z0yTsQcvcIJ0+D1WkgV+LfcPmLvRfPJ7917+Cl87Qv6YCIb/jZM3nPUFX+JRMxotf+Gr8d1suFwDrUVOMsycrGnemep723GV+dvz6/ORSKwYuD662PWrI/uBzs4GNn+Xmlj4L+84g4q/MSlfkOrn7fi7c29Cl2KG2lGaVzX9b+IN9VT",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"},next:{title:"Get Contact list",permalink:"/docs/API-docs/contactlist"}},f={},g=[{value:"Request",id:"request",level:2}];function 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:"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 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/7b076186.7764bd79.js b/assets/js/7b076186.7764bd79.js deleted file mode 100644 index 5e2a71d05..000000000 --- a/assets/js/7b076186.7764bd79.js +++ /dev/null @@ -1 +0,0 @@ -"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/8a725248.6792c484.js b/assets/js/8a725248.6792c484.js new file mode 100644 index 000000000..b2077e617 --- /dev/null +++ b/assets/js/8a725248.6792c484.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 t=s(85893),l=s(11151),n=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/0kMo71kO2QIwYpjjLCJRKRgiLSImpna2ZZ6utvdPXuw7L88SR4tTxKqZ2YvHUQQHAJCzHbXfXxVvRIBSy/SK/HO6IB58GKciIJ87qQN0miRisspwTtHGAhaIjg5PwVUysw9LE0NwQBNJsYFRd6rJeQNtaY55K1YCFMMkKMG5kcPXpaanIeJcSzDgayscQF1gMLkdUU6+J5IhLHkkC05LUQqGsmtUJEIR19q8uEnUyxFujow/NyZmSwIMlJmDhYdVhTIsbmthVtB/EU6sBC0Vsk86uzfepa0Ej6fUoX8xRqlo4JjRhVKJRKhsSKRCDs1mjh+YWlJpMJktxSFW8deBEmeJUTqdNVR+eCkLkUiJsZVGHZPaIGVVUx0a9gNEuukVfp8/ozobXvQy03FohqDnylqODoeDY+Hx6OhWK8TEWSIx3uZuck4IWu+38YruJrigbdG+yYWo8Hgft66KmtEFuDrPCfvJ7VSyxfPydXTeWiOuayeFwA7HWbTxejWcgj/58l8NTwejuIfi2gDfhIeErNlGg1Gx0fDwdHgu8vhm/TV9+nrN73BYPC7SMSiUtsSFwWG6GVXI93v2hZfQc/6kKwtzoICSuV3GTocWMeSffVQUV6YisJU6hLmpAPMndFlAlYReoLgloAlSg0KA7l/sUjJOeOeDtPzLNvtWamV1HTTdeTNq8HgZrgJwvDxzkTlCIsl0EL64L+uu4/Z8LRjwx3HXt937FTPUMkiDrZLc0f66/q0qz406u+Xr2yI4r3Yc3b3vHHSU147GZYivVqJxRFaedTcp1fj9TgRXDGGB6o1PlqMYSpS0T+cr57cjJyPYmqnRCqmIVif9vsedZGZRc9Y0jzLFWaeoaiPVvZnDCeHHGjtM6h9wFLq8uhJrvHW0wvORhPwPX83YUcrP9Kym9bpHlUiJFfBlLAgF0PPSf51u1y871K1yUYH4hsMfwiWN6i8NzVZ28RE09oUnlnSF7LUsQBmQ3G4gn0mlZuKeHMJU4KO/K8//owc3cIU6/MFnNUOrJmTm9QKUBcwUbSQmaIH9jZPWLVbm9SBSsdrUSFLGVDFHY1xJUeLmVSSK5rJTLOx7TSF78HnKYUpxWXuG0eAUNCMFDcCKGPuWE4wgHUwVdTR2gxz4+4mbFICCFntpSbvwRN1LKSnqHOCLtMJGAeogXQgZ530BCgrJuZdkiYTmUsWzFXsGCkq1FgSK0uA7eYo2GY39OBMVvsA3qg6OsIaK6LQuKiJCt+Dn+WMGsf5sBkgVEBZs4gEclMQtHlnN3QBGfkAltXLnKJQH9AFUDQjFys7ZpJ3GrCGYUaiAjPZyy0LCg615xHeGNSlZhM+6wwvR1FHgcseXOtrzSMBak9cAErqO59e6yO42pTZZ8q8DDT+tuu2+Xx+r8te7vN8kGFaZ+DImi1fGQ9jT+6yb368FIkI5Cp/NrkgN5M5tS3+iM5+JO634MsYxADaNhha+faQgbtJyZy0323Okw/nn2AGx72BSHZw5R8Y3P90+u79LxfvWS4jX9N/w96gN4hLlvGhQr2jav9ldNi5q+0Q+Y/fUS0KBlqEvlUo4wiJoVm16H918LoaJ2LK0yG9EqtVhp5+c2q95uMvNTkeLeNEzNBJzBjErsbrpENQHhd3tGynNelwdMnqmVzVDRgfzFMeAA3HSZ6TDU/S7g6w87OLS5GIrH0BVqZgHodzfh3iXKTiWlyL+JCM/R3fcHy+Egp1WWMZ0TzKZeDHmmOxOzXu4tRoP9iz7kovd6zcHyeNK/yfHXuQ4QdO/kda/rghb24eZWhj21FzBsfr9fpvroJzNA==",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+cr57cjJyPYmqnRCqmIVif9vsedZGZRc9Y0jzLFWaeoaiPVvZnDCeHHGjtM6h9wFLq8uhJrvHW0wvORhPwPX83YUcrP9Kym9bpHlUiJFfBlLAgF0PPSf51u1y871K1yUYH4hsMfwiWN6i8NzVZ28RE09oUnlnSF7LUsQBmQ3G4gn0mlZuKeHMJU4KO/K8//owc3cIU6/MFnNUOrJmTm9QKUBcwUbSQmaIH9jZPWLVbm9SBSsdrUSFLGVDFHY1xJUeLmVSSK5rJTLOx7TSF78HnKYUpxWXuG0eAUNCMFDcCKGPuWE4wgHUwVdTR2gxz4+4mbFICCFntpSbvwRN1LKSnqHOCLtMJGAeogXQgZ530BCgrJuZdkiYTmUsWzFXsGCkq1FgSK0uA7eYo2GY39OBMVvsA3qg6OsIaK6LQuKiJCt+Dn+WMGsf5sBkgVEBZs4gEclMQtHlnN3QBGfkAltXLnKJQH9AFUDQjFys7ZpJ3GrCGYUaiAjPZyy0LCg615xHeGNSlZhM+6wwvR1FHgcseXOtrzSMBak9cAErqO59e6yO42pTZZ8q8DDT+tuu2+Xx+r8te7vN8kGFaZ+DImi1fGQ9jT+6yb368FIkI5Cp/NrkgN5M5tS3+iM5+JO634MsYxADaNhha+faQgbtJyZy0323Okw/nn2AGx72BSHZw5R8Y3P90+u79LxfvWS4jX9N/w96gN4hLlvGhQr2jav9ldNi5q+0Q+Y/fUS0KBlqEvlUo4wiJoVm16H918LoaJ2LK0yG9EqtVhp5+c2q95uMvNTkeLeNEzNBJzBjErsbrpENQHhd3tGynNelwdMnqmVzVDRgfzFMeAA3HSZ6TDU/S7g6w87OLS5GIrH0BVqZgHodzfh3iXKTiWlyL+JCM/R3fcHy+Egp1WWMZ0TzKZeDHmmOxOzXu4tRoP9iz7kovd6zcHyeNK/yfHXuQ4QdO/kda/rghb24eZWhj21FzBsfr9fpvroJzNA==",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,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:"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)(n.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,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.79523427.js b/assets/js/8a725248.79523427.js deleted file mode 100644 index aa3e2f155..000000000 --- a/assets/js/8a725248.79523427.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:()=>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.4657d57d.js b/assets/js/8a855f99.4657d57d.js new file mode 100644 index 000000000..3c4d99fce --- /dev/null +++ b/assets/js/8a855f99.4657d57d.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:()=>w,frontMatter:()=>x,metadata:()=>u,toc:()=>g});var l=s(85893),n=s(11151),i=s(58219),d=(s(62316),s(51039)),r=s.n(d),t=(s(82723),s(9487)),o=s(41429),p=s(5397),m=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+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XDohS4yczswlrSXpVYi84PcVENh5XB2iE1yV0NY+wBpH0QpdXlwr9Z4E+05Z6QFfSvmNfTCyte0wKSDtC+1mqJTEpG9mwQ50e83M+tll67tAdHn/F3KR86U1BMTvVhl7J0lfS5LHfM9O9wZ2h9J5aYinn1hStCJ//3nX1GjMHldkQ6xHB/Bu9qBNXNyTPRCFzBRdCszRXvuJZ5Epch7tQCpA5WOB2shSxmEAoaXySQXVmRSSS5gFjOs7aDXA34AH6cUpuR46xtHIKCgGSmue1DG3LCdYEDUwVTxjJXPMDfuZsIuJSAgq73U5D14ok6F9FTonKBLagLGgdBAOpCzTnoCISsWnhgHNJnIXLJh7lYn8gCV0KIkPiwB9ptRsO3twoMzWe0DeKPqGAifWBGFNkRNVPgB/CJn1AbOiwUFIRUVUNZsIoHcFASr5uUwdAEZ+QCWj5c5RaM+CBdA0YxcLOKYyUmtFFjDrCKF4jtZP7dsKDihPRNf61CXmjV81hme6fGMQiwGcKWvNM8BqD1xASipb3x6pQ/gcl1mHynzMtD4cddY8/l8p6GebOu8kmFaZ+DImo1eGRdj+/XV13+eYIKBXOXfTc7JzWROq27+wpnDKDxcca3II9dSJaRqm/WnuwrcTUrmpD31mPHk1dkbmMHTwQiTHoX8C4eHb05fvHx7/pLtMsm1/Xc4GA1G8QJnfKiE7h21dfG/27jLzcj4Kq+EFYsFug1Dq4SMYyDGu1xReHfPxQTTzQNhnODU+MDby2UmPH1wqml4+XNNjofEOMGZcFJkzE+XSyyk59/F+gXwxTgfv19dsp/A3rfGXp87OtbMxTOh6njfTfCGFlsvm2bcJB0js1vt/ov28IMLtrLR35nRPFBajZM8Jxvule0PxbMPF5hgtnqnVPElhE7M+ekk5pjiFV5hfLVFDolPDV5fohK6rEXJ8q1ZniOi5tT0h9BNHEKrHxzYXkC2p1MbCX9yXHsVfuASe02LH9fi7c4XFVbQdtKcnHHTNP8AmqE32Q==",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+9uGzcMfxWWX9YCF9tJ0247DMOyruuyFm3QpCiwxAh0d/RZjU5SJZ0dw7hve5I92p5koM5nn2M3WIB1X/xHIinyR/JHaYlBlB7TS/zVqIIcjhMsyOdO2iCNxhQvpgQfbCECQSsCJ2enIJQycw8LU0MwUJu4P2n3tagIhIc5KcXfVjjSoVU+LQaYoLHkBNs/LTDFOlpvlTFBK5yoKJBjt5bI1jDFdvtaFpigZL+sCFO866zJPlEeTgswE1gbdPS5lo4KTIOrKUEfFopNellZRZgg3VplCsJ0IpRngXxKlcB0iWFho2RwUpeY4MS4SoT+Ct2KaCXF7PVhPimOpjbDphm3x5IPP5tiwaa2HT1zZiYLgoyUmcM6ZAYzd7QBExPMjQ6kA9sQ1iqZR+SGnzwbWvac3cR5uYIrYjdOujBadBhixxkIkjzrtbJvI84PC1nTvPOziYnr5fmhtrBpEgwyqF62M8auaXjHkbdG+9bjo9FoF1Jf5zl5P6kVrOvrIfDdD1JXWQ8N67cbf/S7pfmpZYjaUi9Owj4zG6Wj0dHTg8PRwejbi8Pn6fH36bPng9Fo9AcmeFsp1l11BVvDHm7t/96C1Epquu7Quz4aja4PD1eYHu+D8dxUFKZSlzAnHWDujC4TsIqEJwhuAaIUUoMSgdyj/w5fcs64+1F5mGf3oXDMKKxBON4FoWMyE2Biah1J62sHel8V7fpzf3jH19+tw3u2G96pngkli8jkwdyQ/n8Tued4dnW7tGUrFPdxK9j+ehukp7x2MiziwLg9EFYetPvp5ZipmOvG8KixdXSYR0eKwxbV4XI9WxpkW27WzZ7aKUxxGoL16XDohS4yczswlrSXpVYi84PcVENh5XB2iE1yV0NY+wBpH0QpdXlwr9Z4E+05Z6QFfSvmNfTCyte0wKSDtC+1mqJTEpG9mwQ50e83M+tll67tAdHn/F3KR86U1BMTvVhl7J0lfS5LHfM9O9wZ2h9J5aYinn1hStCJ//3nX1GjMHldkQ6xHB/Bu9qBNXNyTPRCFzBRdCszRXvuJZ5Epch7tQCpA5WOB2shSxmEAoaXySQXVmRSSS5gFjOs7aDXA34AH6cUpuR46xtHIKCgGSmue1DG3LCdYEDUwVTxjJXPMDfuZsIuJSAgq73U5D14ok6F9FTonKBLagLGgdBAOpCzTnoCISsWnhgHNJnIXLJh7lYn8gCV0KIkPiwB9ptRsO3twoMzWe0DeKPqGAifWBGFNkRNVPgB/CJn1AbOiwUFIRUVUNZsIoHcFASr5uUwdAEZ+QCWj5c5RaM+CBdA0YxcLOKYyUmtFFjDrCKF4jtZP7dsKDihPRNf61CXmjV81hme6fGMQiwGcKWvNM8BqD1xASipb3x6pQ/gcl1mHynzMtD4cddY8/l8p6GebOu8kmFaZ+DImo1eGRdj+/XV13+eYIKBXOXfTc7JzWROq27+wpnDKDxcca3II9dSJaRqm/WnuwrcTUrmpD31mPHk1dkbmMHTwQiTHoX8C4eHb05fvHx7/pLtMsm1/Xc4GA1G8QJnfKiE7h21dfG/27jLzcj4Kq+EFYsFug1Dq4SMYyDGu1xReHfPxQTTzQNhnODU+MDby2UmPH1wqml4+XNNjofEOMGZcFJkzE+XSyyk59/F+gXwxTgfv19dsp/A3rfGXp87OtbMxTOh6njfTfCGFlsvm2bcJB0js1vt/ov28IMLtrLR35nRPFBajZM8Jxvule0PxbMPF5hgtnqnVPElhE7M+ekk5pjiFV5hfLVFDolPDV5fohK6rEXJ8q1ZniOi5tT0h9BNHEKrHxzYXkC2p1MbCX9yXHsVfuASe02LH9fi7c4XFVbQdtKcnHHTNP8AmqE32Q==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Folder",permalink:"/docs/API-docs/getfolder"},next:{title:"Delete Folder",permalink:"/docs/API-docs/deletefolder"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,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,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)(r(),{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)(m.Z,{collapsible:!1,name:"folderName",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"new folder"}}),(0,l.jsx)(m.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)(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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(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)(p.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(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)(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)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"folder not found."})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(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)(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)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function w(e={}){const{wrapper:a}={...(0,n.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/8a855f99.f275f83a.js b/assets/js/8a855f99.f275f83a.js deleted file mode 100644 index 2cb8422b8..000000000 --- a/assets/js/8a855f99.f275f83a.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:()=>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.f2a0d0c3.js similarity index 67% rename from assets/js/a2bc1463.cf280f35.js rename to assets/js/a2bc1463.f2a0d0c3.js index 092a3951a..533f1025b 100644 --- a/assets/js/a2bc1463.cf280f35.js +++ b/assets/js/a2bc1463.f2a0d0c3.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var t=a(85893),l=a(11151),n=a(58219),i=(a(62316),a(51039)),o=a.n(i),r=(a(82723),a(9487)),c=a(41429),d=a(5397),m=a(4667),p=a(9472),h=a(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+nhSe32I2K1imRiToE67Px2KMuc7MaGcujqtIKc8/9PEYrxwvuybsSaO0j0D5gJXV19EWp6W2Yl/wUXbYPgr2lWCtfE3Nsn8shqh87NWHJ42LL3zMThfsMv7WkL2Wl4/ssJuLuEvCeVGEa4lEfaoId/K8//owSpSnahnSI5fME3rYO4n7A8wV1CTNFK8mjncGolFnuNwdP2CjyXq1B6kCVw0BQykoGVMBZ4e4o0GIuleSCY5jp9oJBzfoRvK8p1OT46jvHm0hJC1Jcp6CMmbOeYADbYJpoo/cZlsbNZ+xSAgh566Um78ET7URI16gLgt1bJGAcoAbSgZx10hOgbBg8Mw5oNpOFZMVca47XpgY1VsTGEmC/OQvdUkQenMlbH8Ab1cZA2GJDFLoQNVHpR/ALb0sxcD7seJJKqFpWkUBhSoK+2TgMXUJOPoBl87KgqNQHdAEULcjF2osvOWuVAmuYBSQq3sWGb8uKgkPteVJ1Du2eZp8+6wyvEtFGiesRfNAfNBMbtJ64AJTUc5990EdwvS+z95R7GWj6/a4flsvlvT54eihzLkPd5uDImlu5Kh7GrhmK7z+eikQEco1/O7skt5AF9U34gM1xBI97buTJw/zW7QLcYy/uCjBPKVmQ9jRgsrPzd29gAc9GqUgGnf8vHB6/uXj56tfLV6yXuanrv8koHaVxlzA+NKgHps4p7PfzntYOendzy/L/w12+Z69AqzC2CmXk/ZiwTc/Z1wcb/jQRtfGBjzebHD395tR2y8fdUs1MXkrPtm/X6jmtB/8JWKBq2WZk5Qew/bZ+C53yh5OMjRMm2bEpG+xkzoqC7NDAvZF6MJfOX12JRGDLMQ5ZfB5ZvP+Dte+u9Hqg+5DeOwf4X47pswI/8VO/pvXPe3h386BAH98OzS8z3W63fwN4mego",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+nhSe32I2K1imRiToE67Px2KMuc7MaGcujqtIKc8/9PEYrxwvuybsSaO0j0D5gJXV19EWp6W2Yl/wUXbYPgr2lWCtfE3Nsn8shqh87NWHJ42LL3zMThfsMv7WkL2Wl4/ssJuLuEvCeVGEa4lEfaoId/K8//owSpSnahnSI5fME3rYO4n7A8wV1CTNFK8mjncGolFnuNwdP2CjyXq1B6kCVw0BQykoGVMBZ4e4o0GIuleSCY5jp9oJBzfoRvK8p1OT46jvHm0hJC1Jcp6CMmbOeYADbYJpoo/cZlsbNZ+xSAgh566Um78ET7URI16gLgt1bJGAcoAbSgZx10hOgbBg8Mw5oNpOFZMVca47XpgY1VsTGEmC/OQvdUkQenMlbH8Ab1cZA2GJDFLoQNVHpR/ALb0sxcD7seJJKqFpWkUBhSoK+2TgMXUJOPoBl87KgqNQHdAEULcjF2osvOWuVAmuYBSQq3sWGb8uKgkPteVJ1Du2eZp8+6wyvEtFGiesRfNAfNBMbtJ64AJTUc5990EdwvS+z95R7GWj6/a4flsvlvT54eihzLkPd5uDImlu5Kh7GrhmK7z+eikQEco1/O7skt5AF9U34gM1xBI97buTJw/zW7QLcYy/uCjBPKVmQ9jRgsrPzd29gAc9GqUgGnf8vHB6/uXj56tfLV6yXuanrv8koHaVxlzA+NKgHps4p7PfzntYOendzy/L/w12+Z69AqzC2CmXk/ZiwTc/Z1wcb/jQRtfGBjzebHD395tR2y8fdUs1MXkrPtm/X6jmtB/8JWKBq2WZk5Qew/bZ+C53yh5OMjRMm2bEpG+xkzoqC7NDAvZF6MJfOX12JRGDLMQ5ZfB5ZvP+Dte+u9Hqg+5DeOwf4X47pswI/8VO/pvXPe3h386BAH98OzS8z3W63fwN4mego",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 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 Contact list"})}),"\n",(0,t.jsx)(o(),{method:"get",path:"/contactlist"}),"\n",(0,t.jsx)(s.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)(s.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(a,{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)(s.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)(n.Z,{children:[(0,t.jsxs)(h.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)(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)(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)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,t.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsxs)("span",{className:"openapi-schema__container",children:[(0,t.jsx)("strong",{className:"openapi-schema__property",children:(0,t.jsx)(s.p,{children:"result"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(s.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)(s.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)(s.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)(s.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)(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)(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)(s.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)(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)(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:s}={...(0,l.a)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/a88a3db3.ab6ff70c.js b/assets/js/a88a3db3.ab6ff70c.js deleted file mode 100644 index 66751cebe..000000000 --- a/assets/js/a88a3db3.ab6ff70c.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:()=>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.e09eee0c.js b/assets/js/a88a3db3.e09eee0c.js new file mode 100644 index 000000000..925dd9ca4 --- /dev/null +++ b/assets/js/a88a3db3.e09eee0c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[7894],{79523:(e,a,l)=>{l.r(a),l.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var s=l(85893),t=l(11151),i=l(58219),n=(l(62316),l(51039)),r=l.n(n),d=(l(82723),l(9487)),m=l(41429),p=l(5397),o=l(4667),c=l(9472),h=l(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/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam5nLme4FiTLINIbcY2105IwiGkicgyZV46UNSIV1xXCOWokhEEKzt5dgvN2rnIMsLINLBRVQBWCnCmtaAVkwWNt5wgSgsNMFSoDGvQLb+soPpyEEVwWILcSKoCxoK0p0YNBzDEXibAOveS4LnORijxGNQQlEuGklzUSesa0FkbWKFIx2LxVbEIxJiepEveBXp6DLfaiAqokRe+BAc0QOpdsx+OnRnnMRUq+wUQEWmn2FlTtNAeDS6dtjiItpA4skFVYS5GuBa1clCSvTCkSUVhfS9qetO2U7QdnTcDAGieTCf/dK8wQZR8UhCbLMISi0Xr1RCQis4bQEGtK57TKYurGHwOrrw8DsrOPmBHn0XOiSXXOu2PO+GHouJQRbip+WlYnMrhf3HPRJn1p8jN6XOlkcvL86HhyNPn2+vhlevpd+uLlaDKZ/CESsaw16/Y1zLnAbSJIkd6+twdi0e2eYH/SsvDpQ2m8sjVSpUwJCzQEC29NmYDTKAMC+RXIUioDnGn/H2YVvbf+8ex8WWTtDmpltDJ4O/TQ7elkcnu8ScLpI71kLEFhG5N/XagP+X8c0Ontyw2gF4eALs1capVHprq2d2i+Lp5d99S5P+xW1QnF72IP7O55BzJg1nhFq0hsyyPp1FH3Pb2ZMl1wp9gtKUYypEqkYjyQ2Xi9Q4StYJN+PlBl47VIRUXkQjoeB2nymV2OrEMTVGm0nIVRZuuxdGo8PxZtcl9DOvcF0oFkqUx59KjWdAv6igvT5X4P+qYC0qnXuBLJkNldqZ7yK5Q5+lgFZQoblft8v3VorlRpYrXmxweL4T3qzNbIK4C3wyD+959/RY3cZk2NhmIzPYG3jQdnF+iLRoM0ORQal2qmu60ptbaLbmeShYCy1hiCXoEyhKWPdK5KRVIDZ4WHP5Ou26oKA4tZ1vaw08FhBO8rpAo9f/rG89LNcY6auxa0tXdshyzIhmwdffQxw8L6u4JDSkDCrAnKYAgQEAcVNJU0GcJQiwSsB2kADaF3XgUEqWoWLqwHLAqVKTbMs+ZlRlBLI0tkZwlw3Ht3B29nTSAIVjcRCHusEamDGDfvCM7VHDvgfJgjSaUxh7JhEwlkNkfoR49hmBxmGAgcu1cZRqOBpCfQOEcfey9WkjclOMucoKTm7b9bWzZEXprA+7kLaCjNJn3OW1650UcuVyP4YD4Y5m1oAnIDaGXuQvrBHMHNps3e4ywowunTYR4Wi8XBHDzb13mlqGpm4NHZrV4ZD+PU7KpvXp6JRBD6OrwtrtDPVYb9EH7G5zgKj3umlFlkSqyl0t2M/XhfgVlLqwxNwB1eO3v17g3M4floIpKdyf8XAY/fXP588evVBdtlburm73g0GU34yNlAtTQ7ru5dTO+P7npL+f+re2xPW4RLGjstVaT/mKl1z9s3m2urSES6e4WdJqKygVhkvZ7JgL973bZ8/KlBzwtimoi59ErOmN1u1iJXgZ/zzVX0szl6+lt/q30GX3YbfhDQQM6GmXkudcNvIhF3uLp3LW+nbTIwNEfcSZxlGTra0T1Y2nub7/zizcX1hUiEbDiDu8vhLi6H/oEdPBja/tboYuBfXmAPKnzP/fMaVz9sxLsvn1XoIQ7SnKZp27b/AJOSt2k=",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/ZUJX5oA8u7acVJUKIq6tZEaCZqgdhGgzsLgSiOJMUUy5GgvWOitX9JP65cUQ0l78TpGAxRBX3Ylam5nLme4FiTLINIbcY2105IwiGkicgyZV46UNSIV1xXCOWokhEEKzt5dgvN2rnIMsLINLBRVQBWCnCmtaAVkwWNt5wgSgsNMFSoDGvQLb+soPpyEEVwWILcSKoCxoK0p0YNBzDEXibAOveS4LnORijxGNQQlEuGklzUSesa0FkbWKFIx2LxVbEIxJiepEveBXp6DLfaiAqokRe+BAc0QOpdsx+OnRnnMRUq+wUQEWmn2FlTtNAeDS6dtjiItpA4skFVYS5GuBa1clCSvTCkSUVhfS9qetO2U7QdnTcDAGieTCf/dK8wQZR8UhCbLMISi0Xr1RCQis4bQEGtK57TKYurGHwOrrw8DsrOPmBHn0XOiSXXOu2PO+GHouJQRbip+WlYnMrhf3HPRJn1p8jN6XOlkcvL86HhyNPn2+vhlevpd+uLlaDKZ/CESsaw16/Y1zLnAbSJIkd6+twdi0e2eYH/SsvDpQ2m8sjVSpUwJCzQEC29NmYDTKAMC+RXIUioDnGn/H2YVvbf+8ex8WWTtDmpltDJ4O/TQ7elkcnu8ScLpI71kLEFhG5N/XagP+X8c0Ontyw2gF4eALs1capVHprq2d2i+Lp5d99S5P+xW1QnF72IP7O55BzJg1nhFq0hsyyPp1FH3Pb2ZMl1wp9gtKUYypEqkYjyQ2Xi9Q4StYJN+PlBl47VIRUXkQjoeB2nymV2OrEMTVGm0nIVRZuuxdGo8PxZtcl9DOvcF0oFkqUx59KjWdAv6igvT5X4P+qYC0qnXuBLJkNldqZ7yK5Q5+lgFZQoblft8v3VorlRpYrXmxweL4T3qzNbIK4C3wyD+959/RY3cZk2NhmIzPYG3jQdnF+iLRoM0ORQal2qmu60ptbaLbmeShYCy1hiCXoEyhKWPdK5KRVIDZ4WHP5Ou26oKA4tZ1vaw08FhBO8rpAo9f/rG89LNcY6auxa0tXdshyzIhmwdffQxw8L6u4JDSkDCrAnKYAgQEAcVNJU0GcJQiwSsB2kADaF3XgUEqWoWLqwHLAqVKTbMs+ZlRlBLI0tkZwlw3Ht3B29nTSAIVjcRCHusEamDGDfvCM7VHDvgfJgjSaUxh7JhEwlkNkfoR49hmBxmGAgcu1cZRqOBpCfQOEcfey9WkjclOMucoKTm7b9bWzZEXprA+7kLaCjNJn3OW1650UcuVyP4YD4Y5m1oAnIDaGXuQvrBHMHNps3e4ywowunTYR4Wi8XBHDzb13mlqGpm4NHZrV4ZD+PU7KpvXp6JRBD6OrwtrtDPVYb9EH7G5zgKj3umlFlkSqyl0t2M/XhfgVlLqwxNwB1eO3v17g3M4floIpKdyf8XAY/fXP588evVBdtlburm73g0GU34yNlAtTQ7ru5dTO+P7npL+f+re2xPW4RLGjstVaT/mKl1z9s3m2urSES6e4WdJqKygVhkvZ7JgL973bZ8/KlBzwtimoi59ErOmN1u1iJXgZ/zzVX0szl6+lt/q30GX3YbfhDQQM6GmXkudcNvIhF3uLp3LW+nbTIwNEfcSZxlGTra0T1Y2nub7/zizcX1hUiEbDiDu8vhLi6H/oEdPBja/tboYuBfXmAPKnzP/fMaVz9sxLsvn1XoIQ7SnKZp27b/AJOSt2k=",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:l}=a;return l||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(a.p,{children:"Delete Template"})}),"\n",(0,s.jsx)(r(),{method:"delete",path:"/template/{template_id}"}),"\n",(0,s.jsx)(a.p,{children:"The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed"}),"\n",(0,s.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(l,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(a.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.jsx)(m.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be deleted",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template deleted successfully!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Bxh2aspHp3"}}),(0,s.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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "objectId": "Bxh2aspHp3",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Something went wrong, please try again later!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Template not found!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(p.Z,{responseExample:'{\n "error": "Template not found!"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(a.p,{children:"Invalid API Token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(l,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(a.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(o.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)(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,s.jsx)(a,{...e,children:(0,s.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/ada7accb.774fa7a2.js b/assets/js/ada7accb.40681dfc.js similarity index 58% rename from assets/js/ada7accb.774fa7a2.js rename to assets/js/ada7accb.40681dfc.js index e61494eeb..fcbbe1a7c 100644 --- a/assets/js/ada7accb.774fa7a2.js +++ b/assets/js/ada7accb.40681dfc.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4641],{1272:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>j,metadata:()=>x,toc:()=>y});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),m=s(5397),c=s(4667),p=s(9472),h=s(85162);const j={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:"eJy9V9tu20YQ/ZXJvjQBaF0cJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0NdIPCtX9JP65cUs5RkynaMugjyIomc++3MaC1IVkGkF+JXqwv0YpaIAkPulSNljUjFeY1wggQ9HY7fnYLU2i4CrGwLZMEjeYVzhAJJKh1AZrYlkBAc5qpUOZRRdCQSYR16yYpPC5GKCqkniUQ46WWDhJ6dWQsjGxSp6MmXqhCJUOyNk1SLmy7a7CPmdFqALWGn0OOnVnksREq+xUQEWmlWGVTjNIpE4NJpW6BIS6kDM+Q1NlKka0ErFznJK1OJRJTWN5KGb3Apo5ZUuN+mWZ0f1i4TXTdjs8FZEzCwosPJhL/2vQ1tnmMIZathlw6RiNwaQkPML53TKo+E8cfAQuvb3vVBc+Y8qyHVm9zm4sFx1NOsXh5+dKJLNml/E2vwMDUGF9sSdLGoaKjvnIe79PLQyPDsSr3Dm7r+r2ehzQbe5R4lYXFMd6m6FjycHD49mE4OJt+eT5+nR9+nz56PJpPJnyIRy0az7KZZC0nRU1Kkh8+tK76CncGLzdR4DKLrmHB0Vx+e2QapVqaCBRqChbemSsBplAGB/ApkJZUBLQn9oy/XoOi99fdn4mGeDSNXRiuDl9shvDyaTC6nuyQc3U5CnyowlqC0rSlGXyHQ+7r0tj/3h3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxOEhTZHY5sg5NUJXRMguj3DZj6dR4PhVdclNCOvcA7kCyUqY6uFdqdh3tGVekT/pezLvUS6de4Uok25QOuTaLs0YZYa/j59JG4U2i3zo0Z6oysUzz6a31+h51bhvkXU81wpb9n7/+jhKFzdsGDcUuegRvWw/OLtDzgpOmgFLjUmUa7zgdAspGYwh6BcoQVl4SQqEqRVIDZ4UxIJdOZkor7jtmsyztYdC6YQTva6QaPZO+8QgSCpyj5nYFbe0V6yELsiXbRBsbn2Fh/VXJLiUgIWuDMhgCBMStCJpamhxhW4sErAdpAA2hd14FBKkaZi6tByxLlStWzEPmZU7QSCMrZGMJsN+cBeftXBUYwNusDQTB6jYGwhYbROpDNIhFGMEvao594Pyyv7KwgKplFQnktkDYzByHYQrIMBA4Nq9yjEoDSU+gcY4+9l6sZNlqDc4yGCip+Xoa1pYVkZcmMF71Dm1Ls0uf85ZvmWijkKsRfDAfDMM3tAG5AbQyVyH9YA7gYtdm7zELinD2eDsPi8Xi1hw82Zc5UVS3GXh09lquii/j1AzFdw9PRCIIfRPelmfo5yrHzRB+xuY4Mo83ECnzCJHYSKX7GfvppgDDlVY5moADQDs+efca5vB0NBHJYPL/g8Pj16c/v3hz9oL1Mjb18zcdTUaTeALZQI00A1PXh/nNqV1fw/yXPeE3kEO4pLHTUkXMjlGuN3h7IXZHeHp9wM8SUdtATF6vMxnwD6+7jl9/atEzos8SMZdeyYxR6WItChX4d7G70D8b4OPfN8f+E7jzv8CdPm+x0zBwzqVu+Ukk4gpXe/88ulmXbOGT3erpx3mOjgaSt1bp3j46eXEuEiFbzs8Qtq8ibG9+sPY7vdrH894B/uTVcqfAD1zjV7j6ccfeUz4rsIlvy80ZmnVd9y+Lm+Fr",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/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:"eJy9V9tu20YQ/ZXJvjQBaF0cJ22JoqjRpq6TIAlqFwHqCMaSHJIbL3c3u0NdIPCtX9JP65cUs5RkynaMugjyIomc++3MaC1IVkGkF+JXqwv0YpaIAkPulSNljUjFeY1wggQ9HY7fnYLU2i4CrGwLZMEjeYVzhAJJKh1AZrYlkBAc5qpUOZRRdCQSYR16yYpPC5GKCqkniUQ46WWDhJ6dWQsjGxSp6MmXqhCJUOyNk1SLmy7a7CPmdFqALWGn0OOnVnksREq+xUQEWmlWGVTjNIpE4NJpW6BIS6kDM+Q1NlKka0ErFznJK1OJRJTWN5KGb3Apo5ZUuN+mWZ0f1i4TXTdjs8FZEzCwosPJhL/2vQ1tnmMIZathlw6RiNwaQkPML53TKo+E8cfAQuvb3vVBc+Y8qyHVm9zm4sFx1NOsXh5+dKJLNml/E2vwMDUGF9sSdLGoaKjvnIe79PLQyPDsSr3Dm7r+r2ehzQbe5R4lYXFMd6m6FjycHD49mE4OJt+eT5+nR9+nz56PJpPJnyIRy0az7KZZC0nRU1Kkh8+tK76CncGLzdR4DKLrmHB0Vx+e2QapVqaCBRqChbemSsBplAGB/ApkJZUBLQn9oy/XoOi99fdn4mGeDSNXRiuDl9shvDyaTC6nuyQc3U5CnyowlqC0rSlGXyHQ+7r0tj/3h3d0+d0uvGe3wzs1c6lVEVH73F6h+bqFHJqn3jy7ut/OqmeKdLEX7PB9H2TAvPWKVnFHLA+kUwc9Pb2YMfpy39jNaolLhWqRinGf1fF6t046wbr8fLtuWq9FKmoiF9LxOEhTZHY5sg5NUJXRMguj3DZj6dR4PhVdclNCOvcA7kCyUqY6uFdqdh3tGVekT/pezLvUS6de4Uok25QOuTaLs0YZYa/j59JG4U2i3zo0Z6oysUzz6a31+h51bhvkXU81wpb9n7/+jhKFzdsGDcUuegRvWw/OLtDzgpOmgFLjUmUa7zgdAspGYwh6BcoQVl4SQqEqRVIDZ4UxIJdOZkor7jtmsyztYdC6YQTva6QaPZO+8QgSCpyj5nYFbe0V6yELsiXbRBsbn2Fh/VXJLiUgIWuDMhgCBMStCJpamhxhW4sErAdpAA2hd14FBKkaZi6tByxLlStWzEPmZU7QSCMrZGMJsN+cBeftXBUYwNusDQTB6jYGwhYbROpDNIhFGMEvao594Pyyv7KwgKplFQnktkDYzByHYQrIMBA4Nq9yjEoDSU+gcY4+9l6sZNlqDc4yGCip+Xoa1pYVkZcmMF71Dm1Ls0uf85ZvmWijkKsRfDAfDMM3tAG5AbQyVyH9YA7gYtdm7zELinD2eDsPi8Xi1hw82Zc5UVS3GXh09lquii/j1AzFdw9PRCIIfRPelmfo5yrHzRB+xuY4Mo83ECnzCJHYSKX7GfvppgDDlVY5moADQDs+efca5vB0NBHJYPL/g8Pj16c/v3hz9oL1Mjb18zcdTUaTeALZQI00A1PXh/nNqV1fw/yXPeE3kEO4pLHTUkXMjlGuN3h7IXZHeHp9wM8SUdtATF6vMxnwD6+7jl9/atEzos8SMZdeyYxR6WItChX4d7G70D8b4OPfN8f+E7jzv8CdPm+x0zBwzqVu+Ukk4gpXe/88ulmXbOGT3erpx3mOjgaSt1bp3j46eXEuEiFbzs8Qtq8ibG9+sPY7vdrH894B/uTVcqfAD1zjV7j6ccfeUz4rsIlvy80ZmnVd9y+Lm+Fr",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={},y=[{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:"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)(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)(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)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(m.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)(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)(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:"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)(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)(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)(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)(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)(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: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/bbdfc22d.46db2c31.js b/assets/js/bbdfc22d.46db2c31.js new file mode 100644 index 000000000..2a6de6036 --- /dev/null +++ b/assets/js/bbdfc22d.46db2c31.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1531],{60877:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>y,frontMatter:()=>p,metadata:()=>x,toc:()=>g});var a=n(85893),i=n(11151),l=n(58219),t=(n(62316),n(51039)),r=n.n(t),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/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+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbseiFDJcZZWNueSJeiYPrIVslmyu2+q2d0MbymZCz/p2rLlpWz0gdXuJrDLdhViW+Q4qzgjy7UAkTZAY5cvJUJEHS8k/tC+brqKv4ttj6XGiVsvkAiPH/Wki/eRNsCdI7Mfp5DJBdzNuEvKzliDVhKf1sAs3z1vSamC6GdEMXCx0dH7ug4dnQ3a6Pn7uL6/jp6sJLuOPEvaMmeU2VE25g+LRCeSZmvp/renj7RsYiVSW6fF+OEMH/869/uxWxJcgdsS/gtNZQqTlq6seiHpZpgQtBnSGddjF6cLhkJC8LNIZeIdLizLdaiZnLpxPH5EFSXvGJKAQdSgJTvu7UOddmAD/nSOkJmvpS+9LCNRZ0lqFQ6sr1xCjgtVVlt50L5kpfTYmkBDhMqHkGjQGDGJegzLlMKavgbTUBpYFLQGlRV1oYBC5KAqYsBk6nIhWEmDyQ5qmFkks+Q9oscZEBSaGKrS9aTShpaVRR+1QINeAgWs+iy2oM4DV1MznGaTBDy0WBGcxqQpEAGTEEh0RsyAwmaCxUtL1I0bRFxAKvUbuz6TRJdxBUijyl4AWFMV3dEiKruTQUe3iComoa8VVa0WXm9sj4cgCUQCHnT4EQGUAh5BV1gvXhvDGzn3FihMU2KprP57f8xKP1Nd8Im9cT0Fipdt3MDTqv0l3efDyiU426NKfTM9TXIsXgpHbseeCAD8L9wVN3f8Szyivx980F5MsLkaI02PH2L7558z1cw+PBIUs6nvEjCD74/uTV1z+efU14yXf78zccHA4O3VNOGVty2dnqle+2fNv6qo1EQ3MR7ls49y2c+xbOfQvnvoVz38K5b+F8SDztWzj3LZz7Fs7fs4Vh38K5b+Ec71s4Yd/CuW/h3Ldw7ls49y2c+xbOfQvnvoVz38L5f9TCGeqCFDEdVAUXrrDsqg03oSZ8vtnYeZGwnIrGo3N2c0PZ43e6WK1o+EONmirOFwm75lpQFtDVm5NYV6VK5BUuqeTgKwr9t7R/4q3OlUc2yuxUFvYrXjg13QnbrWu/OT17yxI2Cc2npcpojeZzakzlczai6JS5JlYnYdd+yF1nUcHlrHbFUebxUjmY1zZfryVfuVpy+NGpsXK57FC5XmT2rNBfYmzrgr9SjeI7XP6tAfczOxcE2UZoUuHFarX6L+XZB5g=",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+Pzi9WF2R1NlcUtVfKOIq5zdmIHdwK4l2TDUWI5zes1gUbseiFDJcZZWNueSJeiYPrIVslmyu2+q2d0MbymZCz/p2rLlpWz0gdXuJrDLdhViW+Q4qzgjy7UAkTZAY5cvJUJEHS8k/tC+brqKv4ttj6XGiVsvkAiPH/Wki/eRNsCdI7Mfp5DJBdzNuEvKzliDVhKf1sAs3z1vSamC6GdEMXCx0dH7ug4dnQ3a6Pn7uL6/jp6sJLuOPEvaMmeU2VE25g+LRCeSZmvp/renj7RsYiVSW6fF+OEMH/869/uxWxJcgdsS/gtNZQqTlq6seiHpZpgQtBnSGddjF6cLhkJC8LNIZeIdLizLdaiZnLpxPH5EFSXvGJKAQdSgJTvu7UOddmAD/nSOkJmvpS+9LCNRZ0lqFQ6sr1xCjgtVVlt50L5kpfTYmkBDhMqHkGjQGDGJegzLlMKavgbTUBpYFLQGlRV1oYBC5KAqYsBk6nIhWEmDyQ5qmFkks+Q9oscZEBSaGKrS9aTShpaVRR+1QINeAgWs+iy2oM4DV1MznGaTBDy0WBGcxqQpEAGTEEh0RsyAwmaCxUtL1I0bRFxAKvUbuz6TRJdxBUijyl4AWFMV3dEiKruTQUe3iComoa8VVa0WXm9sj4cgCUQCHnT4EQGUAh5BV1gvXhvDGzn3FihMU2KprP57f8xKP1Nd8Im9cT0Fipdt3MDTqv0l3efDyiU426NKfTM9TXIsXgpHbseeCAD8L9wVN3f8Szyivx980F5MsLkaI02PH2L7558z1cw+PBIUs6nvEjCD74/uTV1z+efU14yXf78zccHA4O3VNOGVty2dnqle+2fNv6qo1EQ3MR7ls49y2c+xbOfQvnvoVz38K5b+F8SDztWzj3LZz7Fs7fs4Vh38K5b+Ec71s4Yd/CuW/h3Ldw7ls49y2c+xbOfQvnvoVz38L5f9TCGeqCFDEdVAUXrrDsqg03oSZ8vtnYeZGwnIrGo3N2c0PZ43e6WK1o+EONmirOFwm75lpQFtDVm5NYV6VK5BUuqeTgKwr9t7R/4q3OlUc2yuxUFvYrXjg13QnbrWu/OT17yxI2Cc2npcpojeZzakzlczai6JS5JlYnYdd+yF1nUcHlrHbFUebxUjmY1zZfryVfuVpy+NGpsXK57FC5XmT2rNBfYmzrgr9SjeI7XP6tAfczOxcE2UZoUuHFarX6L+XZB5g=",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)(l.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 y(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 deleted file mode 100644 index f3795fdee..000000000 --- a/assets/js/bbdfc22d.f156ca0b.js +++ /dev/null @@ -1 +0,0 @@ -"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.d4605a99.js similarity index 64% rename from assets/js/bfe4b778.b61a7ff2.js rename to assets/js/bfe4b778.d4605a99.js index 9206eb814..bbf9cb382 100644 --- a/assets/js/bfe4b778.b61a7ff2.js +++ b/assets/js/bfe4b778.d4605a99.js @@ -1 +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 +"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:()=>g,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var l=s(85893),n=s(11151),t=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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLdqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0GYoN2E3gUOfv+3j+uMIgph7Tc3xusqokHTyOE8zJZ07aII3GFM9mBB9sLgJBJwVHJ8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxher5CLUrCFDtblzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfR50o6yjENrqIEfVgq9uZlaRVhgnRtlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT5yZy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzk2dvqZuhm8omyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMCUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8aW+jjXWdYJBhy9RlLzcvJ3zVdc1yjrw12jesHoxGNzNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8MqfHL6yTEgb0lG4W+lgdPB4b3+0N/rxbP9pevhT+uTpYDQa/Y4JXpdqk0/I1rDPXvy/dyC1kpouO9YuD0ajy8ctlYe3sddmi23LaC6UzKGQpHJgn/47EkjOGfcPs/mO+O6Cz5A78Id3pA434cJUOv+v4d4W0d0ADy8P1xCf3IR4rBvKeDKdmSvS/wbCDZ6++9C451C3s1o2QvE7boHtnzcgPWWVk2EZx9r1nrByr/meno95WJQUZoZHoq2aORhmmOKw6y7DVa/P1Mj23LybkpVTmOIsBOvT4dALnU/M9cBY0txBlZj4QWbKobByON/HOtnVENbeQ9oHMZV6unen1niD+JRvpSF+C/eafmHla1pi0tHal2qn/YxETi5eAV/2+81kfdFd2fpWdsdRN42+bcDsrhS3joz+xEC+eakLExG1GfDOkj5l45w/8/0bVj+SykxJPO15W+nE//rjz6jROY3p/QDeVQ6sWZArKhXjLhRdy4mi/kLIa1kw4EmUirxXS5A60NTxKpHLqQxCRbxSTyETVkykklwQLGZY20GvpvwAPs4ozMjxpx8cL4I5zUlxHYEy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngleFLsEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5+p3IApRCiymxswQ4bmahbbQenJlUPoA3qopA4o5MFBqIcRMcwHM5pwY4HzbLMuUwrdhEApnJCdpmwDB0DhPyASy7lxlFoz4Ix3vZnFwsiGYNrpQCa7hLSaF4G+3fLRsKTmjPrbQJqLuaNX3WGd4Coo9cLAdwoS/0KSdL5YkTQEl95dMLvQfn6zT7SBMvA40fdkW6WCxuFOejbZ2XMsyqCTiyZqM3jYexlPvq63941QzkSv+uOCU3lxm1neELPodReNj2bpHF3k2lkKop/F93FbialMxI+35NH708eQNzeDwYYdJrR98Q8PDN8bMXb09fsF1umE397Q9GgxEfWeNDKXTP1c6ba7d0V5sh9H99orVtOdB1GFolZJxtkfRVO5fOsdcv0/7rbJzgzPjAIqvVRHj64FRd8/HnihxPv3GCc+GkmHCjPF9hLj3/ztevrC/S/fB9996B+z30bgXUDR/Nk2cuVBVX/ASvaLnz4qzHddJNII64kXjWxLV3xnY2Fm7sJTxAG42jLCMb7pTtLwInH84wwUn7eizjQxSdWPDLVSwwxQu8wPiijn2OheL5CpXQ00pMWb4xy3NTVHxz/aF7FYdu+4OB3UrJ9jRukPBfxnWrws+cqa9p+ctavPnyRYWW2k6ar2dc1/Xf0BH9SA==",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:"eJzdV91u2zYUfpXTc7MWUGwnTTtMGIZlbdEGLdqgSVFgiRHQ0pHNhiJZkrJjGLrbk+zR9iTDoSRbdtK0GYoN2E3gUOfv+3j+uMIgph7Tc3xusqokHTyOE8zJZ07aII3GFM9mBB9sLgJBJwVHJ8cglDILD5Un5yEYKE0uiyUInUPViIcZQU5BSOXBFCDAW8pkITPIW0MDeGuioAgQZtJHw0arZWc9mM6YgIIWYIUTJQVyPoGlqSATWpsA2UzoaeOwkIrA6IxAhiaCLmjpIXMkAuUDTNBYcoIhHueYYuOkw4cJbhxher5CLUrCFDtblzLHBCXTY0WY4S5nx88Z8Jb3iFET5RHUhFpcbMfR50o6yjENrqIEfVgq9uZlaRVhgnRtlckJ00IozwLZjEqB6QrD0kbJ4KSeYoKFcaUIm5O6Hjf2yYffTL5kne1QT5yZy5xgQsr0+O0xH6i0SgTy8FAEUCR8AKOpJ9sBeIQJZkYHpjBdobBWySySPPzk2dvqZuhm8omyyLjjKwmSPH9tCP86QCZHRJpS9PHHmnKsE9Qm3NvMCUMkcDSXtIj57OVUN/nZt73F4/1crLOib6NmHZWT44y8aW+jjXWdYJBhy9RlLzcvJ3zVdc1yjrw12jesHoxGNzNgXdVtRoKvsoy8Lyqllg++35U2x18DJ3x+8MqfHL6yTEgb0lG4W+lgdPB4b3+0N/rxbP9pevhT+uTpYDQa/Y4JXpdqk0/I1rDPXvy/dyC1kpouO9YuD0ajy8ctlYe3sddmi23LaC6UzKGQpHJgn/47EkjOGfcPs/mO+O6Cz5A78Id3pA434cJUOv+v4d4W0d0ADy8P1xCf3IR4rBvKeDKdmSvS/wbCDZ6++9C451C3s1o2QvE7boHtnzcgPWWVk2EZx9r1nrByr/meno95WJQUZoZHoq2aORhmmOKw6y7DVa/P1Mj23LybkpVTmOIsBOvT4dALnU/M9cBY0txBlZj4QWbKobByON/HOtnVENbeQ9oHMZV6unen1niD+JRvpSF+C/eafmHla1pi0tHal2qn/YxETi5eAV/2+81kfdFd2fpWdsdRN42+bcDsrhS3joz+xEC+eakLExG1GfDOkj5l45w/8/0bVj+SykxJPO15W+nE//rjz6jROY3p/QDeVQ6sWZArKhXjLhRdy4mi/kLIa1kw4EmUirxXS5A60NTxKpHLqQxCRbxSTyETVkykklwQLGZY20GvpvwAPs4ozMjxpx8cL4I5zUlxHYEy5ortBAOiCqaMPjqiFsZdFRxSAgImlZeavAdP1KmQngleFLsEScA4EBpIB3LWSU8gZMnChXFARSEzyYa5+p3IApRCiymxswQ4bmahbbQenJlUPoA3qopA4o5MFBqIcRMcwHM5pwY4HzbLMuUwrdhEApnJCdpmwDB0DhPyASy7lxlFoz4Ix3vZnFwsiGYNrpQCa7hLSaF4G+3fLRsKTmjPrbQJqLuaNX3WGd4Coo9cLAdwoS/0KSdL5YkTQEl95dMLvQfn6zT7SBMvA40fdkW6WCxuFOejbZ2XMsyqCTiyZqM3jYexlPvq63941QzkSv+uOCU3lxm1neELPodReNj2bpHF3k2lkKop/F93FbialMxI+35NH708eQNzeDwYYdJrR98Q8PDN8bMXb09fsF1umE397Q9GgxEfWeNDKXTP1c6ba7d0V5sh9H99orVtOdB1GFolZJxtkfRVO5fOsdcv0/7rbJzgzPjAIqvVRHj64FRd8/HnihxPv3GCc+GkmHCjPF9hLj3/ztevrC/S/fB9996B+z30bgXUDR/Nk2cuVBVX/ASvaLnz4qzHddJNII64kXjWxLV3xnY2Fm7sJTxAG42jLCMb7pTtLwInH84wwUn7eizjQxSdWPDLVSwwxQu8wPiijn2OheL5CpXQ00pMWb4xy3NTVHxz/aF7FYdu+4OB3UrJ9jRukPBfxnWrws+cqa9p+ctavPnyRYWW2k6ar2dc1/Xf0BH9SA==",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document",permalink:"/docs/API-docs/getdocument"},next:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"}},f={},y=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,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)(t.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 g(e={}){const{wrapper:a}={...(0,n.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.7bf95e17.js b/assets/js/f0ff4a36.5db055b4.js similarity index 87% rename from assets/js/f0ff4a36.7bf95e17.js rename to assets/js/f0ff4a36.5db055b4.js index ef41bae95..10396db23 100644 --- a/assets/js/f0ff4a36.7bf95e17.js +++ b/assets/js/f0ff4a36.5db055b4.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),n=s(58219),r=(s(62316),s(51039)),t=s.n(r),m=(s(82723),s(9487)),c=s(41429),o=s(5397),d=s(4667),p=s(9472),h=s(85162);const u={id:"getdocument",title:"Get Document",description:"The Get Document API enables you to retrieve details about a specific document.",sidebar_label:"Get Document",hide_title:!0,hide_table_of_contents:!0,api:"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/GNMJRpuhmSg3Tqc9ZzPptAfRXncm0YiTPztrZtbSyMwo5rrJEL3raoCIAlzxx1Kj63Ij+jPrPbQ5uzB7UzvOpUNODB7nGG48v6FTqwG/5vel9RrxFan5NWLtUzQyeIw+jR0XfEx2Ym2CfG1QEq+GoZsOdJvgRZaoLpMuDzxFa8r///CtwtGENmfQEzksLRs/R0qTMVQYTiQuRSAzEnBrq+i7ikBcSnZNLEMrj1HKPkImp8FyGVkuVn3LDEyEF5R6RaeK20Elf14OPOfocLW19ZxE4ZDhDSSkLUusbkuM18NLrIuhoi22u7c2ETIqAQ1I6odA5cIgtC6qcqxShPYsItAWuAJVHa6xwCFwURDzRFnAyEakgwVRolqceCq74FElZBGQ3RcFYPRMZOrA6KZ0Hp2UZHCGNBaKvXVSImevBazHD2nFarK9tmMG0JBERpDpDaOqO3FAZJOg8GFIvUgxCnefWg8QZ2pB74SQnpZRgNAGC4JIuYt2zJUHecuWok9cGtUezDp+xmi5FQUfGlz34pD4pAm0oHVICSKFuXPxJHcDVOs0+YuKEx/HTth7m8/lOHTzb5jkVPi8TsGj0hm8aFkPVdNnXH89YxDzawp1PLtDORNred+7R2Q/E/QYmeRpgshlpqcZe3WYgyJIiReWwA2onp+/fwQyOegMWdSr/Kwzuvzv76c1vF29ILmFTXX/D3qA3CEOydr7gqqOqe9m/XberDdj/Dw8DDfJ4XPi+kVwE+A7OrhrovWKdt4K4+ywwjliunSeS1SrhDj9YWVW0/KVESwA/jtiMW0H2BXzOhKPf2frWf6+nT39vHhCewT0vDHda3gKpIhQN0z6LGYvYDS5vvWlUY5qUazQl02qKkzRF4zu8O911q0WdvrlkEeOlz7dR/CagePODpN9p1za81wbQX+o0dzL8QMf9Fpc/rsnrnXsZGv9aaorRuKqqfwDUTV8b",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/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/GNMJRpuhmSg3Tqc9ZzPptAfRXncm0YiTPztrZtbSyMwo5rrJEL3raoCIAlzxx1Kj63Ij+jPrPbQ5uzB7UzvOpUNODB7nGG48v6FTqwG/5vel9RrxFan5NWLtUzQyeIw+jR0XfEx2Ym2CfG1QEq+GoZsOdJvgRZaoLpMuDzxFa8r///CtwtGENmfQEzksLRs/R0qTMVQYTiQuRSAzEnBrq+i7ikBcSnZNLEMrj1HKPkImp8FyGVkuVn3LDEyEF5R6RaeK20Elf14OPOfocLW19ZxE4ZDhDSSkLUusbkuM18NLrIuhoi22u7c2ETIqAQ1I6odA5cIgtC6qcqxShPYsItAWuAJVHa6xwCFwURDzRFnAyEakgwVRolqceCq74FElZBGQ3RcFYPRMZOrA6KZ0Hp2UZHCGNBaKvXVSImevBazHD2nFarK9tmMG0JBERpDpDaOqO3FAZJOg8GFIvUgxCnefWg8QZ2pB74SQnpZRgNAGC4JIuYt2zJUHecuWok9cGtUezDp+xmi5FQUfGlz34pD4pAm0oHVICSKFuXPxJHcDVOs0+YuKEx/HTth7m8/lOHTzb5jkVPi8TsGj0hm8aFkPVdNnXH89YxDzawp1PLtDORNred+7R2Q/E/QYmeRpgshlpqcZe3WYgyJIiReWwA2onp+/fwQyOegMWdSr/Kwzuvzv76c1vF29ILmFTXX/D3qA3CEOydr7gqqOqe9m/XberDdj/Dw8DDfJ4XPi+kVwE+A7OrhrovWKdt4K4+ywwjliunSeS1SrhDj9YWVW0/KVESwA/jtiMW0H2BXzOhKPf2frWf6+nT39vHhCewT0vDHda3gKpIhQN0z6LGYvYDS5vvWlUY5qUazQl02qKkzRF4zu8O911q0WdvrlkEeOlz7dR/CagePODpN9p1za81wbQX+o0dzL8QMf9Fpc/rsnrnXsZGv9aaorRuKqqfwDUTV8b",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 y(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(b,{...e})}):b(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.a3e642f7.js b/assets/js/fa40969b.e68bf28a.js similarity index 73% rename from assets/js/fa40969b.a3e642f7.js rename to assets/js/fa40969b.e68bf28a.js index 47d55eb43..5adfe4580 100644 --- a/assets/js/fa40969b.a3e642f7.js +++ b/assets/js/fa40969b.e68bf28a.js @@ -1 +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 +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var n=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),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/itn7IethWLLidNuwnCxYO0Nsg23RZOhwG2MgJKOLTYUyZGUX2Do2/0l+2n7JReHkmw5TtJ4G/ppXxKLPO98zgu5Zp7PHEs+stc6q0pU3rFJxHJ0mRXGC61Ywp49ewbdNlytDLrkWr1HbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAL168tnzqN5Jc8uLFtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpn9cyic39KqmmZg8QTkvijLo1Ej/lT5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsXfKmExBydmivvKYqNzTDrfLE3Ye6pGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6z3yq0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6z/M3y4TefUxQaLjfQUnnO/v3ubg9PkmLX3+imEwFLR4mofDeuGQ4bFcqKweZLkmaF/5wcS78oFQhEUr7gyUYidxhKEqbjAvOaZmj/VKhbDB8mITGQgis9TaArPPipnWhjpheqB1fniT/kw6FkPgpOqGa/VnAWX3/2W61ZagfC8S9ZmHJhfwsdYr4Q7vQYc0UWn1Gzfj05fHo5NtXI6JfiHyG/i/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBz6dDRk9HL/ULW496sbLiPx+M6YqsDuV6NKD4HMp18W0esOJBp/JJOjs/wQL5RPzk8lkZyjzeXDaRvuqOtH6MK+eVQ5Rfqrd0tC6nWErnqKwy9po5YZpF7zM/840g7jo9PjkbxUfzqavQyGX+XnL4cxHH8XxaxZRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mtx0XfPmOI5vxkRSR2wcj/e753s02npQ2gOfcyF5KvGrv699orX63nK4Ddb9Fjzm1Dge35xunDrdd+pCzbkUOZy9u4ArfYvqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuMsjbsRRs598nNCQVKIvdDsgh6HYFyxhw/6sPFy3Q3HNSJ6ddyNzZWVvWHBc5aleDrRBRSVO8tRRKR9yI4ZzqtB3ObgxB1A7z2dCzY4e5ZpsPb6kU2kCv+P3tjsY8TNSe2jD2qdqR9QCeWjONX1PdWBug/3WoKLCE45qPtprEx9QZrpEuhbQvaQj/+N/vweOLsABSV/B28qC0Qu0NIvSfWkqcUn3o0DMqeU4WOmKxDnkpUTnwtXQ48xyj5CLmfBchmYk1AwybngqpCDsEZkmbgs9+LoBfCjQF2hp62tL9+Mc5ygJsiC1viU5XgOvvC6Dju5mvdD2dkomRcAhrZxQdLF1iB0LqoKrDKE7iwi0Ba4AlUdrrHAIXJREPNUWcDoVmSDBlGiWZx5KrvgMSVkEZDdFwVg9Fzk6sDqtnAenZRUcIY0lom9cVIi5G8BrMcfGcVrM0XMhMYdZRSIiyHROF9SQd+SGyiFF58GQepFhEOo8tx4kztEG7IWTpLszGE0FQXBJd8D+2ZIgb7ly1Osag7qj2YTPWE3XjqAj56sB0B34ksBSOSQASKFu6eXiCD5uYPYBUyc8Tr7p8mGxWOzlwfNdnnPhiyoFi0Zv+WZhMWRNn33z8ZxFzKMt3dvpJdq5yLobwQM6h4F42JZJnoUy2Q59lGM/3GWgkiVFhsphr6idnb/7BeZwMohZ1Mv8Jxg8/OXixzf/uXxDcqk2Nfk3GsSDOIyR2vmSq56qc9y+7TRPQlOry/bR5m4ir7fV/5/npX+elzbPS20T8bj0QyO5CJ044HbddtGP7M6LU9I9Lk0iVmjniWS9Joj8amVd03LzJkLNNReOxpntq8gtrnpvOOH2wRIWGuUDtO1jy5Z0Qh9WEO39Oh5E/jfv25N7Dk95/bo3OF3bVau+UZ2xXWzqCd06mr5LNja7Z1mGpu/33hy2M8ycv7liEeOVL3b7/W3o9+0Pkn6vTbuDQGMA/aVQ38vwPbWnn3H1rw15s/MgQ+tfR03xmdR1/X9uwtxv",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/itn7IethWLLidNuwnCxYO0Nsg23RZOhwG2MgJKOLTYUyZGUX2Do2/0l+2n7JReHkmw5TtJ4G/ppXxKLPO98zgu5Zp7PHEs+stc6q0pU3rFJxHJ0mRXGC61Ywp49ewbdNlytDLrkWr1HbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAL168tnzqN5Jc8uLFtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpn9cyic39KqmmZg8QTkvijLo1Ej/lT5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsXfKmExBydmivvKYqNzTDrfLE3Ye6pGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6z3yq0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6z/M3y4TefUxQaLjfQUnnO/v3ubg9PkmLX3+imEwFLR4mofDeuGQ4bFcqKweZLkmaF/5wcS78oFQhEUr7gyUYidxhKEqbjAvOaZmj/VKhbDB8mITGQgis9TaArPPipnWhjpheqB1fniT/kw6FkPgpOqGa/VnAWX3/2W61ZagfC8S9ZmHJhfwsdYr4Q7vQYc0UWn1Gzfj05fHo5NtXI6JfiHyG/i/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBz6dDRk9HL/ULW496sbLiPx+M6YqsDuV6NKD4HMp18W0esOJBp/JJOjs/wQL5RPzk8lkZyjzeXDaRvuqOtH6MK+eVQ5Rfqrd0tC6nWErnqKwy9po5YZpF7zM/840g7jo9PjkbxUfzqavQyGX+XnL4cxHH8XxaxZRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mtx0XfPmOI5vxkRSR2wcj/e753s02npQ2gOfcyF5KvGrv699orX63nK4Ddb9Fjzm1Dge35xunDrdd+pCzbkUOZy9u4ArfYvqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuMsjbsRRs598nNCQVKIvdDsgh6HYFyxhw/6sPFy3Q3HNSJ6ddyNzZWVvWHBc5aleDrRBRSVO8tRRKR9yI4ZzqtB3ObgxB1A7z2dCzY4e5ZpsPb6kU2kCv+P3tjsY8TNSe2jD2qdqR9QCeWjONX1PdWBug/3WoKLCE45qPtprEx9QZrpEuhbQvaQj/+N/vweOLsABSV/B28qC0Qu0NIvSfWkqcUn3o0DMqeU4WOmKxDnkpUTnwtXQ48xyj5CLmfBchmYk1AwybngqpCDsEZkmbgs9+LoBfCjQF2hp62tL9+Mc5ygJsiC1viU5XgOvvC6Dju5mvdD2dkomRcAhrZxQdLF1iB0LqoKrDKE7iwi0Ba4AlUdrrHAIXJREPNUWcDoVmSDBlGiWZx5KrvgMSVkEZDdFwVg9Fzk6sDqtnAenZRUcIY0lom9cVIi5G8BrMcfGcVrM0XMhMYdZRSIiyHROF9SQd+SGyiFF58GQepFhEOo8tx4kztEG7IWTpLszGE0FQXBJd8D+2ZIgb7ly1Osag7qj2YTPWE3XjqAj56sB0B34ksBSOSQASKFu6eXiCD5uYPYBUyc8Tr7p8mGxWOzlwfNdnnPhiyoFi0Zv+WZhMWRNn33z8ZxFzKMt3dvpJdq5yLobwQM6h4F42JZJnoUy2Q59lGM/3GWgkiVFhsphr6idnb/7BeZwMohZ1Mv8Jxg8/OXixzf/uXxDcqk2Nfk3GsSDOIyR2vmSq56qc9y+7TRPQlOry/bR5m4ir7fV/5/npX+elzbPS20T8bj0QyO5CJ044HbddtGP7M6LU9I9Lk0iVmjniWS9Joj8amVd03LzJkLNNReOxpntq8gtrnpvOOH2wRIWGuUDtO1jy5Z0Qh9WEO39Oh5E/jfv25N7Dk95/bo3OF3bVau+UZ2xXWzqCd06mr5LNja7Z1mGpu/33hy2M8ycv7liEeOVL3b7/W3o9+0Pkn6vTbuDQGMA/aVQ38vwPbWnn3H1rw15s/MgQ+tfR03xmdR1/X9uwtxv",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={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["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)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.da3e4160.js b/assets/js/runtime~main.8fb3e37a.js similarity index 84% rename from assets/js/runtime~main.da3e4160.js rename to assets/js/runtime~main.8fb3e37a.js index 5c0f09fc0..65dcc13cd 100644 --- a/assets/js/runtime~main.da3e4160.js +++ b/assets/js/runtime~main.8fb3e37a.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:"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:"f0312f9a",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{"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:"e68bf28a",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:"5db055b4",1477:"b31b2642",1512:"9637e502",1520:"d1814002",1531:"46db2c31",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"d4605a99",2121:"c8df990c",2125:"9a2b70d2",2207:"f380f604",2213:"d47dd20f",2241:"5104cb4f",2245:"f2a0d0c3",2267:"a4846e2b",2362:"ebdb1814",2403:"78b7485b",2529:"2079a565",2535:"f3b6b0ab",2542:"5bd0eb92",2546:"665b04f4",2617:"56321ade",2832:"e34356e0",2865:"fcf78bcd",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3156:"41df5616",3205:"af75d475",3495:"4657d57d",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"08242eba",4277:"69395083",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"a41784da",4641:"40681dfc",4651:"8538abf4",4667:"c24bbf43",4682:"18721add",4772:"07189a34",4918:"910d4a50",4955:"8f728b1e",4985:"dad32c3b",5377:"ccefc9dc",5507:"36c41078",5858:"000e7fdc",5900:"e113e88d",6011:"6de743c9",6033:"7cf37f7d",6103:"ebc8482f",6113:"53df0513",6125:"9555c68b",6177:"b22b9e91",6216:"0d890761",6344:"29bab824",6543:"7f67a86f",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7286:"0072a94c",7414:"8d31e6a7",7475:"14209b93",7596:"95bca972",7664:"7fd4bae6",7816:"38bd8c71",7894:"e09eee0c",7964:"4e6965bb",7971:"6792c484",8055:"27482879",8087:"cde5db0f",8106:"ab7168d2",8140:"901b2f91",8141:"60a9b3b8",8163:"9bf52b52",8215:"c6b04c16",8468:"7cfe3494",8474:"a75e5064",8475:"d27b3009",8489:"35a41943",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"604707fe",8781:"f0312f9a",8784:"5f29f05d",8866:"381cdff2",8878:"eda4ae1c",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"002f0dec",9035:"37598b09",9588:"5ef75d8a",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"c16c326c",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 0b6f9ec70..83366166d 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 4314db573..d77f174f1 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 1b74b1ebb..1e85713c3 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 3fdd7a47e..3857c36dc 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 798ea4262..3ad1be6c8 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 04f609bc6..7269a4bfb 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 d56e9886b..94ab93861 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 4a3bde155..76c463cf3 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 6d0095789..c0b7a77d7 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 4ca9e2ba4..a09730dc6 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 3b7a4f5a6..8b4a8ab7f 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 366746e09..6f8d44970 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 05a42398e..86c59ade5 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 cc851a489..3f1252732 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 324c16bd5..d547e48ef 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 8065fec24..556e83cd0 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 546d4c2ff..db868ae08 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 2a1d09efb..3afd8ba41 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 3c34f57fc..96ed1b6ff 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 66a259731..635f3bf75 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 823aecd5d..124e6ef71 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 b3743a4dd..e023f1834 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 1c239c795..02debe1c7 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 eba082abc..2f6537b44 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 345243276..723ce63f7 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 ddf2bcf7a..b5e0b3a03 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 694e4f77e..58c108997 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 d11f63e9d..cdd1f9783 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 7b38638e7..394a1836f 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 7a437eae6..cbb16e14e 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 87469421e..50dcb6679 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 851926573..abbf4925f 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 4fabb7967..39727ebf7 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 5fc3b5d2c..6ec1259b8 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 5dff06eae..a5fd2ec2a 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 b90cc0e27..341ec3e4b 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 ba31c7fec..2c344ae03 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 ca8415c2c..05fd97827 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 a021b66e0..36edca692 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 0b624e591..da7ce936f 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 8f24db2bc..f647d4989 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 9ad49b5b5..d1f2f109d 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 89f04ab25..6066a413e 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 28b792292..b5cd148b1 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 80a0a2fd7..3dfc34d1a 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 7ed288bd6..a9d2f9cdc 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 f34e835f3..9473e2e68 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 727441737..cad68d611 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 b11a998f2..523e48600 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 7567bc562..2ebec7153 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 f14209d95..d42b7d5f9 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 c8bd12bb9..212f9db6d 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 94a43752d..fdfc1d320 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 b27440039..4e2de46cd 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 02322e3fc..281ac21b1 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 f2a6e8a56..ce3e2a716 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 8ec3613f9..a0fc27410 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 d68d6d7e4..b4dafded5 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 d53dc3639..b119c8f14 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 75741e8b4..4d34e5c85 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 24d5aa475..266cc7784 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 d2c2d5755..0d2315729 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 9e42bc9b5..db978642c 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 951894a9c..c58e138b2 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 7c4952e11..7d1d90152 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 bf1613542..bb43d1cb3 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 47154cf76..b46694501 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 d07f83475..c744de038 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 ef768e7a9..c58c1e99f 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 0a691fbf4..6494d452f 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 da6c0f1bb..8009623a2 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 a28585445..6672a48be 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 aae206e08..4482a9758 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 1ea6a85ff..426c15f43 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 7e8aba821..9696fbd8b 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 be6173d45..dd2c1bf76 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 ccdf3d0b8..4452834a7 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 d51e2482e..6c0eeac61 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 d4b49c670..fddd6cb32 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 fbe49737d..eb18af06b 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 906c17888..719f59158 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 e0238fec4..a1a94708b 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 4a6427ceb..73b336760 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 737fa7a5d..76cc908b7 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +