WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-10 03:37:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
a251e9a93c46aa3dd8ea81c5c64de121f6a25d49
OpenSign/assets/js/fa40969b.e283f01a.js
T

1 line
20 KiB
JavaScript
Raw Blame History

"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:()=>y});var i=a(85893),n=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),o=a(5397),d=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:"eJztWN1uGzcWfpVT5qJNMJJGtpy0QrGo0WQNt8UmiF0E2FgQODNHGsYckiU5+oExd/skfbQ+yeJwZqSRJTtWW+SqN7aGPP/8zg95xzyfOzb+yF7rtCxQeccmEcvQpVYYL7RiY/bs2TNot+F6bdCNb9R79FbgAoGDFM6DnkHWioCEO8xAK/BrgzfqRg378OLFa8tnfiPJjV+8uFEAAL3tGvice+AWIS2tReXlGoSCLHA6z33p+iTvhORdqt47q+cWnftTUk3DHCSeksQfdWEkesyeIi/nC4QEUYEr0xSdm5VSriHdyFgKnwOXEiz+VgqLGTgxV9yXFmudI9L5ZmXC3lM1YkPPVRZcUhqkVnO0wIMVIpEYpJ+FmGMqhTrWoazlStbgc4TSoe3fKBYxbdBywsVlxsZsjr49dAIBi5jhlhfo0RKo7pjiBbIxy3RKSGAREwQow33O7qPsOscAl10keQ22QRqLWBtINva2xIg5v5Yk3wmKOYsYrozUGbLxjEtHBGmOBWfjOxb0j5nzVqg5UaqyINwHaAXDWjiwiG3OsBYZVJK9dVTYpKqijW9SFMK3nv1Wol3vGNoa0lg607bo2tn4sTGz4CtRkGVncRy1RquySNCyivh48HQ8jDsmuFth/jYLHtYZVxOS64xWDh3RnsQx/ds9yG02wAYtIabKo/JEz42RIg0bg0+OmO72DdDJJ0wDpCyJ8aJWadGV0nfouLWcHBYeC/d5/nqZ0LuPCQoN9zsoaX1n/74QtyenSf7rTxSTmaDF4yTk3hs3HgyaldLKfqoLkuaFP16cCz8oVUiE0v5oCUYidxiK0ibjgnNaZmi/VChrDB8nobYQAmu1DSBrvZg2LlQR00u148uT5H/SoRASP0UnVLM/CzirD5/tVluK+rFAHDQLCy7kZ6kTxB+ahRZrJtfqM2pGZy9PhqffvhoS/VJkc/R/wf96d1/fbtE4l1IvMYMFlyU66G1bZUR9vzD9z6VDS09Gr/YLWYd7s7LhPhmNqoitj+R6NaT4HMl0+m0VsfxIptFLOjk+xyP5ht3k8FgYyT1Or2pIT9ujrR6jCvnlUGWX6q3dLQuJ1hK56iqkZlJFLLXIPWbn/nGgncQnp71h3ItfXQ9fjkffjc9e9uM4/i+L2KoI6G7nB+6RdfO8+S5N9kX0oOKJxGtdPs19i5mwmPppaQ/m6GM4JnWckmFa6EzMmjbpHtcbWjwd1D13OkX9foncPXWhaLKZts19ehLH0xGRVBEbxaP9Jv8ejbYelPbAF1xIis9Xf1+XR2v1waq9DdRhCx5zahSPpmcbp872nbpUCy5FBufvLuFa36L6sh511fta/f6Zipoo7LMdZ7vrtZMO09IKvw6j+KrHjejV++OPE5rlCvS5bub4MLv7nI3ZoDvSD+6a2b1iJM8u2sk+QHsz0ziuskSv+tqgokoseeKo4wy4EYMFNZL7HNyYI6id53Oh5r1HuSZbj6/oVOrA7/i9bWJG/IzUxZqwdqmaSTpHHmaIir5nOjA3wX5rUFF9DEe1GO51sw8oU10g3V7o+tSS//G/3wNHG+CApK/gbWnB6CVaGpnpWjeTuKJrXCAOxcDBWpckziEvJDoXbrAe55Z7hEzMhecy9Eyh5pBywxMhBWGPyDRxW+jA1/XhQ44+R0tbX1u6xme4QEmQBan1LcnxGnjpdRF0tA8AS21vZ2RSBByS0glF92+H2LKgyrlKEdqziEBb4ApQebTGCofARUHEM20BZzORChJMiWZ56qHgis+RlEVAdlMUjNULkaEDq5PSeXBalsER0lgg+tpFhZi5PrwWC6wdp8UMPRcSM5iXJCKCVGd0jw55R26oDBJ0HgypFykGoc5z60HiAm3AXjhJuuKD0VQQBJd0Ve2eLQnylitHBb42qD2aTfiM1XQ7Cjoyvu4DXdWvCCylQwKAFOqWHlh68HEDsw+YOOFx8k2bD8vlci8Pnu/yXAiflwlYNHrLNw+LIWu67JuP5yxiHm3h3s6u0C5E2l5cHtA5CMSDpkzyNJTJZjalHPvhPgOVLClSVA47Re384t0vsIDTfsyiTuY/weDBL5c/vvnP1RuSS7Wpzr9hP+7HYdrVzhdcdVRd4PYJqn65mlldNG9L9xP5blv9/3kF++cVbPMK1jQRjys/MJKL0ImbYa/uoh/ZvYexcfsGNolYrp0nkrs7gsivVlYVLddPN9RcM+FonNk+3tziuvPUFC5J9az4IG3zJrQlndCHFUR7WMeDyP/mfXNyz+Epj3QHg9O2XbXuGtUa28ammtDlqO67ZGO9e56maLp+781hO8PMxZtrFjFe+ny339+Gft/8IOkHbdodBGoD6C+F+iDD99Sefsb1vzbk9c6DDI1/LTXFZ1JV1f8BGbwW1w==",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:"eJztWN1uGzcWfpVT5qJNMJJGtpy0QrGo0WQNt8UmiF0E2FgQODNHGsYckiU5+oExd/skfbQ+yeJwZqSRJTtWW+SqN7aGPP/8zg95xzyfOzb+yF7rtCxQeccmEcvQpVYYL7RiY/bs2TNot+F6bdCNb9R79FbgAoGDFM6DnkHWioCEO8xAK/BrgzfqRg378OLFa8tnfiPJjV+8uFEAAL3tGvice+AWIS2tReXlGoSCLHA6z33p+iTvhORdqt47q+cWnftTUk3DHCSeksQfdWEkesyeIi/nC4QEUYEr0xSdm5VSriHdyFgKnwOXEiz+VgqLGTgxV9yXFmudI9L5ZmXC3lM1YkPPVRZcUhqkVnO0wIMVIpEYpJ+FmGMqhTrWoazlStbgc4TSoe3fKBYxbdBywsVlxsZsjr49dAIBi5jhlhfo0RKo7pjiBbIxy3RKSGAREwQow33O7qPsOscAl10keQ22QRqLWBtINva2xIg5v5Yk3wmKOYsYrozUGbLxjEtHBGmOBWfjOxb0j5nzVqg5UaqyINwHaAXDWjiwiG3OsBYZVJK9dVTYpKqijW9SFMK3nv1Wol3vGNoa0lg607bo2tn4sTGz4CtRkGVncRy1RquySNCyivh48HQ8jDsmuFth/jYLHtYZVxOS64xWDh3RnsQx/ds9yG02wAYtIabKo/JEz42RIg0bg0+OmO72DdDJJ0wDpCyJ8aJWadGV0nfouLWcHBYeC/d5/nqZ0LuPCQoN9zsoaX1n/74QtyenSf7rTxSTmaDF4yTk3hs3HgyaldLKfqoLkuaFP16cCz8oVUiE0v5oCUYidxiK0ibjgnNaZmi/VChrDB8nobYQAmu1DSBrvZg2LlQR00u148uT5H/SoRASP0UnVLM/CzirD5/tVluK+rFAHDQLCy7kZ6kTxB+ahRZrJtfqM2pGZy9PhqffvhoS/VJkc/R/wf96d1/fbtE4l1IvMYMFlyU66G1bZUR9vzD9z6VDS09Gr/YLWYd7s7LhPhmNqoitj+R6NaT4HMl0+m0VsfxIptFLOjk+xyP5ht3k8FgYyT1Or2pIT9ujrR6jCvnlUGWX6q3dLQuJ1hK56iqkZlJFLLXIPWbn/nGgncQnp71h3ItfXQ9fjkffjc9e9uM4/i+L2KoI6G7nB+6RdfO8+S5N9kX0oOKJxGtdPs19i5mwmPppaQ/m6GM4JnWckmFa6EzMmjbpHtcbWjwd1D13OkX9foncPXWhaLKZts19ehLH0xGRVBEbxaP9Jv8ejbYelPbAF1xIis9Xf1+XR2v1waq9DdRhCx5zahSPpmcbp872nbpUCy5FBufvLuFa36L6sh511fta/f6Zipoo7LMdZ7vrtZMO09IKvw6j+KrHjejV++OPE5rlCvS5bub4MLv7nI3ZoDvSD+6a2b1iJM8u2sk+QHsz0ziuskSv+tqgokoseeKo4wy4EYMFNZL7HNyYI6id53Oh5r1HuSZbj6/oVOrA7/i9bWJG/IzUxZqwdqmaSTpHHmaIir5nOjA3wX5rUFF9DEe1GO51sw8oU10g3V7o+tSS//G/3wNHG+CApK/gbWnB6CVaGpnpWjeTuKJrXCAOxcDBWpckziEvJDoXbrAe55Z7hEzMhecy9Eyh5pBywxMhBWGPyDRxW+jA1/XhQ44+R0tbX1u6xme4QEmQBan1LcnxGnjpdRF0tA8AS21vZ2RSBByS0glF92+H2LKgyrlKEdqziEBb4ApQebTGCofARUHEM20BZzORChJMiWZ56qHgis+RlEVAdlMUjNULkaEDq5PSeXBalsER0lgg+tpFhZi5PrwWC6wdp8UMPRcSM5iXJCKCVGd0jw55R26oDBJ0HgypFykGoc5z60HiAm3AXjhJuuKD0VQQBJd0Ve2eLQnylitHBb42qD2aTfiM1XQ7Cjoyvu4DXdWvCCylQwKAFOqWHlh68HEDsw+YOOFx8k2bD8vlci8Pnu/yXAiflwlYNHrLNw+LIWu67JuP5yxiHm3h3s6u0C5E2l5cHtA5CMSDpkzyNJTJZjalHPvhPgOVLClSVA47Re384t0vsIDTfsyiTuY/weDBL5c/vvnP1RuSS7Wpzr9hP+7HYdrVzhdcdVRd4PYJqn65mlldNG9L9xP5blv9/3kF++cVbPMK1jQRjys/MJKL0ImbYa/uoh/ZvYexcfsGNolYrp0nkrs7gsivVlYVLddPN9RcM+FonNk+3tziuvPUFC5J9az4IG3zJrQlndCHFUR7WMeDyP/mfXNyz+Epj3QHg9O2XbXuGtUa28ammtDlqO67ZGO9e56maLp+781hO8PMxZtrFjFe+ny339+Gft/8IOkHbdodBGoD6C+F+iDD99Sefsb1vzbk9c6DDI1/LTXFZ1JV1f8BGbwW1w==",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},f={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("h1",{className:"openapi__heading",children:(0,i.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,i.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,i.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,i.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,i.jsxs)(s.ol,{children:["\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(s.li,{children:["\n",(0,i.jsx)(s.p,{children:(0,i.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Path Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsx)("ul",{children:(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,i.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,i.jsx)(s.p,{children:"Query Parameters"})})}),(0,i.jsx)("div",{children:(0,i.jsxs)("ul",{children:[(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,i.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,i.jsx)("div",{children:(0,i.jsx)("div",{children:(0,i.jsxs)(l.Z,{children:[(0,i.jsxs)(h.default,{label:"200",value:"200",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"successful operation"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(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:"result"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"document[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"folder"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)(d.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(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:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,i.jsx)(d.Z,{collapsible:!0,className:"schemaItem",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,i.jsx)("summary",{style:{},children:(0,i.jsxs)("span",{className:"openapi-schema__container",children:[(0,i.jsx)("strong",{className:"openapi-schema__property",children:(0,i.jsx)(s.p,{children:"widgets"})}),(0,i.jsx)("span",{className:"openapi-schema__name",children:(0,i.jsx)(s.p,{children:"object[]"})})]})}),(0,i.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,i.jsx)(s.p,{children:"Array ["})})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})}),(0,i.jsx)(d.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!0}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"redirect_url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:""}}),(0,i.jsx)(d.Z,{collapsible:!1,name:"allow_modifications",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,i.jsx)("li",{children:(0,i.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,i.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": true,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z",\n "enableTour": true,\n "redirect_url": "",\n "allow_modifications": false\n }\n ]\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"404",value:"404",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Report not available!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,i.jsxs)(h.default,{label:"405",value:"405",children:[(0,i.jsx)("div",{children:(0,i.jsx)(s.p,{children:"Invalid API Token!"})}),(0,i.jsx)("div",{children:(0,i.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,i.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,i.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,i.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,i.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,i.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,i.jsx)("strong",{children:(0,i.jsx)(s.p,{children:"Schema"})})}),(0,i.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,i.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,i.jsx)(d.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,i.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,i.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink