OpenSign/assets/js/38e3d9c8.69204c41.js

(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[5378],{4213:function(e,t,n){var r,s,o,a=n(96763);s=[],void 0===(o="function"==typeof(r=function(){"use strict";function t(e,t){return void 0===t?t={autoBom:!1}:"object"!=typeof t&&(a.warn("Deprecated: Expected third argument to be a object"),t={autoBom:!t}),t.autoBom&&/^\s*(?:text\/\S*|application\/xml|\S*\/\S*\+xml)\s*;.*charset\s*=\s*utf-8/i.test(e.type)?new Blob(["\ufeff",e],{type:e.type}):e}function r(e,t,n){var r=new XMLHttpRequest;r.open("GET",e),r.responseType="blob",r.onload=function(){l(r.response,t,n)},r.onerror=function(){a.error("could not download file")},r.send()}function s(e){var t=new XMLHttpRequest;t.open("HEAD",e,!1);try{t.send()}catch(e){}return 200<=t.status&&299>=t.status}function o(e){try{e.dispatchEvent(new MouseEvent("click"))}catch(r){var t=document.createEvent("MouseEvents");t.initMouseEvent("click",!0,!0,window,0,0,0,80,20,!1,!1,!1,!1,0,null),e.dispatchEvent(t)}}var i="object"==typeof window&&window.window===window?window:"object"==typeof self&&self.self===self?self:"object"==typeof n.g&&n.g.global===n.g?n.g:void 0,c=i.navigator&&/Macintosh/.test(navigator.userAgent)&&/AppleWebKit/.test(navigator.userAgent)&&!/Safari/.test(navigator.userAgent),l=i.saveAs||("object"!=typeof window||window!==i?function(){}:"download"in HTMLAnchorElement.prototype&&!c?function(e,t,n){var a=i.URL||i.webkitURL,c=document.createElement("a");t=t||e.name||"download",c.download=t,c.rel="noopener","string"==typeof e?(c.href=e,c.origin===location.origin?o(c):s(c.href)?r(e,t,n):o(c,c.target="_blank")):(c.href=a.createObjectURL(e),setTimeout((function(){a.revokeObjectURL(c.href)}),4e4),setTimeout((function(){o(c)}),0))}:"msSaveOrOpenBlob"in navigator?function(e,n,a){if(n=n||e.name||"download","string"!=typeof e)navigator.msSaveOrOpenBlob(t(e,a),n);else if(s(e))r(e,n,a);else{var i=document.createElement("a");i.href=e,i.target="_blank",setTimeout((function(){o(i)}))}}:function(e,t,n,s){if((s=s||open("","_blank"))&&(s.document.title=s.document.body.innerText="downloading..."),"string"==typeof e)return r(e,t,n);var o="application/octet-stream"===e.type,a=/constructor/i.test(i.HTMLElement)||i.safari,l=/CriOS\/[\d]+/.test(navigator.userAgent);if((l||o&&a||c)&&"undefined"!=typeof FileReader){var u=new FileReader;u.onloadend=function(){var e=u.result;e=l?e:e.replace(/^data:[^;]*;/,"data:attachment/file;"),s?s.location.href=e:location=e,s=null},u.readAsDataURL(e)}else{var d=i.URL||i.webkitURL,p=d.createObjectURL(e);s?s.location=p:location.href=p,s=null,setTimeout((function(){d.revokeObjectURL(p)}),4e4)}});i.saveAs=l.saveAs=l,e.exports=l})?r.apply(t,s):r)||(e.exports=o)},18426:(e,t)=>{function n(e){let t,n=[];for(let r of e.split(",").map((e=>e.trim())))if(/^-?\d+$/.test(r))n.push(parseInt(r,10));else if(t=r.match(/^(-?\d+)(-|\.\.\.?|\u2025|\u2026|\u22EF)(-?\d+)$/)){let[e,r,s,o]=t;if(r&&o){r=parseInt(r),o=parseInt(o);const e=r<o?1:-1;"-"!==s&&".."!==s&&"\u2025"!==s||(o+=e);for(let t=r;t!==o;t+=e)n.push(t)}}return n}t.default=n,e.exports=n},25383:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});const s=r(n(96540)),o=r(n(4213));t.default=function(e){let{url:t,proxy:n}=e;return s.default.createElement("div",{style:{float:"right"},className:"dropdown dropdown--hoverable dropdown--right"},s.default.createElement("button",{className:"export-button button button--sm button--secondary"},"Export"),s.default.createElement("ul",{className:"export-dropdown dropdown__menu"},s.default.createElement("li",null,s.default.createElement("a",{onClick:e=>{e.preventDefault(),(e=>{let t;(e.endsWith("json")||e.endsWith("yaml")||e.endsWith("yml"))&&(t=e.substring(e.lastIndexOf("/")+1)),o.default.saveAs(e,t||"openapi.txt")})(`${t}`)},className:"dropdown__link",href:`${t}`},"OpenAPI Spec"))))}},28453:(e,t,n)=>{"use strict";n.d(t,{R:()=>a,x:()=>i});var r=n(96540);const s={},o=r.createContext(s);function a(e){const t=r.useContext(o);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),r.createElement(o.Provider,{value:t},e.children)}},31177:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var r=n(8532),s=n(53115);function o(){const{prism:e}=(0,s.p)(),{colorMode:t}=(0,r.G)(),n=e.theme,o=e.darkTheme||n;return"dark"===t?o:n}},32098:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>d,default:()=>h,frontMatter:()=>u,metadata:()=>r,toc:()=>m});const r=JSON.parse('{"id":"API-docs/opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","source":"@site/docs/API-docs/opensign-api-v-1.info.mdx","sourceDirName":"API-docs","slug":"/API-docs/opensign-api-v-1","permalink":"/docs/API-docs/opensign-api-v-1","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","sidebarPosition":0,"frontMatter":{"id":"opensign-api-v-1","title":"OpenSign API v1","description":"Welcome to the OpenSign\u2122 API documentation!","sidebar_label":"Introduction","sidebar_position":0,"hide_title":true,"custom_edit_url":null},"sidebar":"apiSidebar","next":{"title":"Get your account details","permalink":"/docs/API-docs/get-user"}}');var s=n(74848),o=n(28453),a=(n(64624),n(9303)),i=n(12990),c=n.n(i),l=n(79329);n(25383);const u={id:"opensign-api-v-1",title:"OpenSign API v1",description:"Welcome to the OpenSign\u2122 API documentation!",sidebar_label:"Introduction",sidebar_position:0,hide_title:!0,custom_edit_url:null},d=void 0,p={},m=[];function f(e){const t={a:"a",li:"li",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("span",{className:"theme-doc-version-badge badge badge--secondary",children:"Version: 1.0.0"}),"\n",(0,s.jsx)(a.default,{as:"h1",className:"openapi__heading",children:"OpenSign API v1"}),"\n",(0,s.jsx)(t.p,{children:"Welcome to the OpenSign\u2122 API documentation!"}),"\n",(0,s.jsx)(t.p,{children:"Our powerful and flexible API empowers you to seamlessly integrate digital signing capabilities into your applications. Whether you're a developer automating document workflows, a business enhancing security, or an enterprise streamlining contract management, OpenSign\u2122 delivers robust solutions tailored to your needs."}),"\n",(0,s.jsx)(t.p,{children:"Explore our comprehensive guides, code samples, and best practices to unlock the full potential of OpenSign\u2122 and transform your digital document processes."}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.strong,{children:"Useful Links:"})}),"\n",(0,s.jsxs)(t.ul,{children:["\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.a,{href:"https://www.opensignlabs.com",children:"OpenSign Website"})}),"\n",(0,s.jsx)(t.li,{children:(0,s.jsx)(t.a,{href:"https://github.com/opensignlabs/opensign",children:"OpenSign GitHub Repository"})}),"\n",(0,s.jsxs)(t.li,{children:[(0,s.jsx)(t.a,{href:"https://docs.opensignlabs.com/docs/help/Settings/APIToken",children:"Generate x-api-token"})," \u2013 Learn how to securely generate and manage your API token for authenticating requests."]}),"\n"]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"2rem"},children:[(0,s.jsx)(a.default,{id:"authentication",as:"h2",className:"openapi-tabs__heading",children:"Authentication"}),(0,s.jsx)(c(),{className:"openapi-tabs__security-schemes",children:(0,s.jsx)(l.default,{label:"API Key: x-api-token",value:"x-api-token",children:(0,s.jsx)("div",{children:(0,s.jsx)("table",{children:(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(t.p,{children:"Security Scheme Type:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(t.p,{children:"apiKey"})})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("th",{children:(0,s.jsx)(t.p,{children:"Header parameter name:"})}),(0,s.jsx)("td",{children:(0,s.jsx)(t.p,{children:"x-api-token"})})]})]})})})})})]}),"\n",(0,s.jsxs)("div",{style:{display:"flex",flexDirection:"column",marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(t.p,{children:"Contact"})}),(0,s.jsx)("span",{children:(0,s.jsx)(t.p,{children:(0,s.jsx)(t.a,{href:"mailto:api@opensignlabs.com",children:"api@opensignlabs.com"})})})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(t.p,{children:"Terms of Service"})}),(0,s.jsx)("a",{href:"http://www.opensignlabs.com/terms/",children:"http://www.opensignlabs.com/terms/"})]}),"\n",(0,s.jsxs)("div",{style:{marginBottom:"var(--ifm-paragraph-margin-bottom)"},children:[(0,s.jsx)("h3",{style:{marginBottom:"0.25rem"},children:(0,s.jsx)(t.p,{children:"License"})}),(0,s.jsx)("a",{href:"http://github.com/opensignlabs/opensign/LICENSE",children:(0,s.jsx)(t.p,{children:"AGPL v 3.0"})})]})]})}function h(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},60506:(e,t,n)=>{"use strict";n.d(t,{c:()=>o});var r=n(96540),s=n(74848);function o(e){const{mdxAdmonitionTitle:t,rest:n}=function(e){const t=r.Children.toArray(e),n=t.find((e=>r.isValidElement(e)&&"mdxAdmonitionTitle"===e.type)),o=t.filter((e=>e!==n)),a=n?.props.children;return{mdxAdmonitionTitle:a,rest:o.length>0?(0,s.jsx)(s.Fragment,{children:o}):null}}(e.children),o=e.title??t;return{...e,...o&&{title:o},children:n}}},61360:(e,t,n)=>{"use strict";n.d(t,{f:()=>i});var r=n(96540),s=n(26849);const o={attributes:!0,characterData:!0,childList:!0,subtree:!0};function a(e,t){const[n,a]=(0,r.useState)(),i=(0,r.useCallback)((()=>{a(e.current?.closest("[role=tabpanel][hidden]"))}),[e,a]);(0,r.useEffect)((()=>{i()}),[i]),function(e,t,n){void 0===n&&(n=o);const a=(0,s._q)(t),i=(0,s.Be)(n);(0,r.useEffect)((()=>{const t=new MutationObserver(a);return e&&t.observe(e,i),()=>t.disconnect()}),[e,a,i])}(n,(e=>{e.forEach((e=>{"attributes"===e.type&&"hidden"===e.attributeName&&(t(),i())}))}),{attributes:!0,characterData:!1,childList:!1,subtree:!1})}function i(){const[e,t]=(0,r.useState)(!1),[n,s]=(0,r.useState)(!1),o=(0,r.useRef)(null),i=(0,r.useCallback)((()=>{const n=o.current.querySelector("code");e?n.removeAttribute("style"):(n.style.whiteSpace="pre-wrap",n.style.overflowWrap="anywhere"),t((e=>!e))}),[o,e]),c=(0,r.useCallback)((()=>{const{scrollWidth:e,clientWidth:t}=o.current,n=e>t||o.current.querySelector("code").hasAttribute("style");s(n)}),[o]);return a(o,c),(0,r.useEffect)((()=>{c()}),[e,c]),(0,r.useEffect)((()=>(window.addEventListener("resize",c,{passive:!0}),()=>{window.removeEventListener("resize",c)})),[c]),{codeBlockRef:o,isEnabled:e,isCodeScrollable:n,toggle:i}}},64566:(e,t,n)=>{"use strict";n.d(t,{Li:()=>f,M$:()=>h,Op:()=>m,_u:()=>p,wt:()=>d});var r=n(18426),s=n.n(r);const o=/title=(?<quote>["'])(?<title>.*?)\1/,a=/\{(?<range>[\d,-]+)\}/,i={js:{start:"\\/\\/",end:""},jsBlock:{start:"\\/\\*",end:"\\*\\/"},jsx:{start:"\\{\\s*\\/\\*",end:"\\*\\/\\s*\\}"},bash:{start:"#",end:""},html:{start:"\x3c!--",end:"--\x3e"}},c={...i,lua:{start:"--",end:""},wasm:{start:"\\;\\;",end:""},tex:{start:"%",end:""},vb:{start:"['\u2018\u2019]",end:""},vbnet:{start:"(?:_\\s*)?['\u2018\u2019]",end:""},rem:{start:"[Rr][Ee][Mm]\\b",end:""},f90:{start:"!",end:""},ml:{start:"\\(\\*",end:"\\*\\)"},cobol:{start:"\\*>",end:""}},l=Object.keys(i);function u(e,t){const n=e.map((e=>{const{start:n,end:r}=c[e];return`(?:${n}\\s*(${t.flatMap((e=>[e.line,e.block?.start,e.block?.end].filter(Boolean))).join("|")})\\s*${r})`})).join("|");return new RegExp(`^\\s*(?:${n})\\s*$`)}function d(e){return e?.match(o)?.groups.title??""}function p(e){return Boolean(e?.includes("showLineNumbers"))}function m(e){const t=e.split(" ").find((e=>e.startsWith("language-")));return t?.replace(/language-/,"")}function f(e,t){let n=e.replace(/\n$/,"");const{language:r,magicComments:o,metastring:i}=t;if(i&&a.test(i)){const e=i.match(a).groups.range;if(0===o.length)throw new Error(`A highlight range has been given in code block's metastring (\`\`\` ${i}), but no magic comment config is available. Docusaurus applies the first magic comment entry's className for metastring ranges.`);const t=o[0].className,r=s()(e).filter((e=>e>0)).map((e=>[e-1,[t]]));return{lineClassNames:Object.fromEntries(r),code:n}}if(void 0===r)return{lineClassNames:{},code:n};const c=function(e,t){switch(e){case"js":case"javascript":case"ts":case"typescript":return u(["js","jsBlock"],t);case"jsx":case"tsx":return u(["js","jsBlock","jsx"],t);case"html":return u(["js","jsBlock","html"],t);case"python":case"py":case"bash":return u(["bash"],t);case"markdown":case"md":return u(["html","jsx","bash"],t);case"tex":case"latex":case"matlab":return u(["tex"],t);case"lua":case"haskell":return u(["lua"],t);case"sql":return u(["lua","jsBlock"],t);case"wasm":return u(["wasm"],t);case"vb":case"vba":case"visual-basic":return u(["vb","rem"],t);case"vbnet":return u(["vbnet","rem"],t);case"batch":return u(["rem"],t);case"basic":return u(["rem","f90"],t);case"fsharp":return u(["js","ml"],t);case"ocaml":case"sml":return u(["ml"],t);case"fortran":return u(["f90"],t);case"cobol":return u(["cobol"],t);default:return u(l,t)}}(r,o),d=n.split("\n"),p=Object.fromEntries(o.map((e=>[e.className,{start:0,range:""}]))),m=Object.fromEntries(o.filter((e=>e.line)).map((e=>{let{className:t,line:n}=e;return[n,t]}))),f=Object.fromEntries(o.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.start,t]}))),h=Object.fromEntries(o.filter((e=>e.block)).map((e=>{let{className:t,block:n}=e;return[n.end,t]})));for(let s=0;s<d.length;){const e=d[s].match(c);if(!e){s+=1;continue}const t=e.slice(1).find((e=>void 0!==e));m[t]?p[m[t]].range+=`${s},`:f[t]?p[f[t]].start=s:h[t]&&(p[h[t]].range+=`${p[h[t]].start}-${s-1},`),d.splice(s,1)}n=d.join("\n");const g={};return Object.entries(p).forEach((e=>{let[t,{range:n}]=e;s()(n).forEach((e=>{g[e]??=[],g[e].push(t)}))})),{lineClassNames:g,code:n}}function h(e){const t={color:"--prism-color",backgroundColor:"--prism-background-color"},n={};return Object.entries(e.plain).forEach((e=>{let[r,s]=e;const o=t[r];o&&"string"==typeof s&&(n[o]=s)})),n}},64624:function(e,t,n){"use strict";var r=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e){const{colorMode:t}=(0,o.useColorMode)(),{logo:n,darkLogo:r}=e,c=()=>"dark"===t?r?.altText??n?.altText:n?.altText,l=(0,a.default)(n?.url),u=(0,a.default)(r?.url);if(n&&r)return s.default.createElement(i.default,{alt:c(),sources:{light:l,dark:u},className:"openapi__logo"});if(n||r)return s.default.createElement(i.default,{alt:c(),sources:{light:l??u,dark:l??u},className:"openapi__logo"});return};const s=r(n(96540)),o=n(3489),a=r(n(29030)),i=r(n(24475))},98569:(e,t,n)=>{"use strict";n.d(t,{i:()=>s});var r=n(40797);function s(e){void 0===e&&(e={});const{i18n:{currentLocale:t}}=(0,r.default)(),n=function(){const{i18n:{currentLocale:e,localeConfigs:t}}=(0,r.default)();return t[e].calendar}();return new Intl.DateTimeFormat(t,{calendar:n,...e})}}}]);