diff --git a/404.html b/404.html index 78695c704..6b55a5780 100644 --- a/404.html +++ b/404.html @@ -5,7 +5,7 @@ Page Not Found | OpenSign™ - + diff --git a/assets/js/05632a52.967ec4da.js b/assets/js/05632a52.967ec4da.js new file mode 100644 index 000000000..4cac9d062 --- /dev/null +++ b/assets/js/05632a52.967ec4da.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>j,default:()=>b,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),m=s(4667),p=s(9472),h=s(85162);const x={id:"getcontact",title:"Get Contact",description:"The Get Contact API allows you to retrieve details about a specific contact.",sidebar_label:"Get Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1r20gQ/it786kB2ZIdt0fFcTSUkAstl1KnHFxiwkoaWZtIu9vdkWNj9N+PXUm2HCfH5SgFY0s788zLszPj2QLxpYX4Bj4qSTwlC4sAMrSpEZqEkhDDdYHsAol1GuzsyyXjZakeLduompFiBskIXCHLkLgoLeOJqolxZjWmIhcpS1vsGAJQGg13pi8ziGGJ1MkgAM0Nr5DQuIi2IHmFEEMnvxMZBCBcRJpTAU/DVMk9pnSZMZWzvUmD32thMIOYTI0BWNqUzqgVlS4RAsC1LlWGEOe8tE4hLbDiEG+BNtprkhFyCQHkylSchie45t5KDPqPSVKk00In0DQL59ZqJS1aZ2gaRe7nMFxbpylam9cl2zECgU8WJTl9rnUpUi8I760DbY+ja7N23BlnhkTrsifj1XkUk6RYT+81NEHH/+sM3CtkCaKDY8VF+T/wCeKH7mCcqsqZ0oWSrw5lNjmdTP3HmUgNcsLsjJ4zswdNo+npaBKNol+vJ+/i2fv47btxFEV/QwDrymfTVWXGyWdJgsrhe62zn+CnearWVXzXgENA3wtN41CzaHZci31nS0UsV7XMfvlxlYjGKPPvXDzjvhkkIGQpJN71LXU3i2Z30106b4/TuZQrXorMD6pr9YDy56YzdE+t++P7Eq2Sl8NBssPzNkmLaW0EbfxQXI+4FqNWHt8s3LCpkArVDVM/RamAGMLu4sPtfoA24KyZVT9ha1NCDAWRtnEYWuJLIZcjrvVYaZRWLGXJE+u6MORahKsJOH99PHPHWUvLQVQ7crgWn3AD/SQ50OpGeYE8Q+MJEjJXHtxRcaVRzsVSeiJXk6OBf10Iy4T14kyldYWS/KWyXBn2BM0SbjFjSjIq0Avd+el4svuP8tAxu5W3cq4qZLVFN5xLIR9sfCtH7OYqz0UqeMn+wsQKwsWbnrnHx8cjxk485kJQUSfMoFZ79aU/9LQOUbuXEwiA0FT2Kp+jWYkUu1t6wVXolcOuyl2zu0ptx29/9OEpyFVdKVKUFgd1eXbx5TM7HUcQDIrjP4Qcfr78eP7n/NxZdeXVXtFkHI0jP8CVpYrLgaPBRvH0Zrf7Zv3Ry0dXmIRrCnXJhe89n+i265sb2C8P8WD1WARQKEtOYbt1xfTNlE3jjr/XaFxvLgJYcSN44qr3ZguZsO45260WLyb55mu3pZyw57eYZ8Pum0y6DlvxsnZvEMADbg63pmbRBH2jucBahbM0RU0D6NFYPJgtF+fXEACvHUfDBn/wDd49OOvPhnXY+W0A7rsJXgD85i76E25+36m3khcBXX69tqNo0TTNP75Yrp4=",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:"eJy9Vm1r20gQ/it786kB2ZIdt0fFcTSUkAstl1KnHFxiwkoaWZtIu9vdkWNj9N+PXUm2HCfH5SgFY0s788zLszPj2QLxpYX4Bj4qSTwlC4sAMrSpEZqEkhDDdYHsAol1GuzsyyXjZakeLduompFiBskIXCHLkLgoLeOJqolxZjWmIhcpS1vsGAJQGg13pi8ziGGJ1MkgAM0Nr5DQuIi2IHmFEEMnvxMZBCBcRJpTAU/DVMk9pnSZMZWzvUmD32thMIOYTI0BWNqUzqgVlS4RAsC1LlWGEOe8tE4hLbDiEG+BNtprkhFyCQHkylSchie45t5KDPqPSVKk00In0DQL59ZqJS1aZ2gaRe7nMFxbpylam9cl2zECgU8WJTl9rnUpUi8I760DbY+ja7N23BlnhkTrsifj1XkUk6RYT+81NEHH/+sM3CtkCaKDY8VF+T/wCeKH7mCcqsqZ0oWSrw5lNjmdTP3HmUgNcsLsjJ4zswdNo+npaBKNol+vJ+/i2fv47btxFEV/QwDrymfTVWXGyWdJgsrhe62zn+CnearWVXzXgENA3wtN41CzaHZci31nS0UsV7XMfvlxlYjGKPPvXDzjvhkkIGQpJN71LXU3i2Z30106b4/TuZQrXorMD6pr9YDy56YzdE+t++P7Eq2Sl8NBssPzNkmLaW0EbfxQXI+4FqNWHt8s3LCpkArVDVM/RamAGMLu4sPtfoA24KyZVT9ha1NCDAWRtnEYWuJLIZcjrvVYaZRWLGXJE+u6MORahKsJOH99PHPHWUvLQVQ7crgWn3AD/SQ50OpGeYE8Q+MJEjJXHtxRcaVRzsVSeiJXk6OBf10Iy4T14kyldYWS/KWyXBn2BM0SbjFjSjIq0Avd+el4svuP8tAxu5W3cq4qZLVFN5xLIR9sfCtH7OYqz0UqeMn+wsQKwsWbnrnHx8cjxk485kJQUSfMoFZ79aU/9LQOUbuXEwiA0FT2Kp+jWYkUu1t6wVXolcOuyl2zu0ptx29/9OEpyFVdKVKUFgd1eXbx5TM7HUcQDIrjP4Qcfr78eP7n/NxZdeXVXtFkHI0jP8CVpYrLgaPBRvH0Zrf7Zv3Ry0dXmIRrCnXJhe89n+i265sb2C8P8WD1WARQKEtOYbt1xfTNlE3jjr/XaFxvLgJYcSN44qr3ZguZsO45260WLyb55mu3pZyw57eYZ8Pum0y6DlvxsnZvEMADbg63pmbRBH2jucBahbM0RU0D6NFYPJgtF+fXEACvHUfDBn/wDd49OOvPhnXY+W0A7rsJXgD85i76E25+36m3khcBXX69tqNo0TTNP75Yrp4=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Create Contact",permalink:"/docs/API-docs/createcontact"},next:{title:"Delete Contact",permalink:"/docs/API-docs/deletecontact"}},g={},f=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Contact"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(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:"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 b(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/05632a52.ddf2d459.js b/assets/js/05632a52.ddf2d459.js deleted file mode 100644 index b343d44be..000000000 --- a/assets/js/05632a52.ddf2d459.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[4651],{97717:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>v,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),c=s.n(n),r=(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:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsaXZeeZt5xnPFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Guzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4mb7MIIYluu4MAtDc8AodGopoC5JXCDF05/cigwAERaS5K+B5mCp5wNRdZkzlbG/S4LdaGMwgdqbGAKzblGTUikqXCAHgWpcqQ4hzXlpSSAusOMRbcBvtNZ0RcgkB5MpU3A0luObeSgz690lSpNNCJ9A0C3JrtZIWLRmaRhH9HIZr6zRFa/O6ZLuKQOCTRelIn2tditQfhA+WQNvj6NqsqXaGzDjRuuyL8eY8iklSrKcPGpoAvvr6v83Ag0KWIBL8vOKi/B/4BPFjJxinqiJT14WSbw5lNjmdTP2HTKQGucPszL1kZg+aRtPT0SQaRT/fTD7Es1/i9x/GURT9DQGsK59N15UZdz5LJ1w5fK919gP8NM/Vuo7vCDgE9FxoGkLNotlxL/bMlsqxXNUy++n7dSIao8y/1+IF980gASFLIfG+p9T9LJrdT3fpvD9O51KueCkyP6hu1CPKH5vO0L1r3R/fl2iV/DkcJDuUt0laTGsj3MYPxfWIazFqz+PbBQ2bCl2humHqp6grIIawu/hwux+gDZA1s+onbG1KiKFwTts4DK3jSyGXI671WGmUVixlyRNLLAy5FuFqAuSvj2dONWvLchDVrjhci8+4gaBPeqjVjfICeYbGF0jIXHlwV4orjXIultIXcjU5Gvg3hbBMWH+cqbSuUDp/qSxXhj1Ds4RbzJiSzBXoD0l+Op7s/qM8dMzu5J2cqwpZbZGGcynko43v5IjdXuW5SAUv2V+YWOFw8a6v3NPT01HFTjzmQriiTphBrfbqSy/0ZR2idi8nEIBDU9mrfI5mJVLsbukVV6FXDrsuJ7JTp7bjtxd9fA6iritFitLioC/PLq6/sNNxBMGgOf5DyOGXy0/nX+fnZJXaq72iyTgaRyTSyrqKy4GjwUbx/Ga3e7J+7+Wja0yHaxfqkgvPPZ/otuPNLeyXh3iweiwCKJR1pLDdUjP9acqmIfG3Gg1xcxHAihvBE+re2y1kwtJztlstXk3y3R/dlnLCXt5iXgy7J5kkhq14WdMbBPCIm8OtqVk0QU80CqxVOEtT1G4APRqLB7Pl4vwGAuA11WhI8EdP8O6BrL8Y1iHz2wDouwleAfxKF/0ZN7/t1NuTVwFdfr02lWjRNM0/jcuuPg==",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:"eJy9Vm1r40YQ/ivb+XQB2ZId35WKUi4cIQ13XEKdUmhiwkoaWZtIu3u7K8fG6L+XWUm2HCelKceBsaXZeeZt5xnPFhxfWohv4ZOSjqfOwiKADG1qhHZCSYjhpkB2gY51Guzs+pLxslRPlm1UzZxiBp0RuEKWoeOitIwnqnaMM6sxFblIWdpixxCA0mg4mb7MIIYluu4MAtDc8AodGopoC5JXCDF05/cigwAERaS5K+B5mCp5wNRdZkzlbG/S4LdaGMwgdqbGAKzblGTUikqXCAHgWpcqQ4hzXlpSSAusOMRbcBvtNZ0RcgkB5MpU3A0luObeSgz690lSpNNCJ9A0C3JrtZIWLRmaRhH9HIZr6zRFa/O6ZLuKQOCTRelIn2tditQfhA+WQNvj6NqsqXaGzDjRuuyL8eY8iklSrKcPGpoAvvr6v83Ag0KWIBL8vOKi/B/4BPFjJxinqiJT14WSbw5lNjmdTP2HTKQGucPszL1kZg+aRtPT0SQaRT/fTD7Es1/i9x/GURT9DQGsK59N15UZdz5LJ1w5fK919gP8NM/Vuo7vCDgE9FxoGkLNotlxL/bMlsqxXNUy++n7dSIao8y/1+IF980gASFLIfG+p9T9LJrdT3fpvD9O51KueCkyP6hu1CPKH5vO0L1r3R/fl2iV/DkcJDuUt0laTGsj3MYPxfWIazFqz+PbBQ2bCl2humHqp6grIIawu/hwux+gDZA1s+onbG1KiKFwTts4DK3jSyGXI671WGmUVixlyRNLLAy5FuFqAuSvj2dONWvLchDVrjhci8+4gaBPeqjVjfICeYbGF0jIXHlwV4orjXIultIXcjU5Gvg3hbBMWH+cqbSuUDp/qSxXhj1Ds4RbzJiSzBXoD0l+Op7s/qM8dMzu5J2cqwpZbZGGcynko43v5IjdXuW5SAUv2V+YWOFw8a6v3NPT01HFTjzmQriiTphBrfbqSy/0ZR2idi8nEIBDU9mrfI5mJVLsbukVV6FXDrsuJ7JTp7bjtxd9fA6iritFitLioC/PLq6/sNNxBMGgOf5DyOGXy0/nX+fnZJXaq72iyTgaRyTSyrqKy4GjwUbx/Ga3e7J+7+Wja0yHaxfqkgvPPZ/otuPNLeyXh3iweiwCKJR1pLDdUjP9acqmIfG3Gg1xcxHAihvBE+re2y1kwtJztlstXk3y3R/dlnLCXt5iXgy7J5kkhq14WdMbBPCIm8OtqVk0QU80CqxVOEtT1G4APRqLB7Pl4vwGAuA11WhI8EdP8O6BrL8Y1iHz2wDouwleAfxKF/0ZN7/t1NuTVwFdfr02lWjRNM0/jcuuPg==",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)(c(),{method:"get",path:"/contact/{contact_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Contact API allows you to retrieve details about a specific contact."}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Path Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(o.Z,{className:"paramsItem",param:{name:"contact_id",in:"path",description:"objectId of contact",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"pH1bhc2hpb"}}})})})]}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"successful operation"})}),(0,t.jsx)("div",{children:(0,t.jsx)(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",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:"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 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/1f73ca32.71a25ebe.js b/assets/js/1f73ca32.71a25ebe.js new file mode 100644 index 000000000..653faf5fc --- /dev/null +++ b/assets/js/1f73ca32.71a25ebe.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:()=>g,contentTitle:()=>u,default:()=>f,frontMatter:()=>h,metadata:()=>x,toc:()=>j});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2V6GeRj6xRbv7rk33nPcgeMrC/EM7i0amAeQok2M0E4oCTFMM2RjdIy07PrrLUPJFzlatlUlc4qt0NGnYepJshQdF7ntQwBKo+Hk4zaFGFbovPsADFqtpEUL8Q6GUUR/hxEnZZKgtcsyZ3snEECipEPpyJ5rnYvEK8JHS6Ad2CTDgtOX22qEGNTiERMHAWhDbpyoQ9ZiSmpvaZ0RcgUBLJUpuOtK8JkXOiej38ZiPRwtsvuPUAUgeYHneviokP2CSHAsuMjPxT8qXCB+aAT9RBXkSmdKnp3KxeXVux9Hw8FwRC4e1WIqXH62lxQ3BE9UobncnotWGqUVK+ldGOQO02v3d05eIMNoOOoNol70bjq4ii/ex5dX/SiK/oAAngvfz/peIOXO99nVZe3PpU6/Q5zq2Kyk0e+Y1eeKDC+ii1MGeK5J5dhSlTL94f8bfjRGmX+u/Th21clbyFxI/NZS+Bsl35ZxeVrGrdzwXKR+a0zVGuX3raQb3tXhT69G1EZeDwelduV1kRaT0gi3hXi2g+ce16JX6+PZvJoHUKDLVLPtKGHuMoghXKEr691n0WzQWI8vTQ4xZM5pG4ehdXwl5KrHte63xMj5whLLQ65FuBkAhWhTmFCb6k4cJLLvB9fiE26h3VQHVgEIup4MeernkM5L5cFN9Xca5USspO/dZgCnj4KwTFivTlVSFiidv0e2VIYdodmCW0yZksxl6JUkH/UHzGpMxLIZgT57kA9yogpkpUXa/rmQaxs/yB6b3S2XIhE8Z7/jwgqH8zdt556enk469tZjxsJl5YIZ1OrFfOWFvq1d1P7wFgJwaAp7t5yg2YgEm1t6JVTojcNmsHniB7tZ763owzGIBi0XCUqLnVG8Hn/9zEb9CILOcPyLlMPPt7/efJnckFcar/qKBv2oH/kHQllXcNkJNG6f7Oa5Pr7e3QtJ//Pz34yhw2cX6pwLTy5f1q4hxgxaYswDyJR1JNrtaFjuTV5VJP6zREN0mwew4UZQZE+2oB1eYtIat9S9JEFNtNvwvKwZcLRdDig6vplCALykTLqkWXvSNB/kvVXJbcf3IZvqBOi3Cl4B/ESt+4Tbn/fmteZVQFNfa039m1dV9Rc7pUEz",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/get-user",title:"Get your details",description:"The Get User API enables you to get your own 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 details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfWoB2ZLtJF2FYWg2ZEbaoilgBwPmGAUtnS3GEsmRlBPD0H8fjpIc2V6GeRj6xRbv7rk33nPcgeMrC/EM7i0amAeQok2M0E4oCTFMM2RjdIy07PrrLUPJFzlatlUlc4qt0NGnYepJshQdF7ntQwBKo+Hk4zaFGFbovPsADFqtpEUL8Q6GUUR/hxEnZZKgtcsyZ3snEECipEPpyJ5rnYvEK8JHS6Ad2CTDgtOX22qEGNTiERMHAWhDbpyoQ9ZiSmpvaZ0RcgUBLJUpuOtK8JkXOiej38ZiPRwtsvuPUAUgeYHneviokP2CSHAsuMjPxT8qXCB+aAT9RBXkSmdKnp3KxeXVux9Hw8FwRC4e1WIqXH62lxQ3BE9UobncnotWGqUVK+ldGOQO02v3d05eIMNoOOoNol70bjq4ii/ex5dX/SiK/oAAngvfz/peIOXO99nVZe3PpU6/Q5zq2Kyk0e+Y1eeKDC+ii1MGeK5J5dhSlTL94f8bfjRGmX+u/Th21clbyFxI/NZS+Bsl35ZxeVrGrdzwXKR+a0zVGuX3raQb3tXhT69G1EZeDwelduV1kRaT0gi3hXi2g+ce16JX6+PZvJoHUKDLVLPtKGHuMoghXKEr691n0WzQWI8vTQ4xZM5pG4ehdXwl5KrHte63xMj5whLLQ65FuBkAhWhTmFCb6k4cJLLvB9fiE26h3VQHVgEIup4MeernkM5L5cFN9Xca5USspO/dZgCnj4KwTFivTlVSFiidv0e2VIYdodmCW0yZksxl6JUkH/UHzGpMxLIZgT57kA9yogpkpUXa/rmQaxs/yB6b3S2XIhE8Z7/jwgqH8zdt556enk469tZjxsJl5YIZ1OrFfOWFvq1d1P7wFgJwaAp7t5yg2YgEm1t6JVTojcNmsHniB7tZ763owzGIBi0XCUqLnVG8Hn/9zEb9CILOcPyLlMPPt7/efJnckFcar/qKBv2oH/kHQllXcNkJNG6f7Oa5Pr7e3QtJ//Pz34yhw2cX6pwLTy5f1q4hxgxaYswDyJR1JNrtaFjuTV5VJP6zREN0mwew4UZQZE+2oB1eYtIat9S9JEFNtNvwvKwZcLRdDig6vplCALykTLqkWXvSNB/kvVXJbcf3IZvqBOi3Cl4B/ESt+4Tbn/fmteZVQFNfa039m1dV9Rc7pUEz",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"}},g={},j=[{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 your details"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"The Get User API enables you to get your own details."}),"\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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Joe Bee"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4567832123"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"jobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "objectId": "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,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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(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/1f73ca32.a018c535.js b/assets/js/1f73ca32.a018c535.js deleted file mode 100644 index a21783295..000000000 --- a/assets/js/1f73ca32.a018c535.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:()=>g,contentTitle:()=>h,default:()=>b,frontMatter:()=>u,metadata:()=>x,toc:()=>f});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),o=(a(82723),a(9487)),d=(a(41429),a(5397)),m=a(4667),c=a(9472),p=a(85162);const u={id:"get-user",title:"Get your details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfVoB2ZLtJN2EYWhWZEbSoglgBwPmGAUtnS0mEsmRlBPD0H8vjpIc2V6GeRj6xRbv7rn3h9yC4ysL8QzuLRqYB5CiTYzQTigJMUwzZGN0jLTs8u6aoeSLHC3bqJI5xVbo6NMw9SxZio6L3PYhAKXRcPJxnUIMK3TefQAGrVbSooV4C8Moor/9iJMySdDaZZmznRMIIFHSoXRkz7XOReIV4aMl0BZskmHB6cttNEIMavGIiYMAtCE3TtQhazEltbO0zgi5ggCWyhTcdSX4wgudk9HvY/E0HC2y+xuoAvjCCzzVw41C9hsiwa8KLvJT8Y8KF4gfGkE/UQW5usuUPDmVs/OL9z+NhoPhiFzcqMVUuPxkLymuCf5RFZrLzalopVFasZLkIjHIHaaX7u+cvEKG0XDUG0S96P10cBGf/RyfX/SjKPoTAngpfD+lnwuk3Pk+u7qs3bnU6XeIUx2albT6HbP6XJHhWXR2zADPNakcW6pSpj/8f8uPxijzz7Ufxq46eQuZC4lfWwp/peTbMs6Py7iWa56L1N8aU/WE8vtW0g3v6vDHoxG1kdfDXqldeV2kxaQ0wm0gnm3hpce16NX6eDav5gEU6DLV3HaUMHcZxBCu0JX13WfRrNFYjy9NDjFkzmkbh6F1fCXkqse17rfEyPnCEstDrkW4HgCFaFOYUJvqTuwlsusH1+ITbiBo6+xaBSBoPBny1O8hnZfKg5vqbzXKiVhJ37v1AI4fBWGZsF6dqqQsUDo/R7ZUhh2g2YJbTJmSzGXolSQf9QfMakzEslmBPnuQD3KiCmSlRbr9cyGfbPwge2x2u1yKRPCc/YELKxzOf2w79/z8fNSxdx4zFi4rF8ygVq/mKy/0be2idod3EIBDU9jb5QTNWiTYTOmNUKE3DpvF5olfbKyv91b04RBEi5aLBKXFzipeju8+s1E/gqCzHP8i5fDz9cerL5Mr8krrVY9o0I/6EYm0sq7gshNo3D7ZzXN9ON7tK0n/8/PfrKHDFxfqnAtPLl/WtiHGDFpizAPIlHUk2m5pWe5NXlUk/qtEQ3SbB7DmRlBkT7agXV5i0hNuqHtJgppot+Z5WTPg4HbZo+j4agoB8JIy6ZLmyZOm+SDvrUpuOr732VQnQL9V8AbgF2rdJ9z8ujOvNW8Cmvpaa+rfvKqqb0SaQJM=",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 details",description:"The Get User API enables you to get your own 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 details",description:"The Get User API enables you to get your own details.",sidebar_label:"Get your details",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VW1v2zYQ/ivcfVoB2ZLtJN2EYWhWZEbSoglgBwPmGAUtnS0mEsmRlBPD0H8vjpIc2V6GeRj6xRbv7rn3h9yC4ysL8QzuLRqYB5CiTYzQTigJMUwzZGN0jLTs8u6aoeSLHC3bqJI5xVbo6NMw9SxZio6L3PYhAKXRcPJxnUIMK3TefQAGrVbSooV4C8Moor/9iJMySdDaZZmznRMIIFHSoXRkz7XOReIV4aMl0BZskmHB6cttNEIMavGIiYMAtCE3TtQhazEltbO0zgi5ggCWyhTcdSX4wgudk9HvY/E0HC2y+xuoAvjCCzzVw41C9hsiwa8KLvJT8Y8KF4gfGkE/UQW5usuUPDmVs/OL9z+NhoPhiFzcqMVUuPxkLymuCf5RFZrLzalopVFasZLkIjHIHaaX7u+cvEKG0XDUG0S96P10cBGf/RyfX/SjKPoTAngpfD+lnwuk3Pk+u7qs3bnU6XeIUx2albT6HbP6XJHhWXR2zADPNakcW6pSpj/8f8uPxijzz7Ufxq46eQuZC4lfWwp/peTbMs6Py7iWa56L1N8aU/WE8vtW0g3v6vDHoxG1kdfDXqldeV2kxaQ0wm0gnm3hpce16NX6eDav5gEU6DLV3HaUMHcZxBCu0JX13WfRrNFYjy9NDjFkzmkbh6F1fCXkqse17rfEyPnCEstDrkW4HgCFaFOYUJvqTuwlsusH1+ITbiBo6+xaBSBoPBny1O8hnZfKg5vqbzXKiVhJ37v1AI4fBWGZsF6dqqQsUDo/R7ZUhh2g2YJbTJmSzGXolSQf9QfMakzEslmBPnuQD3KiCmSlRbr9cyGfbPwge2x2u1yKRPCc/YELKxzOf2w79/z8fNSxdx4zFi4rF8ygVq/mKy/0be2idod3EIBDU9jb5QTNWiTYTOmNUKE3DpvF5olfbKyv91b04RBEi5aLBKXFzipeju8+s1E/gqCzHP8i5fDz9cerL5Mr8krrVY9o0I/6EYm0sq7gshNo3D7ZzXN9ON7tK0n/8/PfrKHDFxfqnAtPLl/WtiHGDFpizAPIlHUk2m5pWe5NXlUk/qtEQ3SbB7DmRlBkT7agXV5i0hNuqHtJgppot+Z5WTPg4HbZo+j4agoB8JIy6ZLmyZOm+SDvrUpuOr732VQnQL9V8AbgF2rdJ9z8ujOvNW8Cmvpaa+rfvKqqb0SaQJM=",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"}},g={},f=[{value:"Request",id:"request",level:2}];function j(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 your details"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/getuser"}),"\n",(0,l.jsx)(s.p,{children:"The Get User API enables you to get your own details."}),"\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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.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:"FGik23bhUJ"}}),(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:"4567832123"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"JobTitle",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"dev"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"Company",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"opensign"}}),(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)(d.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Name": "Joe Bee",\n "Email": "joebee@example.com",\n "Phone": "4567832123",\n "JobTitle": "dev",\n "Company": "opensign",\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,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)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(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,l.jsx)(s,{...e,children:(0,l.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/377084eb.325a77d7.js b/assets/js/377084eb.325a77d7.js deleted file mode 100644 index c91d3914d..000000000 --- a/assets/js/377084eb.325a77d7.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>j,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),m=(s(82723),s(9487)),c=s(41429),d=s(5397),p=s(4667),o=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:"eJzVVm1v2zYQ/ivcfWoBxZbTNMWEYViwdVnQoikWDwOWGgEtnSw2EsmSJyeGof8+HPVixW6SfhgK7EtiHe/hvT13xy2QXHlIrmGOlS0loYdFBBn61ClLymhIYF6gOEcSvYo4+3ghZFmaOy82phZkhENyCtcoMiSpSi/k0tQkpPAWU5WrVFAHngzXeOHRrVFIL5ZljdYpTV7kxonUoSSlVyIzaV0hi+8UFcI6zDBXGjPhydUp1Q79BCIwFp1kby8ySGCF1NuACKx0skJCx2FuQcsKIYHenRuVQQSKw7SSCtiP/eI3YfLBeUGFJKERM89RL1HkSGmBfIfDL7VymEFCrsYIPG1KtuRVZUt2BO9taTKEJJelZ4W0wEpCsgXa2KBJTukVRJAbV0lqJXoFTbPg67012qNnwHEc87+Hrvo6TdH7vC7FkA+IIDWaUBPrS2tLlYaD6WfPoO2hF2b5GVPixDm+hlRrshVzfp/2t5XgvQxRJ3A/+2OpK3/8cQVNBHNFLD28Ygfw4ceQckZ9MPQMaCiQNi3kd1Nm6J4G5UFHBEYwRD3nWkFkfTKd9tZqj26SmorRl3f6OXuDk4HfZmf5Sq104OeAls7JDROTsPLPF+dDIPVTtj8bhKaJgNoC7Pjf2+bD4BdmZ/T0Xcfx8aujWXwUv5nPTpOTH5PXp5M4jv+BCO6rkrFdk2Vd/Xqj/Xdts+9gp9lXG1NqPw/QNAw4iU8OG2s+IpfITa2zH/67vkLnzDO8+Zr9cS2VLpXGm35C3JzEJzenQ0CvDwO60GtZqizM8bm5Rf194xmbp9b8YbFUqxTO4UGwY3kbpMe0doo2YcDfH0mrjtrz5HrBs7NCKky3GcJGoAISGNp4uh1tgwb4Prfu90XtylHne5IrpVdH0tqJsai9WulSLj1Pgam0arqeAVvsPbrirLWJeeDXrtGteofc6V3YY61uLxUoeZRxoErnJoC7ZFxa1NzAIZXr2cH2mhfKC+XDcb9LQ1nDmt1Di6X0mAmjBRUYDln+ajIblniATsQn/UlfmQpF7ZG3Tan0rU8+6SNxfZnnKlWyFH/j0ivCxYs+c3d3dwcZexkw54qKeikcWrNTXwVhSOsYNXy8hAgIXeUv8yt0a5X28/kRU9OgPO14LtPAc6yk4up2ol/2Qcy7UqWoPY6YeXb+8b14NYkhGpHjG1yevr/49e2Hq7d8K9OrLdFsEk9iFlnjqZJ6ZGj85tov7XbXr/+D91lHdsJ7mtpSqtDRIXnbrhuvd5M4gmT8OltEUBhPrLLdMkX/cmXTsPhLjY57fhHBWjoll9wT11vIlOff2fDSejRzL/7sHm0vxbc/9L4aTN/Omnt5LcuavyCCW9zsvTabRRP1Pc3ethpnaYqWRtiDGfxgkJ2/nUMEsubUjWfJbZgl3Q++/at+PRwyrQP8t4keAfzEjHqHm58H9fbkUUAXX6/NOVo0TfMv4D1Bsg==",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/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:"eJzVVm1v2zYQ/ivcfWoBxZbTNMWEYViwdVnQoikWDwOWGgEtnSw2EsmSJyeGof8+HPVixW6SfhgK7EtiHe/hvT13xy2QXHlIrmGOlS0loYdFBBn61ClLymhIYF6gOEcSvYo4+3ghZFmaOy82phZkhENyCtcoMiSpSi/k0tQkpPAWU5WrVFAHngzXeOHRrVFIL5ZljdYpTV7kxonUoSSlVyIzaV0hi+8UFcI6zDBXGjPhydUp1Q79BCIwFp1kby8ySGCF1NuACKx0skJCx2FuQcsKIYHenRuVQQSKw7SSCtiP/eI3YfLBeUGFJKERM89RL1HkSGmBfIfDL7VymEFCrsYIPG1KtuRVZUt2BO9taTKEJJelZ4W0wEpCsgXa2KBJTukVRJAbV0lqJXoFTbPg67012qNnwHEc87+Hrvo6TdH7vC7FkA+IIDWaUBPrS2tLlYaD6WfPoO2hF2b5GVPixDm+hlRrshVzfp/2t5XgvQxRJ3A/+2OpK3/8cQVNBHNFLD28Ygfw4ceQckZ9MPQMaCiQNi3kd1Nm6J4G5UFHBEYwRD3nWkFkfTKd9tZqj26SmorRl3f6OXuDk4HfZmf5Sq104OeAls7JDROTsPLPF+dDIPVTtj8bhKaJgNoC7Pjf2+bD4BdmZ/T0Xcfx8aujWXwUv5nPTpOTH5PXp5M4jv+BCO6rkrFdk2Vd/Xqj/Xdts+9gp9lXG1NqPw/QNAw4iU8OG2s+IpfITa2zH/67vkLnzDO8+Zr9cS2VLpXGm35C3JzEJzenQ0CvDwO60GtZqizM8bm5Rf194xmbp9b8YbFUqxTO4UGwY3kbpMe0doo2YcDfH0mrjtrz5HrBs7NCKky3GcJGoAISGNp4uh1tgwb4Prfu90XtylHne5IrpVdH0tqJsai9WulSLj1Pgam0arqeAVvsPbrirLWJeeDXrtGteofc6V3YY61uLxUoeZRxoErnJoC7ZFxa1NzAIZXr2cH2mhfKC+XDcb9LQ1nDmt1Di6X0mAmjBRUYDln+ajIblniATsQn/UlfmQpF7ZG3Tan0rU8+6SNxfZnnKlWyFH/j0ivCxYs+c3d3dwcZexkw54qKeikcWrNTXwVhSOsYNXy8hAgIXeUv8yt0a5X28/kRU9OgPO14LtPAc6yk4up2ol/2Qcy7UqWoPY6YeXb+8b14NYkhGpHjG1yevr/49e2Hq7d8K9OrLdFsEk9iFlnjqZJ6ZGj85tov7XbXr/+D91lHdsJ7mtpSqtDRIXnbrhuvd5M4gmT8OltEUBhPrLLdMkX/cmXTsPhLjY57fhHBWjoll9wT11vIlOff2fDSejRzL/7sHm0vxbc/9L4aTN/Omnt5LcuavyCCW9zsvTabRRP1Pc3ethpnaYqWRtiDGfxgkJ2/nUMEsubUjWfJbZgl3Q++/at+PRwyrQP8t4keAfzEjHqHm58H9fbkUUAXX6/NOVo0TfMv4D1Bsg==",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 from binary",permalink:"/docs/API-docs/createtemplatewithbinary"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},j={},g=[{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 Template"})}),"\n",(0,t.jsx)(n(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.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,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:"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,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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.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:"x1Hbnms2Pg"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(p.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:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(p.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(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)(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": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\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:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.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:"Template not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Template 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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.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/377084eb.d9040225.js b/assets/js/377084eb.d9040225.js new file mode 100644 index 000000000..bb033ef99 --- /dev/null +++ b/assets/js/377084eb.d9040225.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8106],{56181:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>u,default:()=>v,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),m=(s(82723),s(9487)),c=s(41429),p=s(5397),d=s(4667),o=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:"eJzVVm1v2zYQ/ivcfWoBxZaTNN2EYWiwFVnQYikWDwOWGgEtnSw2EsmSJyeGof8+HCXZip3E/TAU2JfEOt7Du3t4b2sgufCQ3MAUK1tKQg+zCDL0qVOWlNGQwLRAcYEkehVx/ulSyLI0916sTC3ICIfkFC5RZEhSlV7IualJSOEtpipXqaAOPNpc44VHt0QhvZiXNVqnNHmRGydSh5KUXojMpHWFLL5XVAjrMMNcacyEJ1enVDv0I4jAWHSSvb3MIIEFUm8DIrDSyQoJHYe5Bi0rhAR6d25VBhEoDtNKKmA39svfhMk3zgsqJAmNmHmOeo4iR0oL5Dscfq2VwwwScjVG4GlVsiWvKluyI/hgS5MhJLksPSukBVYSkjXQygZNckovIILcuEpSK9ELaJoZX++t0R49A47jmP89dtXXaYre53UpNnxABKnRhJpYX1pbqjQcjL94Bq33vTDzL5gSE+f4GlKtyVbM/L7sbyvBBxmiTuBh8vtcV/740wKaCEgRS/ev2AJ8+LGhnFHa0AHQ5oGCasMulRm67xVWm1QvOdj6I4JisyVim4edw+y6OkRRQWR9Mh734NqjG6WmYrS514/ifomsUGem9yoCrxY61MkGLZ2TKy4QwsofZvMwD18MijkGa1hJVR7UniO+6wR9iLYw+oCZ0zdnx5OTH99Onib7uguUDwMJmJ3Tyzcex8cnR5P4KH47nZwlpz8lb85GcRz/AxE8VOU2eMi6pO2N9t+1zb6DnWZXbVhHuzxA0zDgND7d7ybTQUWJ3NQ6++G/aybonDmQpE/ZH76l0qXSeNu3xdvT+PT2bBPQm/2ALvVSlioLw2tq7lB/33iG5qk1v/9YqlUK5/Ao2KG8DdJjWjtFqzDVHo6kVUfteXIz44FRIRWmG4dhDFIBCWx6xng9GIEN8H1u2Q/J2pWDNuNJLpReHElrR8ai5jZRyrnnehxLq8bLCbDF3qNrZq0l5pFf265i1QfkttKFPdTqhnGBMrTDhr9zE8AdGVcWNRdwoHI52RvZ00J5oXw47heI8Kxht9hBi7n0mAmjBRUYDll+MppsNpcAHYnP+rO+NhWK2iOP2FLpO5981kfi5irPVapkKf7GuVeEs1c9c/f393uMvQ6YC0VFPRcOrdmqL4Iw0DpEbT5eQwSErvJX+TW6pUr7YfCMqXFQHnd5LtOQ513b7UXvdkGcd6VKUXscZOb5xaeP4mQUQzRIjm9wefzx8tf3f1y/51s5vdonmoziURxaufFUST0wNFw0d592va3X/8FS2iU74QONbSlVqOhA3rqrxpttJ44gGa6kswgK44lV1mtO0b9c2TQs/lqj45qfRbCUTsk518TNGjLl+Xe2WS+fZe7Vn92m+lp8+3b7ZDB9OWuu5aUsa/6CCO5wtbNiN7Mm6muavW01ztMULQ2wez34USO7eD+FCGTN1A17yV3oJd0Pvv1Jvx43mdYB/ttEzwB+5oz6gKtfNurtybOALr5emzmaNU3zL8StlKE=",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:"eJzVVm1v2zYQ/ivcfWoBxZaTNN2EYWiwFVnQYikWDwOWGgEtnSw2EsmSJyeGof8+HCXZip3E/TAU2JfEOt7Du3t4b2sgufCQ3MAUK1tKQg+zCDL0qVOWlNGQwLRAcYEkehVx/ulSyLI0916sTC3ICIfkFC5RZEhSlV7IualJSOEtpipXqaAOPNpc44VHt0QhvZiXNVqnNHmRGydSh5KUXojMpHWFLL5XVAjrMMNcacyEJ1enVDv0I4jAWHSSvb3MIIEFUm8DIrDSyQoJHYe5Bi0rhAR6d25VBhEoDtNKKmA39svfhMk3zgsqJAmNmHmOeo4iR0oL5Dscfq2VwwwScjVG4GlVsiWvKluyI/hgS5MhJLksPSukBVYSkjXQygZNckovIILcuEpSK9ELaJoZX++t0R49A47jmP89dtXXaYre53UpNnxABKnRhJpYX1pbqjQcjL94Bq33vTDzL5gSE+f4GlKtyVbM/L7sbyvBBxmiTuBh8vtcV/740wKaCEgRS/ev2AJ8+LGhnFHa0AHQ5oGCasMulRm67xVWm1QvOdj6I4JisyVim4edw+y6OkRRQWR9Mh734NqjG6WmYrS514/ifomsUGem9yoCrxY61MkGLZ2TKy4QwsofZvMwD18MijkGa1hJVR7UniO+6wR9iLYw+oCZ0zdnx5OTH99Onib7uguUDwMJmJ3Tyzcex8cnR5P4KH47nZwlpz8lb85GcRz/AxE8VOU2eMi6pO2N9t+1zb6DnWZXbVhHuzxA0zDgND7d7ybTQUWJ3NQ6++G/aybonDmQpE/ZH76l0qXSeNu3xdvT+PT2bBPQm/2ALvVSlioLw2tq7lB/33iG5qk1v/9YqlUK5/Ao2KG8DdJjWjtFqzDVHo6kVUfteXIz44FRIRWmG4dhDFIBCWx6xng9GIEN8H1u2Q/J2pWDNuNJLpReHElrR8ai5jZRyrnnehxLq8bLCbDF3qNrZq0l5pFf265i1QfkttKFPdTqhnGBMrTDhr9zE8AdGVcWNRdwoHI52RvZ00J5oXw47heI8Kxht9hBi7n0mAmjBRUYDll+MppsNpcAHYnP+rO+NhWK2iOP2FLpO5981kfi5irPVapkKf7GuVeEs1c9c/f393uMvQ6YC0VFPRcOrdmqL4Iw0DpEbT5eQwSErvJX+TW6pUr7YfCMqXFQHnd5LtOQ513b7UXvdkGcd6VKUXscZOb5xaeP4mQUQzRIjm9wefzx8tf3f1y/51s5vdonmoziURxaufFUST0wNFw0d592va3X/8FS2iU74QONbSlVqOhA3rqrxpttJ44gGa6kswgK44lV1mtO0b9c2TQs/lqj45qfRbCUTsk518TNGjLl+Xe2WS+fZe7Vn92m+lp8+3b7ZDB9OWuu5aUsa/6CCO5wtbNiN7Mm6muavW01ztMULQ2wez34USO7eD+FCGTN1A17yV3oJd0Pvv1Jvx43mdYB/ttEzwB+5oz6gKtfNurtybOALr5emzmaNU3zL8StlKE=",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 from binary",permalink:"/docs/API-docs/createtemplatewithbinary"},next:{title:"Update Template",permalink:"/docs/API-docs/update-template"}},f={},g=[{value:"Request",id:"request",level:2}];function b(e){const a={h2:"h2",p:"p",...(0,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 Template"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/template/{template_id}"}),"\n",(0,t.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,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:"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,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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,t.jsx)(d.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:"folder"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object"})})]})}),(0,t.jsxs)("div",{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:"x1Hbnms2Pg"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}})]})]})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,t.jsx)(d.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:"signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(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)(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.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 "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Template not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.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)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Template not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(p.Z,{responseExample:'{\n "error": "Template 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)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(o.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)(d.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)(p.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/38c56221.1cc28782.js b/assets/js/38c56221.1cc28782.js new file mode 100644 index 000000000..7b22cb108 --- /dev/null +++ b/assets/js/38c56221.1cc28782.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:()=>v,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var i=a(85893),n=a(11151),t=a(58219),r=(a(62316),a(51039)),o=a.n(r),l=(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(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:"eJztV99v20YM/lc49qUF5J/Z9iAMQ7O2K4IWTTBn2INtBGcdZV0i3al3Jzua4f994Emy5TRtl6KPfUlsHskjP/I+0jv0Yu0wnuNrk1QFae9wGaEkl1hVemU0xnidEby2IvXQKcH51QWQFqucHNSmAm8gsSQ8gdASCqHFmkB22pKN3RCuM3LUfoNEaFgRpJX1GVkgbVWSkYRVDUJKpdfg1FqTdcGl0omxpbHC84nSnqxIvNoQbJVck3fgM2uqdQamslA5so1SKhIC4SHzvnTxaCTKcmhK0uw7Fys3TEzxPDUWktxUEjZknTL6BceqXEhTOZAUQpGcpvOWRJErTeAzgtKahJwDkx7TLS2VgiM1OgKR52bLMfMlAhwbs4G3QjvFOpBaUzSo8AWp0iI/OBsu9EI/e/YM/iThK0suXujBws/Eho7VCMVxMcwoqSzlNTg+rhmJzo8DpUG0tzgvPA2Do3MpYdbgHMO54zwPuHtz6gOkspT4vG4i5vTPry6GC40RmpKajC8kxhiuoc4OI7T0sSLn/zCyxniHidGeD+IdirLMVRJMR7eO+22HLsmoEPzJ1yVhjGZ1Swn7KS1f5BU5Pk1VTj0t563Sa4wwNbYQHmNcCUe//owR0r0oSlZuRUA6MZIklDLFfYRe+a+4OkiOrlz4cICH/Zw8nG/y9rrnYR+hNv5b4/rApvsI23L2vAhrRY0RKk+F+zrMVAiVPzWIW0MropeNgF9ZyEYUT87m1hCsKGRSZkY/2X4yPZtMJ2eTKe6PhW46tKvczcrI+qbDaf9lveacG1pZkhh7W1EQuNJo1yA2HY/53ymNHp5rw5QSXJUwd6RVntc/YfS9XkUj5nf4NKCyWzX99z7ZTK8Y68o+ueQdx1Y2H3gzIKn84Pg4eqAqzfx500F2Mx2PbyTjuo/w5/Evn0J3oTciVzLw8bW5I/0d4SJrjX0s1WNi/et9cz2Hel8EiJqmRtUohXM8SbYvb5J0TNTK1xjPd3g/EKUaNOfxfLlfRliQzwwTaWlciFj4DGMcnXQjsh+7CU97vmsKdqiB82Kt9Hrw2LwbiVKNNhPkm7pIZoxWA8hJPEfOKNU7YtJo0+1rRai4ShkJSTZAw0X468j5bzooO85+jIaPkD0k1ocLySNU2THlCfn1uG9+oLFHmOmQVMc1B6rps8dyz3mmJoDSRnpZkubxGVpjM/kk0rBFtItEl45ohr6x8MAaGBQJRofRyocsPxtOwJWUqLTt8CHwTjAzBfGek1Y55ErfhcUA5pdpqhIlcviHVk55Wj7vOmK73X7SCS+CzVvls2oFlkpzVF8HYWiXvtXhywuuF9nCXaYzshuVdAzwmatGQXnUvluR+N5k6UQvHxrxO8pVQtpR76Wdv716D2fDMUa9pv8fIY/eX7x682H2hr22ix5XeDgejsN0Mc4XQvcuOl16Hxa3t8b8WJF/rMhfXZFbIvV070dlLpTujdmG4Oen6wb/Est4AMRz3O2YHP62+X7P4o8VWZ4eywg3wirusjA7oo6EmfDuqMYYXzVNOrjm61k9rxo+fzAy91FncZ4kVPov6vZn1NXl7BojXLW7fWEk21ix5b1fbDHGBS4w/EZgD2HGBPkOc6HXlVgH6g1+eXaIirHoD567MHjaD5xZd6TrXpSnE6lJhf9yYo8a/Ma9+47q3w/qzclnDVpsO22u4HK/3/8HpFtSAw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={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(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(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:"eJztV99v20YM/lc49qUF5J/Z9iAMQ7O2K4IWTTBn2INtBGcdZV0i3al3Jzua4f994Emy5TRtl6KPfUlsHskjP/I+0jv0Yu0wnuNrk1QFae9wGaEkl1hVemU0xnidEby2IvXQKcH51QWQFqucHNSmAm8gsSQ8gdASCqHFmkB22pKN3RCuM3LUfoNEaFgRpJX1GVkgbVWSkYRVDUJKpdfg1FqTdcGl0omxpbHC84nSnqxIvNoQbJVck3fgM2uqdQamslA5so1SKhIC4SHzvnTxaCTKcmhK0uw7Fys3TEzxPDUWktxUEjZknTL6BceqXEhTOZAUQpGcpvOWRJErTeAzgtKahJwDkx7TLS2VgiM1OgKR52bLMfMlAhwbs4G3QjvFOpBaUzSo8AWp0iI/OBsu9EI/e/YM/iThK0suXujBws/Eho7VCMVxMcwoqSzlNTg+rhmJzo8DpUG0tzgvPA2Do3MpYdbgHMO54zwPuHtz6gOkspT4vG4i5vTPry6GC40RmpKajC8kxhiuoc4OI7T0sSLn/zCyxniHidGeD+IdirLMVRJMR7eO+22HLsmoEPzJ1yVhjGZ1Swn7KS1f5BU5Pk1VTj0t563Sa4wwNbYQHmNcCUe//owR0r0oSlZuRUA6MZIklDLFfYRe+a+4OkiOrlz4cICH/Zw8nG/y9rrnYR+hNv5b4/rApvsI23L2vAhrRY0RKk+F+zrMVAiVPzWIW0MropeNgF9ZyEYUT87m1hCsKGRSZkY/2X4yPZtMJ2eTKe6PhW46tKvczcrI+qbDaf9lveacG1pZkhh7W1EQuNJo1yA2HY/53ymNHp5rw5QSXJUwd6RVntc/YfS9XkUj5nf4NKCyWzX99z7ZTK8Y68o+ueQdx1Y2H3gzIKn84Pg4eqAqzfx500F2Mx2PbyTjuo/w5/Evn0J3oTciVzLw8bW5I/0d4SJrjX0s1WNi/et9cz2Hel8EiJqmRtUohXM8SbYvb5J0TNTK1xjPd3g/EKUaNOfxfLlfRliQzwwTaWlciFj4DGMcnXQjsh+7CU97vmsKdqiB82Kt9Hrw2LwbiVKNNhPkm7pIZoxWA8hJPEfOKNU7YtJo0+1rRai4ShkJSTZAw0X468j5bzooO85+jIaPkD0k1ocLySNU2THlCfn1uG9+oLFHmOmQVMc1B6rps8dyz3mmJoDSRnpZkubxGVpjM/kk0rBFtItEl45ohr6x8MAaGBQJRofRyocsPxtOwJWUqLTt8CHwTjAzBfGek1Y55ErfhcUA5pdpqhIlcviHVk55Wj7vOmK73X7SCS+CzVvls2oFlkpzVF8HYWiXvtXhywuuF9nCXaYzshuVdAzwmatGQXnUvluR+N5k6UQvHxrxO8pVQtpR76Wdv716D2fDMUa9pv8fIY/eX7x682H2hr22ix5XeDgejsN0Mc4XQvcuOl16Hxa3t8b8WJF/rMhfXZFbIvV070dlLpTujdmG4Oen6wb/Est4AMRz3O2YHP62+X7P4o8VWZ4eywg3wirusjA7oo6EmfDuqMYYXzVNOrjm61k9rxo+fzAy91FncZ4kVPov6vZn1NXl7BojXLW7fWEk21ix5b1fbDHGBS4w/EZgD2HGBPkOc6HXlVgH6g1+eXaIirHoD567MHjaD5xZd6TrXpSnE6lJhf9yYo8a/Ma9+47q3w/qzclnDVpsO22u4HK/3/8HpFtSAw==",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={},g=[{value:"Features:",id:"features",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,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(o(),{method:"post",path:"/draftdocument"}),"\n",(0,i.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,i.jsx)(s.a,{href:"https://app.opensignlabs.com(for",children:"https://app.opensignlabs.com(for"})," cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document."]}),"\n",(0,i.jsx)(s.h3,{id:"features",children:"Features:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Save Document Drafts: Securely save your documents in a draft state."}),"\n",(0,i.jsx)(s.li,{children:"Add Signers: Assign signers to your document directly from the API."}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(l.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)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(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:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\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:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(l.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:"hji2zxcv2P"}}),(0,i.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,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(c.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\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)(l.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 v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/38c56221.bd03a448.js b/assets/js/38c56221.bd03a448.js deleted file mode 100644 index 7ff03824b..000000000 --- a/assets/js/38c56221.bd03a448.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:()=>x,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>f});var i=a(85893),t=a(11151),n=a(58219),l=(a(62316),a(51039)),r=a.n(l),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 allows you to generate document in which you can add signers and widgets from Ui",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfVoB+TXdPgjD0KwJiqBFE8wp9sExApo6SUwkkiUpv9TQfx+OkmzZSdulKPYlke+Nd8/dPeQOPM8cxHO40KIqUXkHiwgSdMJK46VWEMNtjiyxPPWsM2LnN1eMF4VeO7bVFfOaZajQco8s6WykYutcijxYCK4YTxLmZKbQOsZVwtYyydA7llpdsk8SItCGYkitrhKIIZyJXTyIwOLnCp3/SydbiHcgtPKkiHfAjSmkCK6jB0dZ78CJHEtOX35rEGLQywcUFMdYOshLdKRNZYE9K+etVBlEkGpbcg8xLLnD319DBLjhpSHjVsRQCZ1gwkySQh2Bl/47ofaSQygXPvawUZwj+H8o2kUvQh2B0v5H8/pIrnUEbeN6Ubi1fAsRSI+l+z7MWHJZvDSJB41LxDeNYCh0Garh5YuredDIlhgqMblWL/afTM8m08nZZAr1odHNhHadu1/qZHvf4VR/267R00BLiwnE3lYYBM5o5RrEpuMx/Ttexv0KCovcY8JcJQQ6l1ZFsf0Fop+1FY2Y9vBlQOUPcvplI1bTG8K6si9uee69cfFoVNli4PUAE+kHh+XogSpVIRXed5DdT8fj+4RwrSN4Pf7tKXRXasULmQTyutWPqH4iXGitts+Veiisf7xvjqdUN2WAqBlqkI1R0MNRsX15U6RDUVnptxDPd7AZcCMHjT6eL+pFBCX6XBORGu1CxtznEMPoaBqB4thVWO35rmnYvgfO80yqbMCNGWqDioa74EtHmzjiRo5WE6CTukxmhFYDyFE+B84w8j0SabTl9q0ikNSlHHmCNkBDTfj7wPmXHZQdZz9HwwfITon19Fp7hio7pjwivx73zfc09gwz7YvquGZPNX32WNRUZ6oDKG2m1wbVTGYqjMZq8iTT21w6Jl1Qd+WEMWWptuzEmxEoCdOK+RyDkuRnwwlzBoVM2wkfsjt1p2a6RFY5TKuCFVI9uvhODdj8Ok2lkLxg/+DSSY+LX7uJWK/XTybhVfB5J31eLZlFow/mWRCGcel77X+8on6hLd11OkO7kqJjgK8cNQrGo3ZvufC9m6UTvTl1oj0qpEDlsLdp5+9uPrCz4Rii3tD/h5RHH67eXn6cXVJUWpumRZPheDgOt4t2vuSqd9DF0dPptLm9Z8z/+NBq19Hjxo9MwaXqkXVDE/PjS4tehTnRSDyH3Y5G7JMt6prEnyu0xEGLCFbcSr6kmZ7TnLerTGvziFuI4W1T6uCWjifzompY4YR466jzOBcCjf+mbZ/pbq5ntxDBsn0hljohH8vX9Hrka4jhDu4gvDQpQmCqIN9BwVVW8SwscIhLDMQrwqJPX4+BvtoPqqxTqW0vy2Nea0qhv1TYsw5/UKPf4/bPvXmj+apDi21nTR1c1HX9L314DfQ=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/draftedocument",title:"Draft Document",description:"The draft Document API allows you to generate document in which you can add signers and widgets from Ui",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 allows you to generate document in which you can add signers and widgets from Ui",sidebar_label:"Draft Document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vm1v2zYQ/ivcfVoB+TXdPgjD0KwJiqBFE8wp9sExApo6SUwkkiUpv9TQfx+OkmzZSdulKPYlke+Nd8/dPeQOPM8cxHO40KIqUXkHiwgSdMJK46VWEMNtjiyxPPWsM2LnN1eMF4VeO7bVFfOaZajQco8s6WykYutcijxYCK4YTxLmZKbQOsZVwtYyydA7llpdsk8SItCGYkitrhKIIZyJXTyIwOLnCp3/SydbiHcgtPKkiHfAjSmkCK6jB0dZ78CJHEtOX35rEGLQywcUFMdYOshLdKRNZYE9K+etVBlEkGpbcg8xLLnD319DBLjhpSHjVsRQCZ1gwkySQh2Bl/47ofaSQygXPvawUZwj+H8o2kUvQh2B0v5H8/pIrnUEbeN6Ubi1fAsRSI+l+z7MWHJZvDSJB41LxDeNYCh0Garh5YuredDIlhgqMblWL/afTM8m08nZZAr1odHNhHadu1/qZHvf4VR/267R00BLiwnE3lYYBM5o5RrEpuMx/Ttexv0KCovcY8JcJQQ6l1ZFsf0Fop+1FY2Y9vBlQOUPcvplI1bTG8K6si9uee69cfFoVNli4PUAE+kHh+XogSpVIRXed5DdT8fj+4RwrSN4Pf7tKXRXasULmQTyutWPqH4iXGitts+Veiisf7xvjqdUN2WAqBlqkI1R0MNRsX15U6RDUVnptxDPd7AZcCMHjT6eL+pFBCX6XBORGu1CxtznEMPoaBqB4thVWO35rmnYvgfO80yqbMCNGWqDioa74EtHmzjiRo5WE6CTukxmhFYDyFE+B84w8j0SabTl9q0ikNSlHHmCNkBDTfj7wPmXHZQdZz9HwwfITon19Fp7hio7pjwivx73zfc09gwz7YvquGZPNX32WNRUZ6oDKG2m1wbVTGYqjMZq8iTT21w6Jl1Qd+WEMWWptuzEmxEoCdOK+RyDkuRnwwlzBoVM2wkfsjt1p2a6RFY5TKuCFVI9uvhODdj8Ok2lkLxg/+DSSY+LX7uJWK/XTybhVfB5J31eLZlFow/mWRCGcel77X+8on6hLd11OkO7kqJjgK8cNQrGo3ZvufC9m6UTvTl1oj0qpEDlsLdp5+9uPrCz4Rii3tD/h5RHH67eXn6cXVJUWpumRZPheDgOt4t2vuSqd9DF0dPptLm9Z8z/+NBq19Hjxo9MwaXqkXVDE/PjS4tehTnRSDyH3Y5G7JMt6prEnyu0xEGLCFbcSr6kmZ7TnLerTGvziFuI4W1T6uCWjifzompY4YR466jzOBcCjf+mbZ/pbq5ntxDBsn0hljohH8vX9Hrka4jhDu4gvDQpQmCqIN9BwVVW8SwscIhLDMQrwqJPX4+BvtoPqqxTqW0vy2Nea0qhv1TYsw5/UKPf4/bPvXmj+apDi21nTR1c1HX9L314DfQ=",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:"Request",id:"request",level:2}];function g(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,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Draft Document"})}),"\n",(0,i.jsx)(r(),{method:"post",path:"/draftdocument"}),"\n",(0,i.jsx)(s.p,{children:"The draft Document API allows you to generate document in which you can add signers and widgets from Ui"}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,i.jsxs)(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)(c.Z,{collapsible:!1,name:"file",required:!1,schemaName:"base64",qualifierMessage:void 0,schema:{type:"string",format:"base64",example:"base64 encoded pdf"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample document"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Description"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample Note"}}),(0,i.jsx)(c.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"signers"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(c.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@exampl.com"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"123121312"}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})]})]})})}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(n.Z,{children:[(0,i.jsxs)(p.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Document created successfully!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(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)(c.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,i.jsx)(c.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://url-to-edit-document"}})]})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://url-to-edit-document"\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)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,t.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.2b4fb8c8.js b/assets/js/5c04ee3b.2b4fb8c8.js deleted file mode 100644 index d3459f543..000000000 --- a/assets/js/5c04ee3b.2b4fb8c8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>x,contentTitle:()=>u,default:()=>g,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),o=a(11151),n=a(58219),t=(a(62316),a(51039)),i=a.n(t),r=(a(82723),a(9487)),d=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VV1r2zAU/SvafVrBidO1Y2DGWBmllJZ1kJY9pKEoyo2tRZY0SU4agv/7uLKdOCkdY4y92M79PlfnKFsIPPeQTeA7zgpjljBNYI5eOGmDNBoyuC+QXWFgbQC7+HbNuFJmzTamYsGwHANbt87KKUjAWHSc0q/nkEGOoSuegENvjfboIdvCu9GIXof9xpUQ6P2iUmxXBxIQRgfUgeK5tUqK6Eh/eEraghcFlpy+wsYiZGBmP1AESMA6KhNk07KbZB/og5M6hwTwmZdWkakIwfosTTemcoMW2qBy6nMbMhSmhLpOIMgQE6RWUuNTB+7p3Wj09AHqmmLOR+cvQT54dEybwBam0vM3/w4fOmfc79Ed9/4dEBq+g/H+JYxrveJKziMn7s0S9f9F0m8fmvY06nOpKE/zsoEUg6IfDqD27Q1Ij6JyMmwgm2zhecCtHDT+bDKtpwmUGArTcpoG5qGADNL1jt4e3Qqdj/mkhT2XfOC51PmAWzs0FrWXuVZ85olLKbcyXZ0CtehGGNOamk0cDLLbB7fyBjeQdDj7UQlIOp4C+Rxd3InUCxOTW/R3FvVY5jrubnUKL1UvPZM+uudGVCXqEM+RLYxjR9lsxj3OmdEsFBidZD8bnjJvUchFS4Ehe9SPemxKZJVHEriSeumzRz1gk7vFQgrJFd0zXgacvu02t16vX2zsJOZcyVBUM+bQmn14Ho1xrf2s3Y8TSCCgK/3dYoxuJUWn+FdapTE4bYnNRSQ2llzS6bamz8dJRDQlBWqPPSpeXH27ZWfDESQ9cvzByOnt9ZfLr+NLqkr0ao7odDgajshkjQ8l171Gvfv6+GS3e33+zdXeki/gc0it4jJKKoLZtnKYwHr/V1IYH8i03RJFHpyqazL/rNCRyKYJrLiTfEacnEzrpKMs6WeJG9qZEGhJbCuuqob3R3fKgTCvLu8hAV7RJH2pLKNU2g+q3rn0plf7UEPNAPSsk1cSPtLKbnDzaRfeeF5NaPF10bS/aV3XvwDvGZSI",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-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:"eJy9VV1r2zAU/SvafVrBidO1Y2DGWBmllJZ1kJY9pKEoyo2tRZY0SU4agv/7uLKdOCkdY4y92M79PlfnKFsIPPeQTeA7zgpjljBNYI5eOGmDNBoyuC+QXWFgbQC7+HbNuFJmzTamYsGwHANbt87KKUjAWHSc0q/nkEGOoSuegENvjfboIdvCu9GIXof9xpUQ6P2iUmxXBxIQRgfUgeK5tUqK6Eh/eEraghcFlpy+wsYiZGBmP1AESMA6KhNk07KbZB/og5M6hwTwmZdWkakIwfosTTemcoMW2qBy6nMbMhSmhLpOIMgQE6RWUuNTB+7p3Wj09AHqmmLOR+cvQT54dEybwBam0vM3/w4fOmfc79Ed9/4dEBq+g/H+JYxrveJKziMn7s0S9f9F0m8fmvY06nOpKE/zsoEUg6IfDqD27Q1Ij6JyMmwgm2zhecCtHDT+bDKtpwmUGArTcpoG5qGADNL1jt4e3Qqdj/mkhT2XfOC51PmAWzs0FrWXuVZ85olLKbcyXZ0CtehGGNOamk0cDLLbB7fyBjeQdDj7UQlIOp4C+Rxd3InUCxOTW/R3FvVY5jrubnUKL1UvPZM+uudGVCXqEM+RLYxjR9lsxj3OmdEsFBidZD8bnjJvUchFS4Ehe9SPemxKZJVHEriSeumzRz1gk7vFQgrJFd0zXgacvu02t16vX2zsJOZcyVBUM+bQmn14Ho1xrf2s3Y8TSCCgK/3dYoxuJUWn+FdapTE4bYnNRSQ2llzS6bamz8dJRDQlBWqPPSpeXH27ZWfDESQ9cvzByOnt9ZfLr+NLqkr0ao7odDgajshkjQ8l171Gvfv6+GS3e33+zdXeki/gc0it4jJKKoLZtnKYwHr/V1IYH8i03RJFHpyqazL/rNCRyKYJrLiTfEacnEzrpKMs6WeJG9qZEGhJbCuuqob3R3fKgTCvLu8hAV7RJH2pLKNU2g+q3rn0plf7UEPNAPSsk1cSPtLKbnDzaRfeeF5NaPF10bS/aV3XvwDvGZSI",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"}},x={},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)(i(),{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)(n.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)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"Webhook",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://your-webhook-url@example.com"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "Webhook": "https://your-webhook-url@example.com"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"User not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"User not found!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "User not found!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]); \ No newline at end of file diff --git a/assets/js/5c04ee3b.fd615a94.js b/assets/js/5c04ee3b.fd615a94.js new file mode 100644 index 000000000..56485a286 --- /dev/null +++ b/assets/js/5c04ee3b.fd615a94.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9588],{44545:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>b,contentTitle:()=>u,default:()=>v,frontMatter:()=>h,metadata:()=>x,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)),d=(a(41429),a(5397)),p=a(4667),c=a(9472),m=a(85162);const h={id:"get-webhook",title:"Get Webhook",description:"The Get Webhook API allow you to get webhook url",sidebar_label:"Get Webhook",hide_title:!0,hide_table_of_contents:!0,api:"eJy9VNtqGzEQ/RV1nlqQvU4vFJZSWkoIoaUpOKEPjgmyPN5VrZVUSWvHmP33MtpdZ+2QUkrpiy8zczRzRudoD1EUAfIZfMdFae0a5hyWGKRXLiprIIfrEtkFRtYVsI/fLpnQ2m7ZztYsWlZgZNsuWXsNHKxDLwh+uYQcCoz94Rw8BmdNwAD5Hl5OJvR13G9aS4khrGrNDucAB2lNRBOpXjinlUyJ7Ecg0B6CLLES9CvuHEIOdvEDZQQOztMxUbUtu0EHhSF6ZQrggPeicppCZYwu5Fm2s7UfdYhR7fWHrmQsbQVNwyGqmADKaGXwrid393IyuXsLTUM1ryevH5O8CeiZsZGtbG2Wz/4dP/Te+t+zO+39OyI0fE/jzWMal2YjtFomTVzbNZr/y2TYPrbtadT7ShPOiKqllIpSHo6oDuMtyYCy9iruIJ/t4X4knBq1+Xw2b+YcKoyl7TRNA4tYQg7Z9iDvgH6DPiQ8eeFBSyGKQpliJJwbW4cmqMJosQikpUw4lW3OgFr0I0xpTe0mjgY57EM49Rl3wHuewyoOiq6nRLFEn3aizMomcMf+yqGZqsKk3W3O4LHrVWAqpPTSyrpCE9M9spX17ATNFiLgklnDYokpSfFX4zMWHEq16iQwZrfm1kxthawOSAbXyqxDfmtGbHa1WimphKZ3JqiI8+f95rbb7aONvUiYCxXLesE8OvtQXqRgWusQdfjzAjhE9FW4Wk3Rb5TsHf9EqywVZ52whUzCxkoout0u9OEURELTSqIJOJDix4tvX9ir8QT4QBx/MHL25fLT+dfpOZ1K8mqv6Gw8GU8o5GyIlTCDRoP3+vRm9w/+/JunvRNfxPuYOS1UslQis+/sMDu8sXMOpQ2RQvs9SeTG66ah8M8aPZlszmEjvBIL0uRs3vBesuSfNe5oZ1KiI7NthK5b3Z+8KUfGvDi/Bg6ipkmGVlknq3Q/6PQ+ZXaDs4891A5Anw1/AvCOVvYZd+8P5W3mSUDHr6+m/c2bpvkFwgiUqA==",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:"eJy9VNtqGzEQ/RV1nlqQvU4vFJZSWkoIoaUpOKEPjgmyPN5VrZVUSWvHmP33MtpdZ+2QUkrpiy8zczRzRudoD1EUAfIZfMdFae0a5hyWGKRXLiprIIfrEtkFRtYVsI/fLpnQ2m7ZztYsWlZgZNsuWXsNHKxDLwh+uYQcCoz94Rw8BmdNwAD5Hl5OJvR13G9aS4khrGrNDucAB2lNRBOpXjinlUyJ7Ecg0B6CLLES9CvuHEIOdvEDZQQOztMxUbUtu0EHhSF6ZQrggPeicppCZYwu5Fm2s7UfdYhR7fWHrmQsbQVNwyGqmADKaGXwrid393IyuXsLTUM1ryevH5O8CeiZsZGtbG2Wz/4dP/Te+t+zO+39OyI0fE/jzWMal2YjtFomTVzbNZr/y2TYPrbtadT7ShPOiKqllIpSHo6oDuMtyYCy9iruIJ/t4X4knBq1+Xw2b+YcKoyl7TRNA4tYQg7Z9iDvgH6DPiQ8eeFBSyGKQpliJJwbW4cmqMJosQikpUw4lW3OgFr0I0xpTe0mjgY57EM49Rl3wHuewyoOiq6nRLFEn3aizMomcMf+yqGZqsKk3W3O4LHrVWAqpPTSyrpCE9M9spX17ATNFiLgklnDYokpSfFX4zMWHEq16iQwZrfm1kxthawOSAbXyqxDfmtGbHa1WimphKZ3JqiI8+f95rbb7aONvUiYCxXLesE8OvtQXqRgWusQdfjzAjhE9FW4Wk3Rb5TsHf9EqywVZ52whUzCxkoout0u9OEURELTSqIJOJDix4tvX9ir8QT4QBx/MHL25fLT+dfpOZ1K8mqv6Gw8GU8o5GyIlTCDRoP3+vRm9w/+/JunvRNfxPuYOS1UslQis+/sMDu8sXMOpQ2RQvs9SeTG66ah8M8aPZlszmEjvBIL0uRs3vBesuSfNe5oZ1KiI7NthK5b3Z+8KUfGvDi/Bg6ipkmGVlknq3Q/6PQ+ZXaDs4891A5Anw1/AvCOVvYZd+8P5W3mSUDHr6+m/c2bpvkFwgiUqA==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template list",permalink:"/docs/API-docs/gettemplatelist"},next:{title:"Save or Update Webhook",permalink:"/docs/API-docs/save-update-webhook"}},b={},f=[{value:"Request",id:"request",level:2}];function j(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)(c.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)(p.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)(d.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)(c.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)(p.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)(d.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)(c.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)(p.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)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,o.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.6a911971.js b/assets/js/770b40a9.6a911971.js new file mode 100644 index 000000000..56d3344af --- /dev/null +++ b/assets/js/770b40a9.6a911971.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>v,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var l=a(85893),i=a(11151),t=a(58219),n=(a(62316),a(51039)),r=a.n(n),m=(a(82723),a(9487)),o=a(41429),c=a(5397),p=a(4667),d=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:"eJzdVm1v4zYM/isaP+0AJ3HSl9uMYbhiKLriirVAMwxYGxSKzcRqZUknyXlB4P8+ULYTp7k2w3C4D/vSxuRDkXxEUtyA53MHyQOMsTCSe3QwiSBDl1phvNAKEhjnyK7QsxbCboTz7OLumnEp9dKxtS6Z18yitwIXyDiThNAzxhdcSD6VyHx7fp+Nc+HYrFQpnc+l8GtmrF6IDB3jiukF2oXAZbCXcmcZMVR8KoWas9KhdeQzzbV2yGZWFwxXwnnSbi3YMkfFUos8yDOdlgUq7/oQgTZoOUVwnUECc/StFcUOERhueYEeLdGzAcULhASkKARpBRHzpUS7hggsfimFxQySGZcOI3B+LQk907aACHBlpM4QEm9L0qY5FhySDRR8JYqygOQsjiPwa0NGqiymaKEiO14YOmgYV9E2BPcizDeL4G2fcTWhc53RyqEj7CiO6d9+cbgyTdG5WSnZllGIINXKo/KE58ZIkQbF4NmR0eYwAD19xjTQbukYL2qXFl0pfQfHreWUsPBYuOP2tZhueIt03go1hyhQw31Xss0dVsPfp6pwo7s5ceKFJ+nhETsDF35sK4+slPZHjFo0C9CKQpIZ2u+VVl1P7wVYx8MCsNoRsQ38qQmYQhfHKMq9Ny4ZDFpj6uF+qguy1ku1l/d7ZIV21m1UETgxV6FL/2uRHOfhWSObYvCGBRfyKHqK+KkRtCmaXKsjbk7PzkfDk58+Dr9O9n2TKCkDCZhd+PdPHMWjk94w7sUfx8Pz5PTn5Oy8H8fx3xDBqpC75CFrirZ12n6XJvsOfqrXsG4fveYBqi47Qkmh8KkdVE+jOH46J0gVwWl8djiwrtWCS5GF92usX1D98O3GFVqrj5Rx172v3R+mL2pQ0MNesl15naTDtLTCr8MrtepxI3q1PnmY0Agv0Oe6eeLCs+ZzSGDw6rVzaBftU1da2WlX5/lcqHmPG9PXBhW1m+RTR3U94EYMFkMgP20c98RVTcdeNLvuNOIzUns2yXZRzbOWIw9jpaLvmQ7GDQW3BhU1QiBwMYTDZUU4JlxQt+99uEw205a9smZT7jBjWjGfY1CS/KQ/ZM5gKmZNHfTZo3pU97pAWjzoqZNCvbjkUfXYw+1sJlLBJfsLp054nPzYMrdcLg8Y+xBsroTPyymzaPQOPg/CQGvXavvxASLwaAt3O7unDSlth+obrgYBPGiqm6ehupvx1Yo+vTaiapMiReWwU48XV3c37KQfQ9Qpjn8R8uDm+rfLP+4v6VQqr/qKhv24H4eRqJ0vuOo42lszm9Lcu9/NrlX/p3tp0yUeV35gJBdhAATWN03zPsBe804iyLXzJN9sqKD/tLKqSFxvh9TSmXCU7W4/fMF1Z5tdcFmSU6A18w1ss3buoBP6sIKwYdZEbduSw9rmIk3RdB0cDNe9CXV1OYYIeElJdsfFSxgXzQ86vVWpdefs/TlSB0B/KaevGvxCpfIZ179u4bXmTYMmvxZNVzOpquofnqGImg==",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:"eJzdVm1v4zYM/isaP+0AJ3HSl9uMYbhiKLriirVAMwxYGxSKzcRqZUknyXlB4P8+ULYTp7k2w3C4D/vSxuRDkXxEUtyA53MHyQOMsTCSe3QwiSBDl1phvNAKEhjnyK7QsxbCboTz7OLumnEp9dKxtS6Z18yitwIXyDiThNAzxhdcSD6VyHx7fp+Nc+HYrFQpnc+l8GtmrF6IDB3jiukF2oXAZbCXcmcZMVR8KoWas9KhdeQzzbV2yGZWFwxXwnnSbi3YMkfFUos8yDOdlgUq7/oQgTZoOUVwnUECc/StFcUOERhueYEeLdGzAcULhASkKARpBRHzpUS7hggsfimFxQySGZcOI3B+LQk907aACHBlpM4QEm9L0qY5FhySDRR8JYqygOQsjiPwa0NGqiymaKEiO14YOmgYV9E2BPcizDeL4G2fcTWhc53RyqEj7CiO6d9+cbgyTdG5WSnZllGIINXKo/KE58ZIkQbF4NmR0eYwAD19xjTQbukYL2qXFl0pfQfHreWUsPBYuOP2tZhueIt03go1hyhQw31Xss0dVsPfp6pwo7s5ceKFJ+nhETsDF35sK4+slPZHjFo0C9CKQpIZ2u+VVl1P7wVYx8MCsNoRsQ38qQmYQhfHKMq9Ny4ZDFpj6uF+qguy1ku1l/d7ZIV21m1UETgxV6FL/2uRHOfhWSObYvCGBRfyKHqK+KkRtCmaXKsjbk7PzkfDk58+Dr9O9n2TKCkDCZhd+PdPHMWjk94w7sUfx8Pz5PTn5Oy8H8fx3xDBqpC75CFrirZ12n6XJvsOfqrXsG4fveYBqi47Qkmh8KkdVE+jOH46J0gVwWl8djiwrtWCS5GF92usX1D98O3GFVqrj5Rx172v3R+mL2pQ0MNesl15naTDtLTCr8MrtepxI3q1PnmY0Agv0Oe6eeLCs+ZzSGDw6rVzaBftU1da2WlX5/lcqHmPG9PXBhW1m+RTR3U94EYMFkMgP20c98RVTcdeNLvuNOIzUns2yXZRzbOWIw9jpaLvmQ7GDQW3BhU1QiBwMYTDZUU4JlxQt+99uEw205a9smZT7jBjWjGfY1CS/KQ/ZM5gKmZNHfTZo3pU97pAWjzoqZNCvbjkUfXYw+1sJlLBJfsLp054nPzYMrdcLg8Y+xBsroTPyymzaPQOPg/CQGvXavvxASLwaAt3O7unDSlth+obrgYBPGiqm6ehupvx1Yo+vTaiapMiReWwU48XV3c37KQfQ9Qpjn8R8uDm+rfLP+4v6VQqr/qKhv24H4eRqJ0vuOo42lszm9Lcu9/NrlX/p3tp0yUeV35gJBdhAATWN03zPsBe804iyLXzJN9sqKD/tLKqSFxvh9TSmXCU7W4/fMF1Z5tdcFmSU6A18w1ss3buoBP6sIKwYdZEbduSw9rmIk3RdB0cDNe9CXV1OYYIeElJdsfFSxgXzQ86vVWpdefs/TlSB0B/KaevGvxCpfIZ179u4bXmTYMmvxZNVzOpquofnqGImg==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"},next:{title:"Get Webhook",permalink:"/docs/API-docs/get-webhook"}},f={},g=[{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",p:"p",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(s.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"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)(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)(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)(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)(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)(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)("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)(p.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(p.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(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 "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(d.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/770b40a9.9d881f10.js b/assets/js/770b40a9.9d881f10.js deleted file mode 100644 index 65f671e12..000000000 --- a/assets/js/770b40a9.9d881f10.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1520],{9104:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>f});var l=s(85893),t=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),m=(s(82723),s(9487)),o=s(41429),c=s(5397),d=s(4667),p=s(9472),h=s(85162);const x={id:"gettemplatelist",title:"Get Template list",description:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents.",sidebar_label:"Get Template list",hide_title:!0,hide_table_of_contents:!0,api:"eJzdVm1v2zYQ/ivcfVoBxZbTl2HCMCwYuixokRSIhwFLjYCWTvY1FMmSlF9g6L8XR0m2HC/NMBT7sC+2dPc898a7E3cQ5MJDdgdTrKySAT3MEijQ545sIKMhg+kSxSUG0UPEe/JBXHy4ElIps/Zia2oRjHAYHOEKhRSKEaYUciVJyblCEXr7IzFdkhdlrXO2LxWFrbDOrKhAL6QWZoVuRbiOfKUOzESglnNFeiFqj86zz3xpjEdROlMJ3JAPrN0zxHqJWuQOZZQXJq8r1MGPIAFj0UmO4KqADBYYehbHDglY6WSFAR2XZwdaVggZKKqItcSF+Vyj20ICDj/X5LCArJTKYwI+bBWjS+MqSAA3VpkCIQuuZm2+xEpCtoNKbqiqK8hep2kCYWuZpOtqjg4a5snKsqFJ2iT7EPwD2W8WwdM+02bGdr012qNn7Hma8t9xc/g6z9H7slZiX1FIIDc6oA6Ml9YqyqNi/MkzaXcagJl/wjyW3bGZQK1Lh75WYYCTzklOmAJW/nl+K+YT3iN9cKQXkMTSyDCU7HOHzeT3ua78+YcF12RKgaWnJg4EHx/2ncesaxOeIfVooU1L+c2oAt3XSWXEiNgMTKHnQluGYH02HvfeeHZGuamYfbPWz/nbBxnHyBw839JCx+n4t4dzHfv5a74/GYSmSSC0B7CP5b73zcoYFxYX4eu2ztPzl2eT9Cz9YTp5k736MXv9ZpSm6V+QwKZSzO3mq+jOr3fav9e2+A/8NI9hw5Z6XAdohtUhrUjjfT+z9+dpev+GIU0Cr9LXp7N7pVdSURFX+dQ8oP7u200uOmee6ayh+9C6P02fWlDUw1GyQ3mbpMe8dhS2cWFvzqSls1af3c14m1UYlqbb9nHDhyVkMH60+D26Vb/1a6cGE+SDXJBenElrR8ai9rTQSs49T9NYWhqvJsB++jhuuVZtOY6iOQyMpXfIE9MlO0R1G36JklcCp0e6NJHcleDGouZBiAVcTeD0u01ekI/q/tMXD1OUxolHbDGXHgthtAhLjEqWvxxNhLeYU9n1wUh81B/1ramQv8G89RXpB5991Gfi7qYsKSepxJ849xRw9n1fufV6fVKxF5FzSWFZz4VDaw7wRRTGsg5Z+5cXkEBAV/mb8pYvC3m/555wNY7gcdfdMo/djZUkPt1O9MtjEnebohy1x0E/Xlx+eC9ejlJIBs3xD0Iev7/69e317Vu2yu3VHtFklI5SFlnjQyX1wNHRjatrzaPz3R1G9X96ReumJOAmjK2SFBdArPquG947OBreWQJL4wPLdztu6D+cahoWtxclHumCPGd7uCo94HZwsVtJVbNT4BvXE9juBnaAzvjFEWPjrkn6sWWHLeciz9EOHZws16MNdfl2CgnImpMcrouHuC66B7beq/R2YPt4j7QB8C/n9LeEn7hV3uH25z281TxJ6PLr0Xw0s6ZpvgDVmzWr",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:"eJzdVm1v2zYQ/ivcfVoBxZbTl2HCMCwYuixokRSIhwFLjYCWTvY1FMmSlF9g6L8XR0m2HC/NMBT7sC+2dPc898a7E3cQ5MJDdgdTrKySAT3MEijQ545sIKMhg+kSxSUG0UPEe/JBXHy4ElIps/Zia2oRjHAYHOEKhRSKEaYUciVJyblCEXr7IzFdkhdlrXO2LxWFrbDOrKhAL6QWZoVuRbiOfKUOzESglnNFeiFqj86zz3xpjEdROlMJ3JAPrN0zxHqJWuQOZZQXJq8r1MGPIAFj0UmO4KqADBYYehbHDglY6WSFAR2XZwdaVggZKKqItcSF+Vyj20ICDj/X5LCArJTKYwI+bBWjS+MqSAA3VpkCIQuuZm2+xEpCtoNKbqiqK8hep2kCYWuZpOtqjg4a5snKsqFJ2iT7EPwD2W8WwdM+02bGdr012qNn7Hma8t9xc/g6z9H7slZiX1FIIDc6oA6Ml9YqyqNi/MkzaXcagJl/wjyW3bGZQK1Lh75WYYCTzklOmAJW/nl+K+YT3iN9cKQXkMTSyDCU7HOHzeT3ua78+YcF12RKgaWnJg4EHx/2ncesaxOeIfVooU1L+c2oAt3XSWXEiNgMTKHnQluGYH02HvfeeHZGuamYfbPWz/nbBxnHyBw839JCx+n4t4dzHfv5a74/GYSmSSC0B7CP5b73zcoYFxYX4eu2ztPzl2eT9Cz9YTp5k736MXv9ZpSm6V+QwKZSzO3mq+jOr3fav9e2+A/8NI9hw5Z6XAdohtUhrUjjfT+z9+dpev+GIU0Cr9LXp7N7pVdSURFX+dQ8oP7u200uOmee6ayh+9C6P02fWlDUw1GyQ3mbpMe8dhS2cWFvzqSls1af3c14m1UYlqbb9nHDhyVkMH60+D26Vb/1a6cGE+SDXJBenElrR8ai9rTQSs49T9NYWhqvJsB++jhuuVZtOY6iOQyMpXfIE9MlO0R1G36JklcCp0e6NJHcleDGouZBiAVcTeD0u01ekI/q/tMXD1OUxolHbDGXHgthtAhLjEqWvxxNhLeYU9n1wUh81B/1ramQv8G89RXpB5991Gfi7qYsKSepxJ849xRw9n1fufV6fVKxF5FzSWFZz4VDaw7wRRTGsg5Z+5cXkEBAV/mb8pYvC3m/555wNY7gcdfdMo/djZUkPt1O9MtjEnebohy1x0E/Xlx+eC9ejlJIBs3xD0Iev7/69e317Vu2yu3VHtFklI5SFlnjQyX1wNHRjatrzaPz3R1G9X96ReumJOAmjK2SFBdArPquG947OBreWQJL4wPLdztu6D+cahoWtxclHumCPGd7uCo94HZwsVtJVbNT4BvXE9juBnaAzvjFEWPjrkn6sWWHLeciz9EOHZws16MNdfl2CgnImpMcrouHuC66B7beq/R2YPt4j7QB8C/n9LeEn7hV3uH25z281TxJ6PLr0Xw0s6ZpvgDVmzWr",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 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:"Get Template list"})}),"\n",(0,l.jsx)(r(),{method:"get",path:"/templatelist"}),"\n",(0,l.jsx)(a.p,{children:"The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents."}),"\n",(0,l.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(a.p,{children:"Query Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsxs)("ul",{children:[(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,l.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(i.Z,{children:[(0,l.jsxs)(h.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"successful operation"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"template[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"x1Hbnms2Pg"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"sample template"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template note"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder name"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"https://templateuser.com"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"template creator name"}}),(0,l.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(a.p,{children:"Signers"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(a.p,{children:"object[]"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,l.jsx)(a.p,{children:"Array ["})})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(c.Z,{responseExample:'{\n "result": [\n {\n "objectId": "x1Hbnms2Pg",\n "Title": "sample template",\n "Note": "template note",\n "Folder": "folder name",\n "File": "https://templateuser.com",\n "Owner": "template creator name",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(a.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(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,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.37040646.js b/assets/js/8a725248.37040646.js deleted file mode 100644 index b29c20b5f..000000000 --- a/assets/js/8a725248.37040646.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:()=>x,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>f,toc:()=>g});var t=s(85893),l=s(11151),n=s(58219),i=(s(62316),s(51039)),r=s.n(i),o=(s(82723),s(9487)),c=(s(41429),s(5397)),d=s(4667),m=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:"eJzFVm1v2zYQ/ivcfVoB2ZbstMOEYWgWBEXQognmDAPmGAEtnS0mFMmSlB3D0H8fjpL8mgbLVnRAEMjHe+Pz3B1vA54vHKQTuNDK88w7mEaQo8usMF5oBSncFsguLHKPLGuU2PnNFeNS6pVja10xrxnO59p6ic7JNcsabYWrzsIxX3DPMq4Y2XPHnFgotI7NtSUflonSaOu58izXWVWi8q4PEWiDllMmVzmk0HhunUIEFr9U6PxvOl9DujlK/MbqpciRzVDqFTPc8hI9Wko3O7gPREBfqDw54cZIkYWYgwdHnjbgsgJLTl8UUVjMCTMsuZAQgeIlQgSm0AoJP782CCno2QMG58bSLbxARx6CdrrptJy3Qi0ggrm2Jff7EnzipZGk9KDpGgh11AZ9vf0M8X0r6Ge6JFdNwq90lQxHw2SUjIYJ1HUEXvggPmDmfkaE1HS+w8vbCoPAGa1cg8Uwjk95a0uxJSlnrsoydG5eSbn+4TVcvcxDI6ayeh0ApkhmxdPwwRCEn/8bmZffjsybf0PmWTJKhuGPXLSAn/vn3OyMhvFw1EviXvzTbfIuPfs5ffuuH8fxXxDBUyl3JQ459+GWXY10vyuTf4c49bFaW5w5ei6k2zfo5kAdSvYsPjstyrEu0RdCLdgKlWcrq9UiYkYid8i8XTO+4EIxyT3ab1ikaK22L8P0usz2e1YoKRTedx15fxaf3SdbEN6egnClllyKPMz/W/2I6vvedD+8b8KfsiwapXAOB5fdlzeXdJhVVvg1pJMNPPW4Eb3mPJ1M62kEBKymd8doFzLmvoAUBsfPkEO7ROuCm8pKSKHw3rh0MHCeL4Ra9LgxfW1Q0bMn+cxR1w64EYNlAhSpy2RMaDWAHOSzhYUb8RHX3aOTHmhFIIilAnmONkBDJPy+eyMvOyi3aHWzaPuuPDddti/FwfCnaHMdUmshvjaoxmKhAkHLBE43CeGYcOG4e+RDsYQt4MiazbjDnGnFfIHhkOSjfsKcwUzM2zrrszt1p6gHWOVwXkkmhXp06Z3qscn1fC4ywSX7E2dOeJz+2PGyWq1O+HgTbD4IX1QzZtHonfoiCANp+1bbH28gAo+2dNfzMdqlyLCtga+EGgTlQds9VETUAS0Drej9sRFBLkWGyu0zeP7h5hMb9WOI9krvH6Q8+HR1cfl5fEleqXgbipJ+3I/DbqCdL7naC9TugBfbqj8gd7ObA//zxtg2iscnPzCSizAFAjSbtoEnR3vkNIKCGjydwGZDZfeHlXVN4i8VWpoO0wiW3Ao+ozqfTOuoazLq+Edct1sLKt+7pfCkLqumX49GYh11FudZhsa/qLs/g26ux7cQwazddUudk43lK9qD+QpSuIM7CCszeQgzJMg3ILlaVHwRGj74pdnAK8Jif7A8hsHSftDNuiO13svycOI0V6H/dLFnDX4h8j/i+tetenPyVYMW206bGJzWdf03pltQHQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={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:"eJzFVm1v2zYQ/ivcfVoB2ZbstMOEYWgWBEXQognmDAPmGAEtnS0mFMmSlB3D0H8fjpL8mgbLVnRAEMjHe+Pz3B1vA54vHKQTuNDK88w7mEaQo8usMF5oBSncFsguLHKPLGuU2PnNFeNS6pVja10xrxnO59p6ic7JNcsabYWrzsIxX3DPMq4Y2XPHnFgotI7NtSUflonSaOu58izXWVWi8q4PEWiDllMmVzmk0HhunUIEFr9U6PxvOl9DujlK/MbqpciRzVDqFTPc8hI9Wko3O7gPREBfqDw54cZIkYWYgwdHnjbgsgJLTl8UUVjMCTMsuZAQgeIlQgSm0AoJP782CCno2QMG58bSLbxARx6CdrrptJy3Qi0ggrm2Jff7EnzipZGk9KDpGgh11AZ9vf0M8X0r6Ge6JFdNwq90lQxHw2SUjIYJ1HUEXvggPmDmfkaE1HS+w8vbCoPAGa1cg8Uwjk95a0uxJSlnrsoydG5eSbn+4TVcvcxDI6ayeh0ApkhmxdPwwRCEn/8bmZffjsybf0PmWTJKhuGPXLSAn/vn3OyMhvFw1EviXvzTbfIuPfs5ffuuH8fxXxDBUyl3JQ459+GWXY10vyuTf4c49bFaW5w5ei6k2zfo5kAdSvYsPjstyrEu0RdCLdgKlWcrq9UiYkYid8i8XTO+4EIxyT3ab1ikaK22L8P0usz2e1YoKRTedx15fxaf3SdbEN6egnClllyKPMz/W/2I6vvedD+8b8KfsiwapXAOB5fdlzeXdJhVVvg1pJMNPPW4Eb3mPJ1M62kEBKymd8doFzLmvoAUBsfPkEO7ROuCm8pKSKHw3rh0MHCeL4Ra9LgxfW1Q0bMn+cxR1w64EYNlAhSpy2RMaDWAHOSzhYUb8RHX3aOTHmhFIIilAnmONkBDJPy+eyMvOyi3aHWzaPuuPDddti/FwfCnaHMdUmshvjaoxmKhAkHLBE43CeGYcOG4e+RDsYQt4MiazbjDnGnFfIHhkOSjfsKcwUzM2zrrszt1p6gHWOVwXkkmhXp06Z3qscn1fC4ywSX7E2dOeJz+2PGyWq1O+HgTbD4IX1QzZtHonfoiCANp+1bbH28gAo+2dNfzMdqlyLCtga+EGgTlQds9VETUAS0Drej9sRFBLkWGyu0zeP7h5hMb9WOI9krvH6Q8+HR1cfl5fEleqXgbipJ+3I/DbqCdL7naC9TugBfbqj8gd7ObA//zxtg2iscnPzCSizAFAjSbtoEnR3vkNIKCGjydwGZDZfeHlXVN4i8VWpoO0wiW3Ao+ozqfTOuoazLq+Edct1sLKt+7pfCkLqumX49GYh11FudZhsa/qLs/g26ux7cQwazddUudk43lK9qD+QpSuIM7CCszeQgzJMg3ILlaVHwRGj74pdnAK8Jif7A8hsHSftDNuiO13svycOI0V6H/dLFnDX4h8j/i+tetenPyVYMW206bGJzWdf03pltQHQ==",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 details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},x={},g=[{value:"Request",id:"request",level:2}];function j(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)(r(),{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)(o.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)(d.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.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)(o.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)(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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(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:"4131231231"}}),(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)(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,t.jsxs)(p.default,{label:"404",value:"404",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)(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)(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)(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,t.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(c.Z,{responseExample:'{\n "error": "Something went wrong, please try again later!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(p.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(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)(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)(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)(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)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(j,{...e})}):j(e)}}}]); \ No newline at end of file diff --git a/assets/js/8a725248.b58420e2.js b/assets/js/8a725248.b58420e2.js new file mode 100644 index 000000000..4a138a739 --- /dev/null +++ b/assets/js/8a725248.b58420e2.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:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>h,metadata:()=>u,toc:()=>j});var t=s(85893),l=s(11151),i=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=(s(41429),s(5397)),d=s(4667),m=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:"eJzVVm1rIzcQ/ivqfOrB2t61fVe6lHJpOI5wRxPOKYU6Jsi7Y68SraSTtHaM2f9eRrvr11xooFwphLAezevzzIy0Bc+XDtIpXGrleeYdzCLI0WVWGC+0ghRuC2SXFrlHljVK7OLminEp9dqxja6Y1wwXC229ROfkhmWNtsJ1Z+GYL7hnGVeM7LljTiwVWscW2pIPy0RptPVceZbrrCpRedeHCLRByymTqxxSaDy3TiECi18rdP43nW8g3Z4kfmP1SuTI5ij1mhlueYkeLaWbHdUDEdAXKk9OuDFSZCHm4MGRpy24rMCS0xdFFBZzwgxLLiREoHiJEIEptELCz28MQgp6/oDBubFUhRfoyEPQTredlvNWqCVEsNC25P5Qgk+8NJKUHjSVgVBHbdDX288R37eCfqZLctUk/EpXyXA0TEbJaJhAXUfghQ/iI2bu50RITed7vLytMAic0co1WAzj+Jy3thVbknLmqixD5xaVlJsfXsPVyzw0Ymqr1wFgimRePA0fDEH4PydznIySYfgjFy3gF/45N3ujYTwc9ZK4F/90m7xLxz+nb9/14zj+CyJ4KuW+xSHnPlTZ9Uj3uzL5d4hTn6q1zZmj50K6Q4NuD9ShZcfx+LwpJ7pEXwi1ZGtUnq2tVsuIGYncIfN2w/iSC8Uk92j/xSZFa7V9GabXZXY4s0JJofC+m8j7cTy+T3YgvD0H4UqtuBR52P+3+hHV9630MLxvwp+zLBqlcA5HxR7KmyIdZpUVfgPpdAtPPW5ErzlPp7N6FgEBq+neMdqFjLkvIIXB6TXk0K7QuuCmshJSKLw3Lh0MnOdLoZY9bkxfG1R07Uk+dzS1A27EYJUAReoymRBaDSBH+exg4UZ8wk136aRHWhEIYqlAnqMN0BAJX/Z35IcOyh1a3S7araLntstuuRwtf4q20CG1FuJrg2oilioQtErg/CUhHBMuHHeXfGiW8Ao4sWZz7jBnWjFfYDgk+aifMGcwE4u2z/rsTt0pmgFWOVxUkkmhHl16p3pser1YiExwyf7EuRMeZz92vKzX6zM+3gSbj8IX1ZxZNHqvvgzCQNqh1e7HG4jAoy3d9WKCdiUybHvgG6EGQXnQTg81EU1Ay0Aren9qRJBLkaFyhwxefLz5zEb9GKKD1vsHKQ8+X11++H3ygbxS8zYUJf24H4frRDtfcnUQqH0DXu66/ojc7X4P/McvxnZQPD75gZFchC0QoNm2Azw9eUfOIihowNMpbLfUdn9YWdck/lqhpe0wi2DFreBz6vPprI66IaOJf8RN+2pB5Xu3FJ7UZdXM68lKrKPO4iLL0PgXdQ930M315BYimLdv3VLnZGP5mt7BfA0p3MEdhCczeQg7JMi3ILlaVnwZBj74pd3AK8LicLE8hsXSflBl3ZHaHGR5vHGaUug/FfaswS9E/ifc/LpTb06+adBi22kTg7O6rv8GFfdQfQ==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,u={id:"API-docs/createcontact",title:"Create Contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",source:"@site/docs/API-docs/createcontact.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createcontact",permalink:"/docs/API-docs/createcontact",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createcontact",title:"Create Contact",description:"The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.",sidebar_label:"Create Contact",hide_title:!0,hide_table_of_contents:!0,api:"eJzVVm1rIzcQ/ivqfOrB2t61fVe6lHJpOI5wRxPOKYU6Jsi7Y68SraSTtHaM2f9eRrvr11xooFwphLAezevzzIy0Bc+XDtIpXGrleeYdzCLI0WVWGC+0ghRuC2SXFrlHljVK7OLminEp9dqxja6Y1wwXC229ROfkhmWNtsJ1Z+GYL7hnGVeM7LljTiwVWscW2pIPy0RptPVceZbrrCpRedeHCLRByymTqxxSaDy3TiECi18rdP43nW8g3Z4kfmP1SuTI5ij1mhlueYkeLaWbHdUDEdAXKk9OuDFSZCHm4MGRpy24rMCS0xdFFBZzwgxLLiREoHiJEIEptELCz28MQgp6/oDBubFUhRfoyEPQTredlvNWqCVEsNC25P5Qgk+8NJKUHjSVgVBHbdDX288R37eCfqZLctUk/EpXyXA0TEbJaJhAXUfghQ/iI2bu50RITed7vLytMAic0co1WAzj+Jy3thVbknLmqixD5xaVlJsfXsPVyzw0Ymqr1wFgimRePA0fDEH4PydznIySYfgjFy3gF/45N3ujYTwc9ZK4F/90m7xLxz+nb9/14zj+CyJ4KuW+xSHnPlTZ9Uj3uzL5d4hTn6q1zZmj50K6Q4NuD9ShZcfx+LwpJ7pEXwi1ZGtUnq2tVsuIGYncIfN2w/iSC8Uk92j/xSZFa7V9GabXZXY4s0JJofC+m8j7cTy+T3YgvD0H4UqtuBR52P+3+hHV9630MLxvwp+zLBqlcA5HxR7KmyIdZpUVfgPpdAtPPW5ErzlPp7N6FgEBq+neMdqFjLkvIIXB6TXk0K7QuuCmshJSKLw3Lh0MnOdLoZY9bkxfG1R07Uk+dzS1A27EYJUAReoymRBaDSBH+exg4UZ8wk136aRHWhEIYqlAnqMN0BAJX/Z35IcOyh1a3S7araLntstuuRwtf4q20CG1FuJrg2oilioQtErg/CUhHBMuHHeXfGiW8Ao4sWZz7jBnWjFfYDgk+aifMGcwE4u2z/rsTt0pmgFWOVxUkkmhHl16p3pser1YiExwyf7EuRMeZz92vKzX6zM+3gSbj8IX1ZxZNHqvvgzCQNqh1e7HG4jAoy3d9WKCdiUybHvgG6EGQXnQTg81EU1Ay0Aren9qRJBLkaFyhwxefLz5zEb9GKKD1vsHKQ8+X11++H3ygbxS8zYUJf24H4frRDtfcnUQqH0DXu66/ojc7X4P/McvxnZQPD75gZFchC0QoNm2Azw9eUfOIihowNMpbLfUdn9YWdck/lqhpe0wi2DFreBz6vPprI66IaOJf8RN+2pB5Xu3FJ7UZdXM68lKrKPO4iLL0PgXdQ930M315BYimLdv3VLnZGP5mt7BfA0p3MEdhCczeQg7JMi3ILlaVnwZBj74pd3AK8LicLE8hsXSflBl3ZHaHGR5vHGaUug/FfaswS9E/ifc/LpTb06+adBi22kTg7O6rv8GFfdQfQ==",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 details",permalink:"/docs/API-docs/get-user"},next:{title:"Get Contact",permalink:"/docs/API-docs/getcontact"}},f={},j=[{value:"Request",id:"request",level:2}];function g(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create Contact"})}),"\n",(0,t.jsx)(r(),{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)(d.Z,{collapsible:!1,name:"name",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(d.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,t.jsx)(d.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)(i.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)(m.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)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(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:"4131231231"}}),(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": "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:"404",value:"404",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)(m.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)(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,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:"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)(m.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)(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 y(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.00fbee30.js b/assets/js/935f2afb.00fbee30.js deleted file mode 100644 index 04c46aecf..000000000 --- a/assets/js/935f2afb.00fbee30.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATON INSTRUCTIONS","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftedocument","className":"api-method post","docId":"API-docs/draftedocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from binary","href":"/docs/API-docs/createdocumentwithbinary","className":"api-method post","docId":"API-docs/createdocumentwithbinary","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Create Template from binary","href":"/docs/API-docs/createtemplatewithbinary","className":"api-method post","docId":"API-docs/createtemplatewithbinary","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"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.","sidebar":"apiSidebar"},"API-docs/createcontact":{"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.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithbinary":{"id":"API-docs/createdocumentwithbinary","title":"Create Document from binary","description":"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document API allows you to generate new documents by providing template_id.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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 .","sidebar":"apiSidebar"},"API-docs/createtemplatewithbinary":{"id":"API-docs/createtemplatewithbinary","title":"Create Template from binary","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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"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","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"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.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/draftedocument":{"id":"API-docs/draftedocument","title":"Draft Document","description":"The draft Document API allows you to generate document in which you can add signers and widgets from Ui","sidebar":"apiSidebar"},"API-docs/drafttemplate":{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.","sidebar":"apiSidebar"},"API-docs/get-template":{"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.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"The Get User API enables you to get your own details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"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.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"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","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATON INSTRUCTIONS","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.26c9597e.js b/assets/js/935f2afb.26c9597e.js new file mode 100644 index 000000000..1738db41d --- /dev/null +++ b/assets/js/935f2afb.26c9597e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"Intro","href":"/docs/help/intro","docId":"help/intro","unlisted":false},{"type":"category","label":"Create New OpenSign Document","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Sign yourself","href":"/docs/help/New-Document/sign-yourself","docId":"help/New-Document/sign-yourself","unlisted":false},{"type":"link","label":"Request signatures","href":"/docs/help/New-Document/request-signatures","docId":"help/New-Document/request-signatures","unlisted":false}],"href":"/docs/category/create-new-opensign-document"},{"type":"category","label":"Manage Docs using OpenSign\u2122 Drive","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Docs & Folders","href":"/docs/help/OpenSign\u2122 Drive/create-document","docId":"help/OpenSign\u2122 Drive/create-document","unlisted":false},{"type":"link","label":"Grid vs List view","href":"/docs/help/OpenSign\u2122 Drive/list-grid-view","docId":"help/OpenSign\u2122 Drive/list-grid-view","unlisted":false},{"type":"link","label":"OpenSign\u2122 Drive Interface Documentation","href":"/docs/help/OpenSign\u2122 Drive/organize-documents","docId":"help/OpenSign\u2122 Drive/organize-documents","unlisted":false},{"type":"link","label":"Rename documents from OpenSign\u2122 Drive","href":"/docs/help/OpenSign\u2122 Drive/rename-document","docId":"help/OpenSign\u2122 Drive/rename-document","unlisted":false}],"href":"/docs/category/manage-docs-using-opensign-drive"},{"type":"category","label":"Reports","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Completed","href":"/docs/help/Reports/completed","docId":"help/Reports/completed","unlisted":false},{"type":"link","label":"Declined","href":"/docs/help/Reports/declined","docId":"help/Reports/declined","unlisted":false},{"type":"link","label":"Drafts","href":"/docs/help/Reports/drafts","docId":"help/Reports/drafts","unlisted":false},{"type":"link","label":"Expired","href":"/docs/help/Reports/expired","docId":"help/Reports/expired","unlisted":false},{"type":"link","label":"In Progress","href":"/docs/help/Reports/in-progress","docId":"help/Reports/in-progress","unlisted":false},{"type":"link","label":"Need your sign","href":"/docs/help/Reports/need-your-sign","docId":"help/Reports/need-your-sign","unlisted":false}],"href":"/docs/category/reports"},{"type":"category","label":"Templates","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Create Templates","href":"/docs/help/Templates/create-template","docId":"help/Templates/create-template","unlisted":false},{"type":"link","label":"Use template to create documents","href":"/docs/help/Templates/use-template","docId":"help/Templates/use-template","unlisted":false},{"type":"link","label":"Quickly Send template to a signer","href":"/docs/help/Templates/quick-send","docId":"help/Templates/quick-send","unlisted":false}],"href":"/docs/category/templates"},{"type":"category","label":"Settings","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"My Signature","href":"/docs/help/Settings/my-signature","docId":"help/Settings/my-signature","unlisted":false},{"type":"link","label":"Manage users","href":"/docs/help/Settings/manage-users","docId":"help/Settings/manage-users","unlisted":false},{"type":"link","label":"Profile","href":"/docs/help/Settings/profile","docId":"help/Settings/profile","unlisted":false}],"href":"/docs/category/settings"}],"selfhostSidebar":[{"type":"link","label":"Self-Hosting OpenSign","href":"/docs/self-host/intro","docId":"self-host/intro","unlisted":false},{"type":"category","label":"Docker","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Localhost Setup with Docker","href":"/docs/self-host/docker/run-locally","docId":"self-host/docker/run-locally","unlisted":false}],"href":"/docs/category/docker"},{"type":"category","label":"One-click-Install","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Digital Ocean","href":"/docs/self-host/One-click-Install/DigitalOcean","docId":"self-host/One-click-Install/DigitalOcean","unlisted":false}]}],"contributeSidebar":[{"type":"link","label":"Code of conduct","href":"/docs/contribute/CODE_OF_CONDUCT","docId":"contribute/CODE_OF_CONDUCT","unlisted":false},{"type":"link","label":"Contributing to OpenSign","href":"/docs/contribute/intro","docId":"contribute/intro","unlisted":false},{"type":"link","label":"Community at OpenSign\u2122","href":"/docs/contribute/COMMUNITY","docId":"contribute/COMMUNITY","unlisted":false},{"type":"link","label":"INSTALLATON INSTRUCTIONS","href":"/docs/contribute/INSTALLATION","docId":"contribute/INSTALLATION","unlisted":false},{"type":"link","label":"OpenSign\u2122 Reporting Guidelines","href":"/docs/contribute/REPORTING_GUIDELINES","docId":"contribute/REPORTING_GUIDELINES","unlisted":false}],"apiSidebar":[{"type":"link","label":"Introduction","href":"/docs/API-docs/opensign-api-v-1","docId":"API-docs/opensign-api-v-1","unlisted":false},{"type":"category","label":"User","items":[{"type":"link","label":"Get your details","href":"/docs/API-docs/get-user","className":"api-method get","docId":"API-docs/get-user","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contacts","items":[{"type":"link","label":"Create Contact","href":"/docs/API-docs/createcontact","className":"api-method post","docId":"API-docs/createcontact","unlisted":false},{"type":"link","label":"Get Contact","href":"/docs/API-docs/getcontact","className":"api-method get","docId":"API-docs/getcontact","unlisted":false},{"type":"link","label":"Delete Contact","href":"/docs/API-docs/deletecontact","className":"api-method delete","docId":"API-docs/deletecontact","unlisted":false},{"type":"link","label":"Get Contact list","href":"/docs/API-docs/contactlist","className":"api-method get","docId":"API-docs/contactlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Documents","items":[{"type":"link","label":"Draft Document","href":"/docs/API-docs/draftedocument","className":"api-method post","docId":"API-docs/draftedocument","unlisted":false},{"type":"link","label":"Create Document","href":"/docs/API-docs/createdocument","className":"api-method post","docId":"API-docs/createdocument","unlisted":false},{"type":"link","label":"Create Document from binary","href":"/docs/API-docs/createdocumentwithbinary","className":"api-method post","docId":"API-docs/createdocumentwithbinary","unlisted":false},{"type":"link","label":"Create Document from Template","href":"/docs/API-docs/createdocumentwithtemplateid","className":"api-method post","docId":"API-docs/createdocumentwithtemplateid","unlisted":false},{"type":"link","label":"Get Document","href":"/docs/API-docs/getdocument","className":"api-method get","docId":"API-docs/getdocument","unlisted":false},{"type":"link","label":"Update Document","href":"/docs/API-docs/update-document","className":"api-method put","docId":"API-docs/update-document","unlisted":false},{"type":"link","label":"Delete Document","href":"/docs/API-docs/deletedocument","className":"api-method delete","docId":"API-docs/deletedocument","unlisted":false},{"type":"link","label":"Get Document list from status","href":"/docs/API-docs/getdocumentlist","className":"api-method get","docId":"API-docs/getdocumentlist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Templates","items":[{"type":"link","label":"Draft Template","href":"/docs/API-docs/drafttemplate","className":"api-method post","docId":"API-docs/drafttemplate","unlisted":false},{"type":"link","label":"Create Template","href":"/docs/API-docs/createtemplate","className":"api-method post","docId":"API-docs/createtemplate","unlisted":false},{"type":"link","label":"Create Template from binary","href":"/docs/API-docs/createtemplatewithbinary","className":"api-method post","docId":"API-docs/createtemplatewithbinary","unlisted":false},{"type":"link","label":"Get Template","href":"/docs/API-docs/get-template","className":"api-method get","docId":"API-docs/get-template","unlisted":false},{"type":"link","label":"Update Template","href":"/docs/API-docs/update-template","className":"api-method put","docId":"API-docs/update-template","unlisted":false},{"type":"link","label":"Delete Template","href":"/docs/API-docs/delete-template","className":"api-method delete","docId":"API-docs/delete-template","unlisted":false},{"type":"link","label":"Get Template list","href":"/docs/API-docs/gettemplatelist","className":"api-method get","docId":"API-docs/gettemplatelist","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"category","label":"Webhook","items":[{"type":"link","label":"Get Webhook","href":"/docs/API-docs/get-webhook","className":"api-method get","docId":"API-docs/get-webhook","unlisted":false},{"type":"link","label":"Save or Update Webhook","href":"/docs/API-docs/save-update-webhook","className":"api-method post","docId":"API-docs/save-update-webhook","unlisted":false},{"type":"link","label":"Delete Webhook","href":"/docs/API-docs/delete-webhook","className":"api-method delete","docId":"API-docs/delete-webhook","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"API-docs/contactlist":{"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.","sidebar":"apiSidebar"},"API-docs/createcontact":{"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.","sidebar":"apiSidebar"},"API-docs/createdocument":{"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. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithbinary":{"id":"API-docs/createdocumentwithbinary","title":"Create Document from binary","description":"The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios.","sidebar":"apiSidebar"},"API-docs/createdocumentwithtemplateid":{"id":"API-docs/createdocumentwithtemplateid","title":"Create Document from Template","description":"The Create Document API allows you to generate new documents by providing template_id.","sidebar":"apiSidebar"},"API-docs/createtemplate":{"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 .","sidebar":"apiSidebar"},"API-docs/createtemplatewithbinary":{"id":"API-docs/createtemplatewithbinary","title":"Create Template from binary","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.","sidebar":"apiSidebar"},"API-docs/delete-template":{"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","sidebar":"apiSidebar"},"API-docs/delete-webhook":{"id":"API-docs/delete-webhook","title":"Delete Webhook","description":"The Delete Webhook API allow you to delete webhook url","sidebar":"apiSidebar"},"API-docs/deletecontact":{"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.","sidebar":"apiSidebar"},"API-docs/deletedocument":{"id":"API-docs/deletedocument","title":"Delete Document","description":"The Delete document API allows you to remove specific document from your documents.","sidebar":"apiSidebar"},"API-docs/draftedocument":{"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(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":"apiSidebar"},"API-docs/drafttemplate":{"id":"API-docs/drafttemplate","title":"Draft Template","description":"The Draft Template API allows you to create customizable draft templates .The API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template.","sidebar":"apiSidebar"},"API-docs/get-template":{"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.","sidebar":"apiSidebar"},"API-docs/get-user":{"id":"API-docs/get-user","title":"Get your details","description":"The Get User API enables you to get your own details.","sidebar":"apiSidebar"},"API-docs/get-webhook":{"id":"API-docs/get-webhook","title":"Get Webhook","description":"The Get Webhook API allow you to get webhook url","sidebar":"apiSidebar"},"API-docs/getcontact":{"id":"API-docs/getcontact","title":"Get Contact","description":"The Get Contact API allows you to retrieve details about a specific contact.","sidebar":"apiSidebar"},"API-docs/getdocument":{"id":"API-docs/getdocument","title":"Get Document","description":"The Get Document API enables you to retrieve details about a specific document.","sidebar":"apiSidebar"},"API-docs/getdocumentlist":{"id":"API-docs/getdocumentlist","title":"Get Document list from status","description":"### Document Types:","sidebar":"apiSidebar"},"API-docs/gettemplatelist":{"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.","sidebar":"apiSidebar"},"API-docs/intro":{"id":"API-docs/intro","title":"Overview","description":"OpenSign\u2122 API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures."},"API-docs/opensign-api-v-1":{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.","sidebar":"apiSidebar"},"API-docs/save-update-webhook":{"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","sidebar":"apiSidebar"},"API-docs/update-document":{"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.","sidebar":"apiSidebar"},"API-docs/update-template":{"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.","sidebar":"apiSidebar"},"contribute/CODE_OF_CONDUCT":{"id":"contribute/CODE_OF_CONDUCT","title":"Code of conduct","description":"1. Introduction","sidebar":"contributeSidebar"},"contribute/COMMUNITY":{"id":"contribute/COMMUNITY","title":"Community at OpenSign\u2122","description":"Welcome to the OpenSign\u2122 Community page! OpenSign\u2122 is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign\u2122 project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign\u2122 community. Whether you\'re looking for support, eager to contribute or just want to stay updated, you\'ll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign\u2122 as the premier open-source alternative to DocuSign.","sidebar":"contributeSidebar"},"contribute/INSTALLATION":{"id":"contribute/INSTALLATION","title":"INSTALLATON INSTRUCTIONS","description":"You can use our app as a cloud version from OpenSignLabs","sidebar":"contributeSidebar"},"contribute/intro":{"id":"contribute/intro","title":"Contributing to OpenSign","description":"Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.","sidebar":"contributeSidebar"},"contribute/REPORTING_GUIDELINES":{"id":"contribute/REPORTING_GUIDELINES","title":"OpenSign\u2122 Reporting Guidelines","description":"This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the OpenSign\u2122 GitHub repository. Adhering to these guidelines helps maintain the project\'s quality and efficiency.","sidebar":"contributeSidebar"},"help/intro":{"id":"help/intro","title":"Intro","description":"\ud83c\udf1fGet ready for an electrifying journey at OpenSign\u2122, the most incredibly documented open source document signing solution! \ud83d\ude80 This is your go-to spot for diving deep into everything OpenSign\u2122 has to offer. Whether you\u2019re just starting out or you\u2019re a seasoned pro eager to uncover even more cool features, we\u2019ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign\u2122 \ud83c\udf89\ud83d\udcda\ud83d\udd0d Your adventure in excellence starts here! \ud83c\udf08\u2728\ud83c\udf1f","sidebar":"tutorialSidebar"},"help/New-Document/request-signatures":{"id":"help/New-Document/request-signatures","title":"Request signatures","description":"Interface Overview","sidebar":"tutorialSidebar"},"help/New-Document/sign-yourself":{"id":"help/New-Document/sign-yourself","title":"Sign yourself","description":"This feature lets you sign documents that dont need to be sent to anybody.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/create-document":{"id":"help/OpenSign\u2122 Drive/create-document","title":"Create Docs & Folders","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/list-grid-view":{"id":"help/OpenSign\u2122 Drive/list-grid-view","title":"Grid vs List view","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/organize-documents":{"id":"help/OpenSign\u2122 Drive/organize-documents","title":"OpenSign\u2122 Drive Interface Documentation","description":"Overview","sidebar":"tutorialSidebar"},"help/OpenSign\u2122 Drive/rename-document":{"id":"help/OpenSign\u2122 Drive/rename-document","title":"Rename documents from OpenSign\u2122 Drive","description":"The OpenSign\u2122 Drive interface allows users to rename their documents efficiently.","sidebar":"tutorialSidebar"},"help/Reports/completed":{"id":"help/Reports/completed","title":"Completed","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/declined":{"id":"help/Reports/declined","title":"Declined","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/drafts":{"id":"help/Reports/drafts","title":"Drafts","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/expired":{"id":"help/Reports/expired","title":"Expired","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/in-progress":{"id":"help/Reports/in-progress","title":"In Progress","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Reports/need-your-sign":{"id":"help/Reports/need-your-sign","title":"Need your sign","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/manage-users":{"id":"help/Settings/manage-users","title":"Manage users","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/my-signature":{"id":"help/Settings/my-signature","title":"My Signature","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Settings/profile":{"id":"help/Settings/profile","title":"Profile","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/create-template":{"id":"help/Templates/create-template","title":"Create Templates","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/quick-send":{"id":"help/Templates/quick-send","title":"Quickly Send template to a signer","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"help/Templates/use-template":{"id":"help/Templates/use-template","title":"Use template to create documents","description":"Welcome to the OpenSign\u2122 Help Center! This section is designed to provide you with all the necessary information to effectively use the OpenSign\u2122 application. Whether you are a new user or an experienced one looking to explore more features, our comprehensive guides and resources are here to assist you.","sidebar":"tutorialSidebar"},"intro":{"id":"intro","title":"Tutorial Intro","description":"Let\'s discover Docusaurus in less than 5 minutes."},"self-host/docker/run-locally":{"id":"self-host/docker/run-locally","title":"Localhost Setup with Docker","description":"Setup OpenSign\u2122 with Docker on Localhost","sidebar":"selfhostSidebar"},"self-host/intro":{"id":"self-host/intro","title":"Self-Hosting OpenSign","description":"This section of the OpenSign\u2122 documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign\u2122 - the best open source document signing infrastructure.","sidebar":"selfhostSidebar"},"self-host/One-click-Install/DigitalOcean":{"id":"self-host/One-click-Install/DigitalOcean","title":"Digital Ocean","description":"OpenSign application consistes of 3 components -","sidebar":"selfhostSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.0f2754b5.js b/assets/js/a2bc1463.0f2754b5.js new file mode 100644 index 000000000..eb572a8e5 --- /dev/null +++ b/assets/js/a2bc1463.0f2754b5.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>v,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var t=s(85893),i=s(11151),n=s(58219),l=(s(62316),s(51039)),c=s.n(l),r=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const u={id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1rIzcQ/ivqfOrB2l7n5UqXUi4cIYQLzUFSCk3MIe+OvRNrJZ2kdWzM/vdjtGt7HV/aXjlKwcTRzDNvj2bG2kCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdx8fFaYGXNMzov1qYWwQiHwREuUUihGGNmIu88JsI6s6SC9FxIkZvKOixRe1qiWBI+M1YqJeRSkpJThTtLQZr9u61gasxiCAkYi05ydtcFZNApOSwkYKWTFQZ0XNUGtKwQMlBUEWuJC/pco1tDAg4/1+SwgGwmlccEfFgrRs+MqyABXFllCoQsuJq1eYmVhGwDlVxRVVeQnadpAmFt2UjX1RQdNGwnK8uOxmmT7FLwC7LfLYPXY6bNhP16a7RHz9iTNOWvw0v1dZ6j97NaiR2bkEQuUQfGS2sV5VExevJstDlOwEyfMI+0O3YTqA3p0Ncq9HDSOckFU8DK/719K+bb3SF9cKTnkERqZOhLdrWDLcfTcnXyZJmSlvdvc/BkUEwRI6OVJPUv7KeI7zrBMDcVu7Kl0d+cytn4dHwSP+widygDFhfha272RifpyelgnA7Sn+7Hb7Ozn7Pzt8M0Tf+EBFZVrKbrxkKGWGWgoPrn2hb/QZzmJayb4QKDJOX7Bp0GmqYnJK1I46dtm3/iFm8i4iw9P272a72Uioq4uO7NAvUP36/V0Tnj/pqsfvjQhj9mgFpQ1MNBqX15W6THvHYU1nHDrQbS0qDVZw8THv8KQ2l4Nc6xXYmhhAxGh4vSo1tut2TtFGRQhmB9Nhr5IOek5wNp7dBY3tRzreTUczuPpKXRcgwcZpvGHVPVsnGQzH76LX1AHv+u1j6q24glyoI3WcPnmYnGHQO3FvUdzXXkbzmG498n8oJ8VBcmryvUId6lmBknXliLqfRYCKNFKDEqWX46HAtvMadZ1wZD8agf9Z2pUNQeeUsq0gufPeqBeLidzSgnqcQfOPUUcPLjlrnn5+cjxt5EmysKZT0VDq3Zw+dRGGntW+0ObyCBgK7yt7M7dEvKsbulV0KNInjUNTdPDTdou8e2oncvjbjZFOWoPfba8eLq4404HaaQ9JrjH6Q8url+f/nb3SV75fZqr2g8TIdp3ITGh0rqXqArDLvXRdeZB9e72Q/q//Al0jV4wFUYWSUpjm4kbNON3cPB+2SSQGl8YPFmw634u1NNw+L2ScDDWJDn2PtHwQLXvSfMUqqaYwK/LV7Bdm+NPXTCB0eMjUsi2Q4cB2xtLvIcbT/A0VY8WC1Xl/eQgKy5xv6gL+Kgd/+w961Kr3u+DzdAmwD/5Zq+avALX/UHXP+6g7eaVw26+rZovplJ0zRfAEQXtVs=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1rIzcQ/ivqfOrB2l7n5UqXUi4cIYQLzUFSCk3MIe+OvRNrJZ2kdWzM/vdjtGt7HV/aXjlKwcTRzDNvj2bG2kCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdx8fFaYGXNMzov1qYWwQiHwREuUUihGGNmIu88JsI6s6SC9FxIkZvKOixRe1qiWBI+M1YqJeRSkpJThTtLQZr9u61gasxiCAkYi05ydtcFZNApOSwkYKWTFQZ0XNUGtKwQMlBUEWuJC/pco1tDAg4/1+SwgGwmlccEfFgrRs+MqyABXFllCoQsuJq1eYmVhGwDlVxRVVeQnadpAmFt2UjX1RQdNGwnK8uOxmmT7FLwC7LfLYPXY6bNhP16a7RHz9iTNOWvw0v1dZ6j97NaiR2bkEQuUQfGS2sV5VExevJstDlOwEyfMI+0O3YTqA3p0Ncq9HDSOckFU8DK/719K+bb3SF9cKTnkERqZOhLdrWDLcfTcnXyZJmSlvdvc/BkUEwRI6OVJPUv7KeI7zrBMDcVu7Kl0d+cytn4dHwSP+widygDFhfha272RifpyelgnA7Sn+7Hb7Ozn7Pzt8M0Tf+EBFZVrKbrxkKGWGWgoPrn2hb/QZzmJayb4QKDJOX7Bp0GmqYnJK1I46dtm3/iFm8i4iw9P272a72Uioq4uO7NAvUP36/V0Tnj/pqsfvjQhj9mgFpQ1MNBqX15W6THvHYU1nHDrQbS0qDVZw8THv8KQ2l4Nc6xXYmhhAxGh4vSo1tut2TtFGRQhmB9Nhr5IOek5wNp7dBY3tRzreTUczuPpKXRcgwcZpvGHVPVsnGQzH76LX1AHv+u1j6q24glyoI3WcPnmYnGHQO3FvUdzXXkbzmG498n8oJ8VBcmryvUId6lmBknXliLqfRYCKNFKDEqWX46HAtvMadZ1wZD8agf9Z2pUNQeeUsq0gufPeqBeLidzSgnqcQfOPUUcPLjlrnn5+cjxt5EmysKZT0VDq3Zw+dRGGntW+0ObyCBgK7yt7M7dEvKsbulV0KNInjUNTdPDTdou8e2oncvjbjZFOWoPfba8eLq4404HaaQ9JrjH6Q8url+f/nb3SV75fZqr2g8TIdp3ITGh0rqXqArDLvXRdeZB9e72Q/q//Al0jV4wFUYWSUpjm4kbNON3cPB+2SSQGl8YPFmw634u1NNw+L2ScDDWJDn2PtHwQLXvSfMUqqaYwK/LV7Bdm+NPXTCB0eMjUsi2Q4cB2xtLvIcbT/A0VY8WC1Xl/eQgKy5xv6gL+Kgd/+w961Kr3u+DzdAmwD/5Zq+avALX/UHXP+6g7eaVw26+rZovplJ0zRfAEQXtVs=",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"}},v={},f=[{value:"Request",id:"request",level:2}];function g(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,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)(c(),{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)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,t.jsx)(o.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)(a.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)(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:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}}}]); \ No newline at end of file diff --git a/assets/js/a2bc1463.a13fae7c.js b/assets/js/a2bc1463.a13fae7c.js deleted file mode 100644 index b429dce54..000000000 --- a/assets/js/a2bc1463.a13fae7c.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2245],{87435:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>j,default:()=>g,frontMatter:()=>x,metadata:()=>u,toc:()=>v});var i=s(85893),t=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),c=(s(82723),s(9487)),o=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"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:"eJzNVm1rIzcQ/ivqfOrB2l7n5UqXUi4cIYQLd4GkFJqYQ94deyfWSjpJ69iY/e9ltGt7HV/aXjlKwcTRzPPMm2bG2kCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdxcXstsLLmGZ0Xa1OLYITD4AiXKKRQjDEzkXcWE2GdWVJBei6kyE1lHZaoPS1RLAmfGSuVEnIpScmpwh1TkGb7biuYGrMYQgLGopMc3XUBGXRKdgsJWOlkhQEdZ7UBLSuEDBRVxFrihL7U6NaQgMMvNTksIJtJ5TEBH9aK0TPjKkgAV1aZAiELrmZtXmIlIdtAJVdU1RVk52maQFhbJum6mqKDhnmysmxonDbJLgS/IPvdInjdZ9pM2K63Rnv0jD1JU/46vFRf5zl6P6uV2FUTklhL1IHx0lpFeVSMnjyTNscBmOkT5rHsjs0Eal069LUKPZx0TnLCFLDyf89vxXy7O6QPjvQcklgaGfqSXe5gy/G0XJ08WS7Jx1j3bzPwZFBMEZl+WUlS/4I/RXzXCYa5qdjUbWn0N4dyNj4dn8QPm8gdyoDFRfiamT3pJD05HYzTQfrT/fhtdvZzdv52mKbpH5DAqorZdN1YyBCzDBRU/1zb4j/w07yEdTNcYJCkfJ/QaaBpekLSijR+3rb5Z27xJiLO0vPjZr/WS6moiIvr3ixQ//D9Wh2dM+6vi9V3H1r3xxWgFhT1cJBqX94m6TGvHYV13HCrgbQ0aPXZw4THv8JQGl6Nc2xXYighg9HhovToltstWTsFGZQhWJ+NRj7IOen5QFo7NJY39VwrOfXcziNpabQcA7vZhnHHpWqrcRDMfvotfUAe/y7XPqrbiCXKgjdZw+eZieSuAp8s6jua61i/5RiOf5/IC/JRXZi8rlCHeJdiZpx4wRZT6bEQRotQYlSy/HQ4Ft5iTrOuDYbiUT/qO1OhqD3yllSkFz571APx8Gk2o5ykEr/j1FPAyY/byj0/Px9V7E3kXFEo66lwaM0ePo/CWNY+a3d4AwkEdJX/NLtDt6Qcu1t6xdUogkddc/PUcIO2e2wreveSxM2mKEftsdeOF1e3N+J0mELSa45/EPLo5vr95ce7S7bK7dVe0XiYDlMWWeNDJXXP0RWG3eui68yD693sB/V/+BLpGjzgKoyskhRHNxZs043dw8H7ZJJAaXxg8WbDrfibU03D4vZJwMNYkGff+0fBAte9J8xSqpp9Ar8tXsF2b409dMIHR4yNSyLZDhw7bDkXeY627+BoKx6slqvLe0hA1pxjf9AXcdC7f9j6VqXXPduHG6ANgP9yTl8l/MJX/QHXv+7greZVQpffFs03M2ma5k9VKrT7",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},j=void 0,u={id:"API-docs/contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",source:"@site/docs/API-docs/contactlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/contactlist",permalink:"/docs/API-docs/contactlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"contactlist",title:"Get Contact list",description:"The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.",sidebar_label:"Get Contact list",hide_title:!0,hide_table_of_contents:!0,api:"eJzNVm1rIzcQ/ivqfOrB2l7n5UqXUi4cIYQLd4GkFJqYQ94deyfWSjpJ69iY/e9ltGt7HV/aXjlKwcTRzPPMm2bG2kCQcw/ZA7w3Osg8eJgkUKDPHdlARkMG9yWKTituyAdxcXstsLLmGZ0Xa1OLYITD4AiXKKRQjDEzkXcWE2GdWVJBei6kyE1lHZaoPS1RLAmfGSuVEnIpScmpwh1TkGb7biuYGrMYQgLGopMc3XUBGXRKdgsJWOlkhQEdZ7UBLSuEDBRVxFrihL7U6NaQgMMvNTksIJtJ5TEBH9aK0TPjKkgAV1aZAiELrmZtXmIlIdtAJVdU1RVk52maQFhbJum6mqKDhnmysmxonDbJLgS/IPvdInjdZ9pM2K63Rnv0jD1JU/46vFRf5zl6P6uV2FUTklhL1IHx0lpFeVSMnjyTNscBmOkT5rHsjs0Eal069LUKPZx0TnLCFLDyf89vxXy7O6QPjvQcklgaGfqSXe5gy/G0XJ08WS7Jx1j3bzPwZFBMEZl+WUlS/4I/RXzXCYa5qdjUbWn0N4dyNj4dn8QPm8gdyoDFRfiamT3pJD05HYzTQfrT/fhtdvZzdv52mKbpH5DAqorZdN1YyBCzDBRU/1zb4j/w07yEdTNcYJCkfJ/QaaBpekLSijR+3rb5Z27xJiLO0vPjZr/WS6moiIvr3ixQ//D9Wh2dM+6vi9V3H1r3xxWgFhT1cJBqX94m6TGvHYV13HCrgbQ0aPXZw4THv8JQGl6Nc2xXYighg9HhovToltstWTsFGZQhWJ+NRj7IOen5QFo7NJY39VwrOfXcziNpabQcA7vZhnHHpWqrcRDMfvotfUAe/y7XPqrbiCXKgjdZw+eZieSuAp8s6jua61i/5RiOf5/IC/JRXZi8rlCHeJdiZpx4wRZT6bEQRotQYlSy/HQ4Ft5iTrOuDYbiUT/qO1OhqD3yllSkFz571APx8Gk2o5ykEr/j1FPAyY/byj0/Px9V7E3kXFEo66lwaM0ePo/CWNY+a3d4AwkEdJX/NLtDt6Qcu1t6xdUogkddc/PUcIO2e2wreveSxM2mKEftsdeOF1e3N+J0mELSa45/EPLo5vr95ce7S7bK7dVe0XiYDlMWWeNDJXXP0RWG3eui68yD693sB/V/+BLpGjzgKoyskhRHNxZs043dw8H7ZJJAaXxg8WbDrfibU03D4vZJwMNYkGff+0fBAte9J8xSqpp9Ar8tXsF2b409dMIHR4yNSyLZDhw7bDkXeY627+BoKx6slqvLe0hA1pxjf9AXcdC7f9j6VqXXPduHG6ANgP9yTl8l/MJX/QHXv+7greZVQpffFs03M2ma5k9VKrT7",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={},v=[{value:"Request",id:"request",level:2}];function y(e){const a={h2:"h2",p:"p",...(0,t.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(a.p,{children:"Get Contact list"})}),"\n",(0,i.jsx)(r(),{method:"get",path:"/contactlist"}),"\n",(0,i.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,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:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(o.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(a.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(c.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)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(s,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(a.p,{children:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(a.p,{children:"contactdetails[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(a.p,{children:"Array ["})})}),(0,i.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"ph1bhx2jp"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joebee@example.com"}}),(0,i.jsx)(m.Z,{collapsible:!1,name:"Phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"4131231231"}}),(0,i.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,i.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,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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.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,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)(c.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)(m.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 g(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/f0ff4a36.a10c7ea2.js b/assets/js/f0ff4a36.a10c7ea2.js new file mode 100644 index 000000000..a05ffc04a --- /dev/null +++ b/assets/js/f0ff4a36.a10c7ea2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var l=s(85893),i=s(11151),n=s(58219),t=(s(62316),s(51039)),r=s.n(t),c=(s(82723),s(9487)),m=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:"eJy9Vm1v2zYQ/ivcfWoA2ZZfkm7CMDTYsixrsRRLigFLjICSzhYTiWRJyolh6L8PR0m2bMdLA2z5YovHe3uO97YCx+cWohv4RSVlgdJZmAaQok2M0E4oCRFcZ8jO0bGWhZ1+vmAoeZyjZUtVMqeYQWcELpCl6LjILeOxKh3jzGpMxEwkLG2k+xCA0mg4ab9IIYI5uvYSAtDc8AIdGnJrBZIXCBG0DHcihQAEuaW5y2DXVxXfY+IuUqZma38hAINfS2EwhciZEgOwbpmTWisKnSMEgE86VylCNOO5JYYkw4JDtAK31J7TGSHnEMBMmYK7LgWfuNcSgf5tGGfJKNMxVNWUzFqtpEVLikZhSH/b/toySdDaWZmzdVAggERJR55HK+Ba5yLxF4N7S0Krfe9q2BQ9Q2qcqE220Xgtjl/PxcNoHGdffocqgJkg4us0ZM5pGw0GDaU0eT9RBWlzwr1enfUflEOkQir3ag06R26RWTGX61T04FSeonmrUNbZ/DoNtYfMi1abAG5KooFQBaAe5RaWb9J/r5DFiCRP0fGFt9bAjeFLqjiHhX05SofwPWsNCy7yF7ljxA8NoU0hnSn5gpnJ8cloOP7+/XArZA4LnXOHd1cNULpMDHKH6an7d42jcDTuDcNe+P56eBJNfoiOT/phGP4NATwV+QY8pNwhdN+pOZc6fQM71R5bJ9l3UweqigQm4WS/M627vVSOzVQp0+/+u8aExqhnE3UTh+fsd99SyFxIvGtb7N0knNyN14CO9wFdyAXPReqn17V6QPm2eLrmXW1+/7FEzeTvYQtsl16DtJiURrilH5NPPa5Fr76PbqY0fAp0mWrmq5+rLoMIBu3bD1admVoB6TOLduqWJu80cev4XMh5j2vdVxoltYmcx5bqccC1GCyGQBZbj64oanVgtvzadBUtPiK1lQZ2l6uZ7hly39QqOs+UF26CcalRUgH7UC6GezvAdSYsE9Zftxj9s7KZMmxHmsXcYsqUZC5Df0n0cX+43ly8aJ/dylt5pQpkpUUa17mQDza6lT12czmbiUTwnP2FsRUOp+/ayD0+Pu5F7MjLnAuXlTEzqNWGfe6JPqxdqfXhCAJwaAp7ObtCsxBJO2oPmBp45kGT5zzxed603Zb0YVeI8i4XCUqLncw8Pf/8iY37IQSd5PgGlwefLn4+++PqjLRSetVPNOyH/dC3cmVdwWXHUHfT3H3a1aZe/4ettElOh09uoHMufAV6sKumem6gs6hG3Z10GkCmrCOW1YpS6ovJq4rIX0s0VKPTABbcCPLPl1gqLH2n65XzINJ3fzbb6xE7sN4+63lba5IKbcHzkk4QwAMudxbqaloFbcGRazXHaZKgdh3ZvQa51WXOz64hAF5SnLqF/uALvfkg7c/6td0BagfotwoOCPxIz/0Rlz+t2eubgwINvpabYjStquofRhtqEg==",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:"eJy9Vm1v2zYQ/ivcfWoA2ZZfkm7CMDTYsixrsRRLigFLjICSzhYTiWRJyolh6L8PR0m2bMdLA2z5YovHe3uO97YCx+cWohv4RSVlgdJZmAaQok2M0E4oCRFcZ8jO0bGWhZ1+vmAoeZyjZUtVMqeYQWcELpCl6LjILeOxKh3jzGpMxEwkLG2k+xCA0mg4ab9IIYI5uvYSAtDc8AIdGnJrBZIXCBG0DHcihQAEuaW5y2DXVxXfY+IuUqZma38hAINfS2EwhciZEgOwbpmTWisKnSMEgE86VylCNOO5JYYkw4JDtAK31J7TGSHnEMBMmYK7LgWfuNcSgf5tGGfJKNMxVNWUzFqtpEVLikZhSH/b/toySdDaWZmzdVAggERJR55HK+Ba5yLxF4N7S0Krfe9q2BQ9Q2qcqE220Xgtjl/PxcNoHGdffocqgJkg4us0ZM5pGw0GDaU0eT9RBWlzwr1enfUflEOkQir3ag06R26RWTGX61T04FSeonmrUNbZ/DoNtYfMi1abAG5KooFQBaAe5RaWb9J/r5DFiCRP0fGFt9bAjeFLqjiHhX05SofwPWsNCy7yF7ljxA8NoU0hnSn5gpnJ8cloOP7+/XArZA4LnXOHd1cNULpMDHKH6an7d42jcDTuDcNe+P56eBJNfoiOT/phGP4NATwV+QY8pNwhdN+pOZc6fQM71R5bJ9l3UweqigQm4WS/M627vVSOzVQp0+/+u8aExqhnE3UTh+fsd99SyFxIvGtb7N0knNyN14CO9wFdyAXPReqn17V6QPm2eLrmXW1+/7FEzeTvYQtsl16DtJiURrilH5NPPa5Fr76PbqY0fAp0mWrmq5+rLoMIBu3bD1admVoB6TOLduqWJu80cev4XMh5j2vdVxoltYmcx5bqccC1GCyGQBZbj64oanVgtvzadBUtPiK1lQZ2l6uZ7hly39QqOs+UF26CcalRUgH7UC6GezvAdSYsE9Zftxj9s7KZMmxHmsXcYsqUZC5Df0n0cX+43ly8aJ/dylt5pQpkpUUa17mQDza6lT12czmbiUTwnP2FsRUOp+/ayD0+Pu5F7MjLnAuXlTEzqNWGfe6JPqxdqfXhCAJwaAp7ObtCsxBJO2oPmBp45kGT5zzxed603Zb0YVeI8i4XCUqLncw8Pf/8iY37IQSd5PgGlwefLn4+++PqjLRSetVPNOyH/dC3cmVdwWXHUHfT3H3a1aZe/4ettElOh09uoHMufAV6sKumem6gs6hG3Z10GkCmrCOW1YpS6ovJq4rIX0s0VKPTABbcCPLPl1gqLH2n65XzINJ3fzbb6xE7sN4+63lba5IKbcHzkk4QwAMudxbqaloFbcGRazXHaZKgdh3ZvQa51WXOz64hAF5SnLqF/uALvfkg7c/6td0BagfotwoOCPxIz/0Rlz+t2eubgwINvpabYjStquofRhtqEg==",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)(r(),{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)(m.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)(c.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:"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)("li",{children:(0,l.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,l.jsx)(a.p,{children:"]"})})})]})]})}),(0,l.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,l.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,l.jsx)(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 "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',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)(c.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)(c.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/f0ff4a36.a5657d8a.js b/assets/js/f0ff4a36.a5657d8a.js deleted file mode 100644 index da028e9e6..000000000 --- a/assets/js/f0ff4a36.a5657d8a.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[1332],{94348:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>f,contentTitle:()=>x,default:()=>y,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var t=s(85893),i=s(11151),l=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),c=s(41429),m=s(5397),o=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:"eJy9Vutu2zYUfhXu/GoA2ZaTtMWEYViwplnWIikWFwOWGAEtHVtMKJIlKceGoX97kj3anmQ41CVynGwzsPWPLR6ey3fu3IDnCwfJNbzTaVmg8g6mEWToUiuMF1pBApMc2Rl61rKwk0/nDBWfSXRsrUvmNbPorcAlsgw9F9IxPtOlZ5w5g6mYi5RljfQQItAGLSft5xkksEDfXkIEhlteoEdLsDageIGQQMtwKzKIQBAsw30OT7Hq2R2m/jxjet7hhQgsfimFxQwSb0uMwPm1JLVOFEYiRIArI3WGkMy5dMSQ5lhwSDbg1yZweivUAiKYa1tw36fgigctCZifxrM8PczNDKpqSmad0cqhI0WHcUx/23hdmabo3LyUrAsKRJBq5Ql5sgFujBRpuBjdORLa7KKr3aboWVLjRW2yjca+frw/E/eHR7P8889QRTARnqj7qXDhg7JOKi6031uDkcgdMicWqise0vVeywztvtouDaorsVB//v4He2fFEoMqsb9juffGJaNRQymtHKa6IG2XD2p/XHca2QwDGoIXyr7TwK3la6p3j4X753RfhF7Ztb9lDaoqAl+nFDwWRnKPt61tukwtco/Zif97XYfx4dFgHA/it5Pxm+T42+T1m2Ecx79BBKtCkmzbu9wH/1qj7bk02VewU+2w9WqpY+1oFQkcx8e7rdqNP6U9m+tSZd/8d52K1upna+cxDs/Z7+dSKCkU3rYz5/Y4Pr496hx6vevQuVpyKbIwzif6HtXX9adv3tfmd5MlaqZwD1vO9um1kw7T0gq/DntjNeBGDOr75HpK07hAn+tm4YRF43NIYNTmfrTpLZkKSJ9dtmuotLLX+87zhVCLATdmqA0qmlGSzxxNghE3YrQcA1lsEV1R1OrAbOF6bHQjPiB1euN2n6tZdzlyGnvkqFBzHYSbYLSzLYRyOd5ZipNcOCZcuG59DGllc23ZE2k24w4zphXzOYZLoh8Nx90qD6JDdqNu1JUukJUOaX9Joe5dcqMG7PpyPhep4JL9ijMnPE5ftZF7eHjYidhBkDkTPi9nzKLRj+yLQAxh7Ut1hwOIwKMt3OX8Cu1SpO2EfsHUKDCPmjrnaahzLLig7DakH54KUd1JkaJy2KvMk7NPH9nRMIaoVxz/AvLo4/mPpxdXp6SVyqtO0XgYD2MiGe18wVXPUP/p9TS1m8d+/R+eaU1xelz5kZFchA4Mzm6a7rmG3sst6T/SphHk2nli2WyopD5bWVVE/lKipR6dRrDkVhC+0GKZcPSddW+wFz199UvznDtgL7z3nkXe9pqiRltyWdIJIrjH9ZMXZjWtorbhCFrNcZKmaHxPdmdAbk2Zs9MJRMBLilO/0e9DozcfpP1ZXNsToAZAv1X0gsB3lO4PuP6+Y69vXhRo/Gu5KUbTqqr+Ap7vGoM=",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:"eJy9Vutu2zYUfhXu/GoA2ZaTtMWEYViwplnWIikWFwOWGAEtHVtMKJIlKceGoX97kj3anmQ41CVynGwzsPWPLR6ey3fu3IDnCwfJNbzTaVmg8g6mEWToUiuMF1pBApMc2Rl61rKwk0/nDBWfSXRsrUvmNbPorcAlsgw9F9IxPtOlZ5w5g6mYi5RljfQQItAGLSft5xkksEDfXkIEhlteoEdLsDageIGQQMtwKzKIQBAsw30OT7Hq2R2m/jxjet7hhQgsfimFxQwSb0uMwPm1JLVOFEYiRIArI3WGkMy5dMSQ5lhwSDbg1yZweivUAiKYa1tw36fgigctCZifxrM8PczNDKpqSmad0cqhI0WHcUx/23hdmabo3LyUrAsKRJBq5Ql5sgFujBRpuBjdORLa7KKr3aboWVLjRW2yjca+frw/E/eHR7P8889QRTARnqj7qXDhg7JOKi6031uDkcgdMicWqise0vVeywztvtouDaorsVB//v4He2fFEoMqsb9juffGJaNRQymtHKa6IG2XD2p/XHca2QwDGoIXyr7TwK3la6p3j4X753RfhF7Ztb9lDaoqAl+nFDwWRnKPt61tukwtco/Zif97XYfx4dFgHA/it5Pxm+T42+T1m2Ecx79BBKtCkmzbu9wH/1qj7bk02VewU+2w9WqpY+1oFQkcx8e7rdqNP6U9m+tSZd/8d52K1upna+cxDs/Z7+dSKCkU3rYz5/Y4Pr496hx6vevQuVpyKbIwzif6HtXX9adv3tfmd5MlaqZwD1vO9um1kw7T0gq/DntjNeBGDOr75HpK07hAn+tm4YRF43NIYNTmfrTpLZkKSJ9dtmuotLLX+87zhVCLATdmqA0qmlGSzxxNghE3YrQcA1lsEV1R1OrAbOF6bHQjPiB1euN2n6tZdzlyGnvkqFBzHYSbYLSzLYRyOd5ZipNcOCZcuG59DGllc23ZE2k24w4zphXzOYZLoh8Nx90qD6JDdqNu1JUukJUOaX9Joe5dcqMG7PpyPhep4JL9ijMnPE5ftZF7eHjYidhBkDkTPi9nzKLRj+yLQAxh7Ut1hwOIwKMt3OX8Cu1SpO2EfsHUKDCPmjrnaahzLLig7DakH54KUd1JkaJy2KvMk7NPH9nRMIaoVxz/AvLo4/mPpxdXp6SVyqtO0XgYD2MiGe18wVXPUP/p9TS1m8d+/R+eaU1xelz5kZFchA4Mzm6a7rmG3sst6T/SphHk2nli2WyopD5bWVVE/lKipR6dRrDkVhC+0GKZcPSddW+wFz199UvznDtgL7z3nkXe9pqiRltyWdIJIrjH9ZMXZjWtorbhCFrNcZKmaHxPdmdAbk2Zs9MJRMBLilO/0e9DozcfpP1ZXNsToAZAv1X0gsB3lO4PuP6+Y69vXhRo/Gu5KUbTqqr+Ap7vGoM=",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,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Get Document"})}),"\n",(0,t.jsx)(r(),{method:"get",path:"/document/{document_id}"}),"\n",(0,t.jsx)(a.p,{children:"The Get Document API enables you to retrieve details about a specific document."}),"\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:"document_id",in:"path",description:"objectId of Document",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)(l.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)(d.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)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"File",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,t.jsx)(o.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:"Signers"})}),(0,t.jsx)("span",{className:"openapi-schema__name",children:(0,t.jsx)(a.p,{children:"object[]"})})]})}),(0,t.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,t.jsx)("li",{children:(0,t.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,t.jsx)(a.p,{children:"Array ["})})}),(0,t.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(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)(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,t.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,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\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:"404",value:"404",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document not found!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(d.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)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document not found!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(m.Z,{responseExample:'{\n "error": "Document not found!"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(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)(d.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)(o.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)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function y(e={}){const{wrapper:a}={...(0,i.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/fa40969b.0c2427ac.js b/assets/js/fa40969b.0c2427ac.js new file mode 100644 index 000000000..179ce80aa --- /dev/null +++ b/assets/js/fa40969b.0c2427ac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),i=a(58219),t=(a(62316),a(51039)),r=a.n(t),c=(a(82723),a(9487)),d=a(41429),m=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:"eJztV21v2zYQ/isc+6UNZFt2nHQThqFBmwVZi7VIUgxYYgS0dLLYUCRLUk4MQ/99OEq05dhpk6Lrp35JLPLenuPD492SOjazNLmkb1RalSCdpZOIZmBTw7XjStKEPnv2jIRtcrHQYJMreQbOcJgDYURw64jKSRZMkCmzkBEliVtouJJXctgne3tvDMvdypJN9vauJCGE9NZrxBXMEWaApJUxIJ1YEC5J5jWtY66yfbQ3QnvnfCaZqwyQM/hcgf2SSQOfK26AuALIQlWG2KDs7e2jvVPZ+2DUzIC13xSlbpW9xTFafK1KLcBB9hh7BZsDmQJIYqs0BWvzSogFSVc2brkrCBMigMnWIBqfB+jz+E77vcd6hFaeycxDkooIJWdgCPNR8KlocnTozxBSweVTAWVBa7rwJ1BZMP0rSSOqNBiGPDvNaEJn4AKJkFQ0opoZVoIDgyRdUslKoAnNVIrMohHlSFDNXEHvs/aiAE+/TWY6RUzLXBrRkEiaOFNBRK1bCLRvOeacRhTutFAZ0CRnwqJAWkDJaLKk3n9CrTNczlBSViXeI0/VlT8a0dUZmYakPuhAla7g6qA7a+3hdFZCKtfXta6jVWIEL7kLaflcgVlsoAwoWpi5MmUXZJuEFcaS3fESYR3EcRQQy6qcgqE16jGfpmQYd0KwN1x/twge9hnXE7RrtZIWLMqO4hj/bbJgfZXIimo+19KBdCjPtBY89RuDTxaVltsBqOknSD0fDZpxvHFpwFbCdeSYMQwBcwel/bp+s4zU3yYUpoa5DYoF7PTPE34z2p8WH//CnOQcF59moXBO22QwaFcqI/qpKtGa4+7p5qz/gfcMTUjlnmxBC2AWfEVbXVcPTokMzI9KZcPhp1loIiRetV4nkAYU1y2EOqLqVm5geZT9T8pXUdTH7PhS+K2EewjfTm9QMi6+Kj0FeNUuBArpQsmvuBkfHI6G+7++HG6kzEGpBXNwfd4Cxc3UAHOQHbkvWxzFo/3eMO7FLy+Gh8n4t+TgsB/H8b80onelWIOnGXNAu+fUflc6+wF+6i2xDtnvU4fW3exwiZX/OhS961EcX49RpI7oOB5vF78z0Mo4IpUjbM64YFMBv3y/6gfGqJ1sXidrdwRfAjWOx9cHK1AH26BO5ZwJnpGjD6fkQt2A/LGIuu5d4377THkj5PfpBtjuegPSQloZ7ha+v7nrMc17zX5yOcE3rgRXqLY58g2RK2hCB90+abBsG6Ia+w0w89AuVUZ0ar11bMblrMe07isNEquJYFOL13bANB/MhxQ9hojOMWtNYjbiWhcfzd8CVp8Wdleq7QAKYL721fidK6/cJuO9Bon33KdyPtzRwHFLuPXbAa0/VpIrQ+5pd0aOAvwmru/3h8RqSHneMqJPsJM9V6XvQbErEFze4DzTI5fv85ynnAnyD0wtdzB5HjJ3e3u7lbEXXueEu6KaEgNarcVnftGntau1+nhBI+rAlPZ9fg5mztPwIj/gauCFBy3PWep53lbnsPTqvhLyTvAUpIUOM49OPrwj+/2YRh1yPCLkwbvT18d/nx+jVaRXc0TDftyPfcVX1pVMdhydwHrUaybE3KiyneHun/VyfYF/Tps/p83/bdps65aDOzfQgnFfnP09WLaF9ZLeG0CTMGtOIloo61BkuUTKfTSirnG5mXKw3mbc4gu3nnNuYNGZyuZMVOif4rj0gGw7Pq1FJ/hhOMru9vHgTXp+1p7cC/KYYXhnckKll4tuUCHYkJt6Ukeh1GOMze5RmoLu4t56mjfet5PjCxpRVuExdJ+YG//EtD/Q+s6YNt+eJgD8i6neqfA7PhBvYfHHSrzZeVChxRekMT+Tuq7/A7Fak+w=",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:"eJztV21v2zYQ/isc+6UNZFt2nHQThqFBmwVZi7VIUgxYYgS0dLLYUCRLUk4MQ/99OEq05dhpk6Lrp35JLPLenuPD492SOjazNLmkb1RalSCdpZOIZmBTw7XjStKEPnv2jIRtcrHQYJMreQbOcJgDYURw64jKSRZMkCmzkBEliVtouJJXctgne3tvDMvdypJN9vauJCGE9NZrxBXMEWaApJUxIJ1YEC5J5jWtY66yfbQ3QnvnfCaZqwyQM/hcgf2SSQOfK26AuALIQlWG2KDs7e2jvVPZ+2DUzIC13xSlbpW9xTFafK1KLcBB9hh7BZsDmQJIYqs0BWvzSogFSVc2brkrCBMigMnWIBqfB+jz+E77vcd6hFaeycxDkooIJWdgCPNR8KlocnTozxBSweVTAWVBa7rwJ1BZMP0rSSOqNBiGPDvNaEJn4AKJkFQ0opoZVoIDgyRdUslKoAnNVIrMohHlSFDNXEHvs/aiAE+/TWY6RUzLXBrRkEiaOFNBRK1bCLRvOeacRhTutFAZ0CRnwqJAWkDJaLKk3n9CrTNczlBSViXeI0/VlT8a0dUZmYakPuhAla7g6qA7a+3hdFZCKtfXta6jVWIEL7kLaflcgVlsoAwoWpi5MmUXZJuEFcaS3fESYR3EcRQQy6qcgqE16jGfpmQYd0KwN1x/twge9hnXE7RrtZIWLMqO4hj/bbJgfZXIimo+19KBdCjPtBY89RuDTxaVltsBqOknSD0fDZpxvHFpwFbCdeSYMQwBcwel/bp+s4zU3yYUpoa5DYoF7PTPE34z2p8WH//CnOQcF59moXBO22QwaFcqI/qpKtGa4+7p5qz/gfcMTUjlnmxBC2AWfEVbXVcPTokMzI9KZcPhp1loIiRetV4nkAYU1y2EOqLqVm5geZT9T8pXUdTH7PhS+K2EewjfTm9QMi6+Kj0FeNUuBArpQsmvuBkfHI6G+7++HG6kzEGpBXNwfd4Cxc3UAHOQHbkvWxzFo/3eMO7FLy+Gh8n4t+TgsB/H8b80onelWIOnGXNAu+fUflc6+wF+6i2xDtnvU4fW3exwiZX/OhS961EcX49RpI7oOB5vF78z0Mo4IpUjbM64YFMBv3y/6gfGqJ1sXidrdwRfAjWOx9cHK1AH26BO5ZwJnpGjD6fkQt2A/LGIuu5d4377THkj5PfpBtjuegPSQloZ7ha+v7nrMc17zX5yOcE3rgRXqLY58g2RK2hCB90+abBsG6Ia+w0w89AuVUZ0ar11bMblrMe07isNEquJYFOL13bANB/MhxQ9hojOMWtNYjbiWhcfzd8CVp8Wdleq7QAKYL721fidK6/cJuO9Bon33KdyPtzRwHFLuPXbAa0/VpIrQ+5pd0aOAvwmru/3h8RqSHneMqJPsJM9V6XvQbErEFze4DzTI5fv85ynnAnyD0wtdzB5HjJ3e3u7lbEXXueEu6KaEgNarcVnftGntau1+nhBI+rAlPZ9fg5mztPwIj/gauCFBy3PWep53lbnsPTqvhLyTvAUpIUOM49OPrwj+/2YRh1yPCLkwbvT18d/nx+jVaRXc0TDftyPfcVX1pVMdhydwHrUaybE3KiyneHun/VyfYF/Tps/p83/bdps65aDOzfQgnFfnP09WLaF9ZLeG0CTMGtOIloo61BkuUTKfTSirnG5mXKw3mbc4gu3nnNuYNGZyuZMVOif4rj0gGw7Pq1FJ/hhOMru9vHgTXp+1p7cC/KYYXhnckKll4tuUCHYkJt6Ukeh1GOMze5RmoLu4t56mjfet5PjCxpRVuExdJ+YG//EtD/Q+s6YNt+eJgD8i6neqfA7PhBvYfHHSrzZeVChxRekMT+Tuq7/A7Fak+w=",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},f={},g=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(r(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(i.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"folder"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/fa40969b.7625b669.js b/assets/js/fa40969b.7625b669.js deleted file mode 100644 index 66355895e..000000000 --- a/assets/js/fa40969b.7625b669.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[273],{61247:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>g});var n=a(85893),l=a(11151),r=a(58219),i=(a(62316),a(51039)),t=a.n(i),c=(a(82723),a(9487)),d=a(41429),m=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",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:"eJztV91u2zYUfhWOvWkD2ZYTp8OEYVjQpkHaoimSFAOWGAEtHVtsKJIhKSeGobs9yR5tTzIcSpTl2OmSoutVbxLr8Px953w8JJfUsZmlyQV9rdKyAOksHUc0A5sarh1Xkib02bNnJCyT84UGm1zKU3CGwxwII4JbR9SUZMEFmTALGVGSuIWGS3kph32ys/PasKlrPdlkZ+dSEkJIbyUjLmeOMAMkLY0B6cSCcEkyb2kdc6Xto79d9HfGZ5K50gA5hZsS7JdcGrgpuQHiciALVRpig7H3t4f+jmXvo1EzA9Z+VZa6MfYeR+jxlSq0AAfZY/zlbA5kAiCJLdMUrJ2WQixI2vq45S4nTIgAJluBqGPuY8zDO+3XHhsRGn0mMw9JKiKUnIEhzGfBJ6Ku0UvfQ0gFl08FlAWrycJ3oLRg+peSRlRpMAx5dpzRhM7ABRIhqWhENTOsAAcGSbqkkhVAE5qpFJlFI8qRoJq5nN5n7XkOnn7rzHSKmIa5NKKhkDRxpoSIWrcQ6N9yrDmNKNxpoTKgyZQJiwppDgWjyZL6+Am1znA5Q01ZFriPPFXbeDSibY9MTVKfdKBKV7FtdEfWNKcjCaVcbdeqitrCCF5wF8pyU4JZrKEMKBqYU2WKLsimCC3Ggt3xAmHtx3EUEMuymIChFdoxX6ZkGHdSsNdcf7MMHo4ZV2P0a7WSFizq7sYx/ltnwWorkZZqvtbSgXSoz7QWPPULg88WjZabCajJZ0g9Hw26cbwOacCWwnX0mDEMAXMHhf1v+1qM1N8kFJaGuTWKBez0zRG/3t2b5J/eYk3OuUPp01xY/wN3Brr4oNyTPWgBzIKfQe0GQ19vlMjAPNXbiQaJA/2fv/4mrw2fg3fFnw4sd07bZDBoJKUR/VQV6O3kVj49r8/KzzC0x/T8IPradn/wO2TL7OhGo1UVUVe3lDootGAOrkJsXEwNMAfZgfuyr914d683jHvxz+fDl8nol2T/ZT+O4z9pRO8KgbZhmjLn8YWg4bvU2XeIU22odbjUqraybnW4xFF4FabA1W4cX41QpYroKB5tToNT0Mo4IpUjbM64YBMBP327cQDGqK0EWxVrewZfAjWKR1f7Laj9TVDHcs4Ez8jBx2Nyrq5Bfl9E3fCuDr/ZU14r+XW6BrYrr0FaSEvD3cIf+Hc9pnmvXk8uxjj0C3C5am4L/obgcprQQffiMFg2N4QKD2Aw83B/KI3ojAjr2IzLWY9p3VcaJI4ywSYWB8aAaT6YDylGDBmdYdXqwqzltZoHmr8DHAgN7K5WcyTmwHA6IlAup8obN8UII9CXcj7ccqPhlnDrlwNa31YyVYbcs+7cwXPwiyjf6w+J1ZDyacOIPsGr3Zkq/KUMj0nB5TVe8Hvk4mQ65SlngvwBE8sdjJ+Hyt3e3m5U7IW3OeIuLyfEgFYr9ZkX+rJ2rdqPFzSiDkxhT6ZnYOY8DYP8gVADrzxoeM5Sz3MoGMfuNqLf7xsh7wRPQVroMPPg6ON7stePadQhxyNSHrw/fnX44ewQvSK96hYN+3E/RpFW1hVMdgIdwertUz+ZpkYVzaPmfq+Xqw384/n14/n1vz2/mrnl4M4NtGDcD2e/D5bNYL2g915kSXh8jSOaK+tQZblEyn0yoqpQXF/7cd5m3OIJt7r4X8Oi80yZM1FifIrvhwd0m/fESnWMH4aj7vYYD+6k56dN516Qx7wOtxYnTHq56CYVkg21qcZVFEY95livHqQp6C7ujaN57Xw7OjynEWUltqF7xFz7I6b5gd635rR+9tQJ4F8s9VaDX/GAeAeL31r1euVBgwZf0Mb6jKuq+hdZ1kRd",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},f={},g=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function y(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,l.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Signature Requests:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that require the your signature."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draftdocuments","signaturerequest","inprogressdocuments","completedocuments","expiredocuments","declinedocuments"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(d.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(r.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"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:!1,name:"Folder",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"OpenSign\u2122 Drive"}}),(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:"Owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"Signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "Title": "sample doc",\n "Note": "please sign document",\n "Folder": "OpenSign\u2122 Drive",\n "File": "https://exampleurl.com",\n "Owner": "joe bee",\n "Signers": [\n {\n "Name": "joe"\n }\n ],\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(c.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(m.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,l.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(y,{...e})}):y(e)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.62e4d2a4.js b/assets/js/runtime~main.6ea5e49f.js similarity index 72% rename from assets/js/runtime~main.62e4d2a4.js rename to assets/js/runtime~main.6ea5e49f.js index cc9603036..d7ec2abd3 100644 --- a/assets/js/runtime~main.62e4d2a4.js +++ b/assets/js/runtime~main.6ea5e49f.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,c,b,r,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,b,r)=>{if(!c){var d=1/0;for(n=0;n=r)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,r0&&e[n-1][2]>r;n--)e[n]=e[n-1];e[n]=[c,b,r]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,b){if(1&b&&(e=this(e)),8&b)return e;if("object"==typeof e&&e){if(4&b&&e.__esModule)return e;if(16&b&&"function"==typeof e.then)return e}var r=Object.create(null);t.r(r);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&b&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(r,d),r},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7917:"0028a090",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"00fbee30",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"7625b669",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"a5657d8a",1344:"27d8ad2d",1477:"b31b2642",1512:"7ddd2ec3",1520:"9d881f10",1531:"0275f043",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1615d374",2121:"c8df990c",2241:"e6e648f1",2245:"a13fae7c",2267:"a4846e2b",2362:"ebdb1814",2403:"bd03a448",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"a018c535",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"ddf2d459",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"a995c609",6011:"6de743c9",6033:"fcbda936",6103:"ebc8482f",6113:"f155125f",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"137eb6e8",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"2a49d56a",7917:"1a71e32c",7971:"37040646",8055:"27482879",8087:"fd9041fd",8106:"325a77d7",8140:"901b2f91",8141:"6478079e",8163:"6e9541b8",8468:"a1f30bed",8474:"f58804a4",8475:"d27b3009",8489:"3033ed56",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"583ba3e8",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"2b4fb8c8",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"f9ece43f",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),b={},r="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(b[e])b[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var r=b[e];if(delete b[e],f.parentNode&&f.parentNode.removeChild(f),r&&r.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","0028a090":"7917","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var b=t.o(e,a)?e[a]:void 0;if(0!==b)if(b)c.push(b[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var r=new Promise(((c,r)=>b=e[a]=[c,r]));c.push(b[2]=r);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(b=e[a])&&(e[a]=void 0),b)){var r=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+r+": "+d+")",f.name="ChunkLoadError",f.type=r,f.request=d,b[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var b,r,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(b in f)t.o(f,b)&&(t.m[b]=f[b]);if(o)var n=o(t)}for(a&&a(c);l{"use strict";var e,a,c,r,b,d={},f={};function t(e){var a=f[e];if(void 0!==a)return a.exports;var c=f[e]={id:e,loaded:!1,exports:{}};return d[e].call(c.exports,c,c.exports,t),c.loaded=!0,c.exports}t.m=d,t.c=f,e=[],t.O=(a,c,r,b)=>{if(!c){var d=1/0;for(n=0;n=b)&&Object.keys(t.O).every((e=>t.O[e](c[o])))?c.splice(o--,1):(f=!1,b0&&e[n-1][2]>b;n--)e[n]=e[n-1];e[n]=[c,r,b]},t.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return t.d(a,{a:a}),a},c=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,t.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var b=Object.create(null);t.r(b);var d={};a=a||[null,c({}),c([]),c(c)];for(var f=2&r&&e;"object"==typeof f&&!~a.indexOf(f);f=c(f))Object.getOwnPropertyNames(f).forEach((a=>d[a]=()=>e[a]));return d.default=()=>e,t.d(b,d),b},t.d=(e,a)=>{for(var c in a)t.o(a,c)&&!t.o(e,c)&&Object.defineProperty(e,c,{enumerable:!0,get:a[c]})},t.f={},t.e=e=>Promise.all(Object.keys(t.f).reduce(((a,c)=>(t.f[c](e,a),a)),[])),t.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",230:"d91ad230",261:"reactPlayerKaltura",273:"fa40969b",420:"e2c87691",453:"30a24c52",533:"b2b675dd",762:"d8b805fb",823:"c7b98810",841:"c5e4dae0",853:"277a78f5",948:"8717b14a",1332:"f0ff4a36",1344:"f864295c",1477:"b2f554cd",1512:"e9e778b7",1520:"770b40a9",1531:"bbdfc22d",1633:"031793e1",1713:"a7023ddc",1773:"ef5d5d5d",1893:"4c5e977b",1914:"d9f32620",2087:"bfe4b778",2121:"reactPlayerFacebook",2241:"2ace9d1d",2245:"a2bc1463",2267:"59362658",2362:"e273c56f",2403:"38c56221",2535:"814f3328",2546:"reactPlayerStreamable",2832:"1f73ca32",2865:"3e02da86",3085:"1f391b9e",3089:"a6aa9e1f",3101:"64ee8796",3137:"1a2f05d3",3156:"11b7b3d8",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3743:"reactPlayerVimeo",4013:"01a85c17",4195:"c4f5d8e4",4277:"14716de7",4368:"a94703ab",4439:"reactPlayerYouTube",4478:"d1393a72",4651:"05632a52",4667:"reactPlayerMixcloud",4772:"b0378e01",4918:"1f7895dc",4955:"e226bb09",4985:"b839bf37",5377:"ce589067",5507:"8320e026",5858:"046910c8",5900:"38e3d9c8",6011:"reactPlayerFilePlayer",6033:"28b19cd2",6103:"ccc49370",6113:"13fdae3b",6125:"reactPlayerSoundCloud",6177:"611db08b",6216:"reactPlayerTwitch",6344:"984cf7cf",6543:"17e5210b",6741:"e2a6fad1",6759:"c9fa5aa5",6938:"608ae6a4",7100:"2c416566",7178:"096bfee4",7414:"393be207",7475:"500027af",7596:"reactPlayerDailyMotion",7664:"reactPlayerPreview",7894:"a88a3db3",7917:"0028a090",7971:"8a725248",8055:"reactPlayerWistia",8087:"e4f5c862",8106:"377084eb",8141:"98da7451",8163:"5a2de241",8468:"52d5c0f9",8474:"9640838e",8489:"7b076186",8518:"a7bd4aaa",8610:"6875c492",8636:"f4f34a3a",8766:"70853c19",8781:"489b8a4d",8866:"eb56c656",8878:"cf03142d",8888:"reactPlayerVidyard",8892:"38ec836e",9003:"925b3f96",9010:"06b6ef6a",9035:"4c9e35b1",9588:"5c04ee3b",9642:"7661071f",9661:"5e95c892",9671:"0e384e19",9697:"2c586be5",9700:"e16015ca",9817:"14eb3368",9914:"0c0943c7"}[e]||e)+"."+{53:"26c9597e",110:"ab20026d",230:"5170466b",261:"4b30f79b",273:"0c2427ac",420:"c9c1a330",453:"61f3e45f",533:"2d5f5b1d",762:"0be52068",823:"81840a08",841:"b9d70538",853:"6aef91ee",948:"b2da1fd1",1332:"a10c7ea2",1344:"27d8ad2d",1477:"b31b2642",1512:"7ddd2ec3",1520:"6a911971",1531:"0275f043",1633:"d8366831",1713:"fefd4794",1772:"c222a62c",1773:"d5cdc9ed",1893:"59606182",1914:"eb382def",2087:"1615d374",2121:"c8df990c",2241:"e6e648f1",2245:"0f2754b5",2267:"a4846e2b",2362:"ebdb1814",2403:"1cc28782",2529:"2079a565",2535:"f3b6b0ab",2546:"665b04f4",2832:"71a25ebe",2865:"89ed6402",3085:"e5c5d651",3089:"84b5c675",3101:"47959e32",3137:"071bc9df",3156:"41df5616",3205:"af75d475",3514:"b2437ac4",3608:"0e768bf1",3743:"2ede10ee",4013:"e5e25f55",4148:"aa6a1681",4195:"1659087e",4277:"5fe62968",4311:"86f3bfc6",4368:"7d12b1da",4439:"6a6454f7",4478:"ed78b777",4651:"967ec4da",4667:"c24bbf43",4682:"18721add",4772:"ab8f1dec",4918:"15f115ce",4955:"7e795572",4985:"c2841a57",5377:"ffc7db1a",5507:"36c41078",5858:"86987606",5900:"a995c609",6011:"6de743c9",6033:"fcbda936",6103:"ebc8482f",6113:"f155125f",6125:"9555c68b",6177:"e7798f11",6216:"0d890761",6344:"394ac727",6543:"3b507760",6741:"137eb6e8",6759:"c81d0e01",6938:"d44251bf",7100:"dfa7c53a",7178:"9a58922d",7414:"8d31e6a7",7475:"0b8bf361",7596:"95bca972",7664:"7fd4bae6",7894:"2a49d56a",7917:"1a71e32c",7971:"b58420e2",8055:"27482879",8087:"fd9041fd",8106:"d9040225",8140:"901b2f91",8141:"6478079e",8163:"6e9541b8",8468:"a1f30bed",8474:"f58804a4",8475:"d27b3009",8489:"3033ed56",8518:"aaa08e5a",8531:"1f1a82a7",8610:"d85035d6",8636:"c590d949",8766:"583ba3e8",8781:"3238e555",8866:"381cdff2",8878:"50c3bf68",8888:"f7352a9d",8892:"7315f43d",9003:"1e8e0783",9010:"f4802a87",9035:"37598b09",9588:"fd615a94",9642:"223fec4f",9661:"33228fcd",9671:"8f2ee486",9697:"f9ece43f",9700:"ad032cc8",9817:"424c677a",9914:"83d53850"}[e]+".js",t.miniCssF=e=>{},t.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),t.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},b="OpenSign-Docs:",t.l=(e,a,c,d)=>{if(r[e])r[e].push(a);else{var f,o;if(void 0!==c)for(var l=document.getElementsByTagName("script"),n=0;n{f.onerror=f.onload=null,clearTimeout(s);var b=r[e];if(delete r[e],f.parentNode&&f.parentNode.removeChild(f),b&&b.forEach((e=>e(c))),a)return a(c)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=u.bind(null,f.onerror),f.onload=u.bind(null,f.onload),o&&document.head.appendChild(f)}},t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},t.nmd=e=>(e.paths=[],e.children||(e.children=[]),e),t.p="/",t.gca=function(e){return e={59362658:"2267",66406991:"110","935f2afb":"53",d91ad230:"230",reactPlayerKaltura:"261",fa40969b:"273",e2c87691:"420","30a24c52":"453",b2b675dd:"533",d8b805fb:"762",c7b98810:"823",c5e4dae0:"841","277a78f5":"853","8717b14a":"948",f0ff4a36:"1332",f864295c:"1344",b2f554cd:"1477",e9e778b7:"1512","770b40a9":"1520",bbdfc22d:"1531","031793e1":"1633",a7023ddc:"1713",ef5d5d5d:"1773","4c5e977b":"1893",d9f32620:"1914",bfe4b778:"2087",reactPlayerFacebook:"2121","2ace9d1d":"2241",a2bc1463:"2245",e273c56f:"2362","38c56221":"2403","814f3328":"2535",reactPlayerStreamable:"2546","1f73ca32":"2832","3e02da86":"2865","1f391b9e":"3085",a6aa9e1f:"3089","64ee8796":"3101","1a2f05d3":"3137","11b7b3d8":"3156",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",reactPlayerVimeo:"3743","01a85c17":"4013",c4f5d8e4:"4195","14716de7":"4277",a94703ab:"4368",reactPlayerYouTube:"4439",d1393a72:"4478","05632a52":"4651",reactPlayerMixcloud:"4667",b0378e01:"4772","1f7895dc":"4918",e226bb09:"4955",b839bf37:"4985",ce589067:"5377","8320e026":"5507","046910c8":"5858","38e3d9c8":"5900",reactPlayerFilePlayer:"6011","28b19cd2":"6033",ccc49370:"6103","13fdae3b":"6113",reactPlayerSoundCloud:"6125","611db08b":"6177",reactPlayerTwitch:"6216","984cf7cf":"6344","17e5210b":"6543",e2a6fad1:"6741",c9fa5aa5:"6759","608ae6a4":"6938","2c416566":"7100","096bfee4":"7178","393be207":"7414","500027af":"7475",reactPlayerDailyMotion:"7596",reactPlayerPreview:"7664",a88a3db3:"7894","0028a090":"7917","8a725248":"7971",reactPlayerWistia:"8055",e4f5c862:"8087","377084eb":"8106","98da7451":"8141","5a2de241":"8163","52d5c0f9":"8468","9640838e":"8474","7b076186":"8489",a7bd4aaa:"8518","6875c492":"8610",f4f34a3a:"8636","70853c19":"8766","489b8a4d":"8781",eb56c656:"8866",cf03142d:"8878",reactPlayerVidyard:"8888","38ec836e":"8892","925b3f96":"9003","06b6ef6a":"9010","4c9e35b1":"9035","5c04ee3b":"9588","7661071f":"9642","5e95c892":"9661","0e384e19":"9671","2c586be5":"9697",e16015ca:"9700","14eb3368":"9817","0c0943c7":"9914"}[e]||e,t.p+t.u(e)},(()=>{var e={1303:0,532:0};t.f.j=(a,c)=>{var r=t.o(e,a)?e[a]:void 0;if(0!==r)if(r)c.push(r[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var b=new Promise(((c,b)=>r=e[a]=[c,b]));c.push(r[2]=b);var d=t.p+t.u(a),f=new Error;t.l(d,(c=>{if(t.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var b=c&&("load"===c.type?"missing":c.type),d=c&&c.target&&c.target.src;f.message="Loading chunk "+a+" failed.\n("+b+": "+d+")",f.name="ChunkLoadError",f.type=b,f.request=d,r[1](f)}}),"chunk-"+a,a)}},t.O.j=a=>0===e[a];var a=(a,c)=>{var r,b,d=c[0],f=c[1],o=c[2],l=0;if(d.some((a=>0!==e[a]))){for(r in f)t.o(f,r)&&(t.m[r]=f[r]);if(o)var n=o(t)}for(a&&a(c);l Archive | OpenSign™ - + diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 8cf11cf90..086415ccb 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 953555b24..708628ea5 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 7b872e101..e4120f81d 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 9ae13ba46..5c29f63b1 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 7a7ac7676..c1c680af1 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 829dc53ea..f38b9df5b 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 eca2fdb81..7eedf9760 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 d75cc59de..e0e4124dc 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 d85434334..2c8d2fff1 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 df13a0e37..287762f60 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 e1a4c8417..a3da89a8b 100644 --- a/docs/API-docs/contactlist/index.html +++ b/docs/API-docs/contactlist/index.html @@ -5,7 +5,7 @@ Get Contact list | OpenSign™ - + @@ -14,6 +14,6 @@

The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook.

Request​

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    contactdetails[]

  • Array [

    • objectId string
    Name string
    Email string
    Phone string
    createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    contactdetails[]

  • Array [

    • objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/createcontact/index.html b/docs/API-docs/createcontact/index.html index 57b84d2f6..1a1db0f83 100644 --- a/docs/API-docs/createcontact/index.html +++ b/docs/API-docs/createcontact/index.html @@ -5,7 +5,7 @@ Create Contact | OpenSign™ - + @@ -14,6 +14,6 @@

The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents.

Request​

Body

required

Provide below parameter to create contact

    name stringrequired
    email stringrequired
    phone stringrequired
-

Responses​

Contact created successfully!

Schema

    objectId string
    Name string
    Email string
    Phone string
    createdAt date
    updatedAt date
Loading...
+

Responses​

Contact created successfully!

Schema

    objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/createdocument/index.html b/docs/API-docs/createdocument/index.html index 77388f46b..050556a29 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/createdocumentwithbinary/index.html b/docs/API-docs/createdocumentwithbinary/index.html index 081bf26f3..8f3b6bf18 100644 --- a/docs/API-docs/createdocumentwithbinary/index.html +++ b/docs/API-docs/createdocumentwithbinary/index.html @@ -5,7 +5,7 @@ Create Document from binary | OpenSign™ - + diff --git a/docs/API-docs/createdocumentwithtemplateid/index.html b/docs/API-docs/createdocumentwithtemplateid/index.html index 2f272f7a8..1831af30b 100644 --- a/docs/API-docs/createdocumentwithtemplateid/index.html +++ b/docs/API-docs/createdocumentwithtemplateid/index.html @@ -5,7 +5,7 @@ Create Document from Template | OpenSign™ - + diff --git a/docs/API-docs/createtemplate/index.html b/docs/API-docs/createtemplate/index.html index 1b7cd7bed..d94a7cb27 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/createtemplatewithbinary/index.html b/docs/API-docs/createtemplatewithbinary/index.html index d21e76258..9907a1571 100644 --- a/docs/API-docs/createtemplatewithbinary/index.html +++ b/docs/API-docs/createtemplatewithbinary/index.html @@ -5,7 +5,7 @@ Create Template from binary | OpenSign™ - + diff --git a/docs/API-docs/delete-template/index.html b/docs/API-docs/delete-template/index.html index 1fc8f9899..4f6c9c5d5 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 fb5f30165..500ac8f86 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 79d3358d5..9c425b0f5 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 a5f4eee11..6bac29bb3 100644 --- a/docs/API-docs/deletedocument/index.html +++ b/docs/API-docs/deletedocument/index.html @@ -5,7 +5,7 @@ Delete Document | OpenSign™ - + diff --git a/docs/API-docs/draftedocument/index.html b/docs/API-docs/draftedocument/index.html index 38a9f9d08..e07686250 100644 --- a/docs/API-docs/draftedocument/index.html +++ b/docs/API-docs/draftedocument/index.html @@ -3,15 +3,20 @@ -Draft Document | OpenSign™ +Draft Document | OpenSign™ - +

Draft Document

POST 
/draftdocument
-

The draft Document API allows you to generate document in which you can add signers and widgets from Ui

+

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(for cloud version). This API is designed to streamline the process of document preparation, allowing for a seamless transition from draft to final document.

+

Features:​

+
    +
  • Save Document Drafts: Securely save your documents in a draft state.
    • +
  • Add Signers: Assign signers to your document directly from the API.
    • +

Request​

Body

required

    file base64
    title string
    description string
    note string

    signers

    object[]

  • Array [

    • email string
    name string
    phone string

  • ]

Responses​

Document created successfully!

Schema

    objectId string
    url string
Loading...
diff --git a/docs/API-docs/drafttemplate/index.html b/docs/API-docs/drafttemplate/index.html index 70a409485..6d81721df 100644 --- a/docs/API-docs/drafttemplate/index.html +++ b/docs/API-docs/drafttemplate/index.html @@ -5,7 +5,7 @@ Draft Template | OpenSign™ - + diff --git a/docs/API-docs/get-template/index.html b/docs/API-docs/get-template/index.html index 056123faa..1ef70f264 100644 --- a/docs/API-docs/get-template/index.html +++ b/docs/API-docs/get-template/index.html @@ -5,7 +5,7 @@ Get Template | OpenSign™ - + @@ -14,6 +14,6 @@

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

Request​

Path Parameters

    template_id strngrequired

    ID of template that needs to be fetched

-

Responses​

successful operation

Schema

    objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

    • Name string

  • ]

    • createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-user/index.html b/docs/API-docs/get-user/index.html index c9f98ed78..e4e749fea 100644 --- a/docs/API-docs/get-user/index.html +++ b/docs/API-docs/get-user/index.html @@ -5,7 +5,7 @@ Get your details | OpenSign™ - + @@ -13,6 +13,6 @@ 
GET 
/getuser

The Get User API enables you to get your own details.

Request​

-

Responses​

Successful operation

Schema

    objectId string
    Name string
    Email string
    Phone string
    JobTitle string
    Company string
    createdAt date
    updatedAt date
Loading...
+

Responses​

Successful operation

Schema

    objectId string
    name string
    email string
    phone string
    jobTitle string
    company string
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/get-webhook/index.html b/docs/API-docs/get-webhook/index.html index 5041d8a67..24092a7d6 100644 --- a/docs/API-docs/get-webhook/index.html +++ b/docs/API-docs/get-webhook/index.html @@ -5,7 +5,7 @@ Get Webhook | OpenSign™ - + @@ -13,6 +13,6 @@ 
GET 
/webhook

The Get Webhook API allow you to get webhook url

Request​

-

Responses​

Successful operation

Schema

    Webhook string
Loading...
+

Responses​

Successful operation

Schema

    webhook string
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getcontact/index.html b/docs/API-docs/getcontact/index.html index 18639392c..8f2d52109 100644 --- a/docs/API-docs/getcontact/index.html +++ b/docs/API-docs/getcontact/index.html @@ -5,7 +5,7 @@ Get Contact | OpenSign™ - + @@ -14,6 +14,6 @@

The Get Contact API allows you to retrieve details about a specific contact.

Request​

Path Parameters

    contact_id stringrequired

    objectId of contact

-

Responses​

successful operation

Schema

    objectId string
    Name string
    Email string
    Phone string
    createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    name string
    email string
    phone string
    createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocument/index.html b/docs/API-docs/getdocument/index.html index 3f9aa6ab1..78d4d8b80 100644 --- a/docs/API-docs/getdocument/index.html +++ b/docs/API-docs/getdocument/index.html @@ -5,7 +5,7 @@ Get Document | OpenSign™ - + @@ -14,6 +14,6 @@

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

Request​

Path Parameters

    document_id stringrequired

    objectId of Document

-

Responses​

successful operation

Schema

    objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

    • Name string

  • ]

    • createdAt date
    updatedAt date
Loading...
+

Responses​

successful operation

Schema

    objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date
Loading...
\ No newline at end of file diff --git a/docs/API-docs/getdocumentlist/index.html b/docs/API-docs/getdocumentlist/index.html index a5c364097..7fc5f0609 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™ - + @@ -54,6 +54,6 @@

Request​

Path Parameters

    doctype stringrequired

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

    The type of documents to retrieve

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    document[]

  • Array [

    • objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

    • Name string

  • ]

    • createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    document[]

  • Array [

    • objectId string
    file string
    title string
    note string

    folder

    object

    objectId string
    name string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date

  • ]

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

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

Request​

Query Parameters

    limit number

    Possible values: <= 500

    Example: 10
    skip number
    Example: 0
-

Responses​

successful operation

Schema

    result

    template[]

  • Array [

    • objectId string
    Title string
    Note string
    Folder string
    File string
    Owner string

    Signers

    object[]

  • Array [

    • Name string

  • ]

    • createdAt date
    updatedAt date

  • ]

Loading...
+

Responses​

successful operation

Schema

    result

    template[]

  • Array [

    • objectId string
    title string
    note string

    folder

    object

    objectId string
    name string
    file string
    owner string

    signers

    object[]

  • Array [

    • name string
    email string
    phone string

  • ]

    • createdAt date
    updatedAt date

  • ]

Loading...
\ No newline at end of file diff --git a/docs/API-docs/intro/index.html b/docs/API-docs/intro/index.html index d20fda558..ce7f7ac04 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 f7547cc81..5ed26a7b9 100644 --- a/docs/API-docs/opensign-api-v-1/index.html +++ b/docs/API-docs/opensign-api-v-1/index.html @@ -5,7 +5,7 @@ OpenSign API v1 | OpenSign™ - + diff --git a/docs/API-docs/save-update-webhook/index.html b/docs/API-docs/save-update-webhook/index.html index 1a283a9cd..b5c08d24e 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 46814c194..2efdba773 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 5c513c7ea..42dcb15d0 100644 --- a/docs/API-docs/update-template/index.html +++ b/docs/API-docs/update-template/index.html @@ -5,7 +5,7 @@ Update Template | OpenSign™ - + diff --git a/docs/category/create-new-opensign-document/index.html b/docs/category/create-new-opensign-document/index.html index a104c931f..07ecdf947 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 33315f288..6d8966f07 100644 --- a/docs/category/docker/index.html +++ b/docs/category/docker/index.html @@ -5,7 +5,7 @@ Docker | OpenSign™ - + diff --git a/docs/category/manage-docs-using-opensign-drive/index.html b/docs/category/manage-docs-using-opensign-drive/index.html index 127e5a5d1..9987418e1 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 0f15536ec..860c5c815 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 880971eb3..771962eb2 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 9698e80cf..90049d90e 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 306e0b010..2b0b3d5f2 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 a112c1173..e949f6304 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 54b5ca9c0..58b8a6beb 100644 --- a/docs/contribute/INSTALLATION/index.html +++ b/docs/contribute/INSTALLATION/index.html @@ -5,7 +5,7 @@ INSTALLATON INSTRUCTIONS | OpenSign™ - + diff --git a/docs/contribute/REPORTING_GUIDELINES/index.html b/docs/contribute/REPORTING_GUIDELINES/index.html index 4dcb6be38..9c493183a 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 7013c2b9f..8f34056a9 100644 --- a/docs/contribute/intro/index.html +++ b/docs/contribute/intro/index.html @@ -5,7 +5,7 @@ Contributing to OpenSign | OpenSign™ - + diff --git a/docs/help/New-Document/request-signatures/index.html b/docs/help/New-Document/request-signatures/index.html index 91520f25c..0b29a2fa3 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 9b2cba540..979febc62 100644 --- a/docs/help/New-Document/sign-yourself/index.html +++ b/docs/help/New-Document/sign-yourself/index.html @@ -5,7 +5,7 @@ Sign yourself | OpenSign™ - + diff --git a/docs/help/OpenSign™ Drive/create-document/index.html b/docs/help/OpenSign™ Drive/create-document/index.html index d1e87e5d9..166f7ea2d 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 234a39025..e769c7397 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 d31f2422d..b3de56f10 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 f3ef3ebad..508f3b8d4 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 2bc2f228f..b9712a2b4 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 f82a047f2..ad5c0adc9 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 97862a1b4..5da13e921 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 8592009eb..85d2230ea 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 5d4783718..e012e3772 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 3bee5be1d..5ef9f1727 100644 --- a/docs/help/Reports/need-your-sign/index.html +++ b/docs/help/Reports/need-your-sign/index.html @@ -5,7 +5,7 @@ Need your sign | OpenSign™ - + diff --git a/docs/help/Settings/manage-users/index.html b/docs/help/Settings/manage-users/index.html index 9a6b09c82..e42fa28d5 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 3fdd86ad0..230d78f43 100644 --- a/docs/help/Settings/my-signature/index.html +++ b/docs/help/Settings/my-signature/index.html @@ -5,7 +5,7 @@ My Signature | OpenSign™ - + diff --git a/docs/help/Settings/profile/index.html b/docs/help/Settings/profile/index.html index 31ac28225..14ba0f27d 100644 --- a/docs/help/Settings/profile/index.html +++ b/docs/help/Settings/profile/index.html @@ -5,7 +5,7 @@ Profile | OpenSign™ - + diff --git a/docs/help/Templates/create-template/index.html b/docs/help/Templates/create-template/index.html index a29457500..edd6c6c16 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 18f12d57f..e85f3f329 100644 --- a/docs/help/Templates/quick-send/index.html +++ b/docs/help/Templates/quick-send/index.html @@ -5,7 +5,7 @@ Quickly Send template to a signer | OpenSign™ - + diff --git a/docs/help/Templates/use-template/index.html b/docs/help/Templates/use-template/index.html index 0f05a245a..003075c55 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 5e4919f54..46a74b2ce 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 f6b702b90..ffe733548 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 b8ca87221..00d905fda 100644 --- a/docs/self-host/One-click-Install/DigitalOcean/index.html +++ b/docs/self-host/One-click-Install/DigitalOcean/index.html @@ -5,7 +5,7 @@ Digital Ocean | OpenSign™ - + diff --git a/docs/self-host/docker/run-locally/index.html b/docs/self-host/docker/run-locally/index.html index ec1279de3..0b31fbd8f 100644 --- a/docs/self-host/docker/run-locally/index.html +++ b/docs/self-host/docker/run-locally/index.html @@ -5,7 +5,7 @@ Localhost Setup with Docker | OpenSign™ - + diff --git a/docs/self-host/intro/index.html b/docs/self-host/intro/index.html index 2c871d2f0..74eb25581 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 aaa53d019..a3fcc0299 100644 --- a/index.html +++ b/index.html @@ -5,7 +5,7 @@ Hello from OpenSign™ | OpenSign™ - + diff --git a/markdown-page/index.html b/markdown-page/index.html index 0a8641ac4..87d09dc71 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,7 +5,7 @@ Markdown page example | OpenSign™ - +