WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 04:24:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
f633a0bea103efe3a8ea014dd1f8120b1036e797
OpenSign/assets/js/fa40969b.e68bf28a.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:()=>g,contentTitle:()=>u,default:()=>b,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var n=a(85893),i=a(11151),l=a(58219),r=(a(62316),a(51039)),t=a.n(r),m=(a(82723),a(9487)),c=a(41429),d=a(5397),o=a(4667),p=a(9472),h=a(85162);const x={id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v27YW/itn7IethWLLidNuwnCxYO0Nsg23RZOhwG2MgJKOLTYUyZGUX2Do2/0l+2n7JReHkmw5TtJ4G/ppXxKLPO98zgu5Zp7PHEs+stc6q0pU3rFJxHJ0mRXGC61Ywp49ewbdNlytDLrkWr1HbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAL168tnzqN5Jc8uLFtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpn9cyic39KqmmZg8QTkvijLo1Ej/lT5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsXfKmExBydmivvKYqNzTDrfLE3Ye6pGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6z3yq0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6z/M3y4TefUxQaLjfQUnnO/v3ubg9PkmLX3+imEwFLR4mofDeuGQ4bFcqKweZLkmaF/5wcS78oFQhEUr7gyUYidxhKEqbjAvOaZmj/VKhbDB8mITGQgis9TaArPPipnWhjpheqB1fniT/kw6FkPgpOqGa/VnAWX3/2W61ZagfC8S9ZmHJhfwsdYr4Q7vQYc0UWn1Gzfj05fHo5NtXI6JfiHyG/i/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBz6dDRk9HL/ULW496sbLiPx+M6YqsDuV6NKD4HMp18W0esOJBp/JJOjs/wQL5RPzk8lkZyjzeXDaRvuqOtH6MK+eVQ5Rfqrd0tC6nWErnqKwy9po5YZpF7zM/840g7jo9PjkbxUfzqavQyGX+XnL4cxHH8XxaxZRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mtx0XfPmOI5vxkRSR2wcj/e753s02npQ2gOfcyF5KvGrv699orX63nK4Ddb9Fjzm1Dge35xunDrdd+pCzbkUOZy9u4ArfYvqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuMsjbsRRs598nNCQVKIvdDsgh6HYFyxhw/6sPFy3Q3HNSJ6ddyNzZWVvWHBc5aleDrRBRSVO8tRRKR9yI4ZzqtB3ObgxB1A7z2dCzY4e5ZpsPb6kU2kCv+P3tjsY8TNSe2jD2qdqR9QCeWjONX1PdWBug/3WoKLCE45qPtprEx9QZrpEuhbQvaQj/+N/vweOLsABSV/B28qC0Qu0NIvSfWkqcUn3o0DMqeU4WOmKxDnkpUTnwtXQ48xyj5CLmfBchmYk1AwybngqpCDsEZkmbgs9+LoBfCjQF2hp62tL9+Mc5ygJsiC1viU5XgOvvC6Dju5mvdD2dkomRcAhrZxQdLF1iB0LqoKrDKE7iwi0Ba4AlUdrrHAIXJREPNUWcDoVmSDBlGiWZx5KrvgMSVkEZDdFwVg9Fzk6sDqtnAenZRUcIY0lom9cVIi5G8BrMcfGcVrM0XMhMYdZRSIiyHROF9SQd+SGyiFF58GQepFhEOo8tx4kztEG7IWTpLszGE0FQXBJd8D+2ZIgb7ly1Osag7qj2YTPWE3XjqAj56sB0B34ksBSOSQASKFu6eXiCD5uYPYBUyc8Tr7p8mGxWOzlwfNdnnPhiyoFi0Zv+WZhMWRNn33z8ZxFzKMt3dvpJdq5yLobwQM6h4F42JZJnoUy2Q59lGM/3GWgkiVFhsphr6idnb/7BeZwMohZ1Mv8Jxg8/OXixzf/uXxDcqk2Nfk3GsSDOIyR2vmSq56qc9y+7TRPQlOry/bR5m4ir7fV/5/npX+elzbPS20T8bj0QyO5CJ044HbddtGP7M6LU9I9Lk0iVmjniWS9Joj8amVd03LzJkLNNReOxpntq8gtrnpvOOH2wRIWGuUDtO1jy5Z0Qh9WEO39Oh5E/jfv25N7Dk95/bo3OF3bVau+UZ2xXWzqCd06mr5LNja7Z1mGpu/33hy2M8ycv7liEeOVL3b7/W3o9+0Pkn6vTbuDQGMA/aVQ38vwPbWnn3H1rw15s/MgQ+tfR03xmdR1/X9uwtxv",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,j={id:"API-docs/getdocumentlist",title:"Get Document list from status",description:"### Document Types:",source:"@site/docs/API-docs/getdocumentlist.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/getdocumentlist",permalink:"/docs/API-docs/getdocumentlist",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"getdocumentlist",title:"Get Document list from status",description:"### Document Types:",sidebar_label:"Get Document list from status",hide_title:!0,hide_table_of_contents:!0,api:"eJztWG1v27YW/itn7IethWLLidNuwnCxYO0Nsg23RZOhwG2MgJKOLTYUyZGUX2Do2/0l+2n7JReHkmw5TtJ4G/ppXxKLPO98zgu5Zp7PHEs+stc6q0pU3rFJxHJ0mRXGC61Ywp49ewbdNlytDLrkWr1HbwXOEThI4TzoKeSdCEi5wxy0Ar8yeK2u1WgAL168tnzqN5Jc8uLFtQIAONqugS+4B24RsspaVF6uQCjIA6fz3FduQPKOSd6FOnpn9cyic39KqmmZg8QTkvijLo1Ej/lT5BV8jpAiKnBVlqFz00rKFWQbGQvhC+BSgsXfKmExBydmivvKYqNzTDrfLE3Ye6pGbOm5yoNLSoPUaoYWeLBCpBKD9NMQc8ykUIc6lHdc6Qp8gVA5tINrxSKmDVpOuLjIWcJm6LtDJxCwiBlueYkeLYFqzRQvkSUs1xkhgUVMEKAM9wW7i7KrAgNcdpHkNdgWaSxiXSBZ4m2FEXN+JUm+ExRzFjFcGqlzZMmUS0cEWYElZ8maBf0Jc94KNSNKVZWE+wCtYFgHBxaxzRk2IoNKsreJCpvUdbTxTYpS+M6z3yq0qx1DO0NaS6faln07Wz82ZpZ8KUqy7DSOo85oVZUpWlYTHw+eJqO4Z4K7FeZvs+BhnXE9IbnOaOXQEe1xHNO/3YPcZgNs0BJiqjwqT/TcGCmysDH85IhpvW+ATj9hFiBlSYwXjUqLrpK+R8et5eSw8Fi6z/M3y4TefUxQaLjfQUnnO/v3ubg9PkmLX3+imEwFLR4mofDeuGQ4bFcqKweZLkmaF/5wcS78oFQhEUr7gyUYidxhKEqbjAvOaZmj/VKhbDB8mITGQgis9TaArPPipnWhjpheqB1fniT/kw6FkPgpOqGa/VnAWX3/2W61ZagfC8S9ZmHJhfwsdYr4Q7vQYc0UWn1Gzfj05fHo5NtXI6JfiHyG/i/43+zu69stGmdS6gXmMOeyQgdH21YZUd8vzeBz6dDRk9HL/ULW496sbLiPx+M6YqsDuV6NKD4HMp18W0esOJBp/JJOjs/wQL5RPzk8lkZyjzeXDaRvuqOtH6MK+eVQ5Rfqrd0tC6nWErnqKwy9po5YZpF7zM/840g7jo9PjkbxUfzqavQyGX+XnL4cxHH8XxaxZRng3Q0Q3CPrJ3r7XZn8C+ip98h61fJu7dkNp1A0Mtx0XfPmOI5vxkRSR2wcj/e753s02npQ2gOfcyF5KvGrv699orX63nK4Ddb9Fjzm1Dge35xunDrdd+pCzbkUOZy9u4ArfYvqy3rUV+8b9ftnKhqisM92nO2vN046zCor/CrMuMsjbsRRs598nNCQVKIvdDsgh6HYFyxhw/6sPFy3Q3HNSJ6ddyNzZWVvWHBc5aleDrRBRSVO8tRRKR9yI4ZzqtB3ObgxB1A7z2dCzY4e5ZpsPb6kU2kCv+P3tjsY8TNSe2jD2qdqR9QCeWjONX1PdWBug/3WoKLCE45qPtprEx9QZrpEuhbQvaQj/+N/vweOLsABSV/B28qC0Qu0NIvSfWkqcUn3o0DMqeU4WOmKxDnkpUTnwtXQ48xyj5CLmfBchmYk1AwybngqpCDsEZkmbgs9+LoBfCjQF2hp62tL9+Mc5ygJsiC1viU5XgOvvC6Dju5mvdD2dkomRcAhrZxQdLF1iB0LqoKrDKE7iwi0Ba4AlUdrrHAIXJREPNUWcDoVmSDBlGiWZx5KrvgMSVkEZDdFwVg9Fzk6sDqtnAenZRUcIY0lom9cVIi5G8BrMcfGcVrM0XMhMYdZRSIiyHROF9SQd+SGyiFF58GQepFhEOo8tx4kztEG7IWTpLszGE0FQXBJd8D+2ZIgb7ly1Osag7qj2YTPWE3XjqAj56sB0B34ksBSOSQASKFu6eXiCD5uYPYBUyc8Tr7p8mGxWOzlwfNdnnPhiyoFi0Zv+WZhMWRNn33z8ZxFzKMt3dvpJdq5yLobwQM6h4F42JZJnoUy2Q59lGM/3GWgkiVFhsphr6idnb/7BeZwMohZ1Mv8Jxg8/OXixzf/uXxDcqk2Nfk3GsSDOIyR2vmSq56qc9y+7TRPQlOry/bR5m4ir7fV/5/npX+elzbPS20T8bj0QyO5CJ044HbddtGP7M6LU9I9Lk0iVmjniWS9Joj8amVd03LzJkLNNReOxpntq8gtrnpvOOH2wRIWGuUDtO1jy5Z0Qh9WEO39Oh5E/jfv25N7Dk95/bo3OF3bVau+UZ2xXWzqCd06mr5LNja7Z1mGpu/33hy2M8ycv7liEeOVL3b7/W3o9+0Pkn6vTbuDQGMA/aVQ38vwPbWnn3H1rw15s/MgQ+tfR03xmdR1/X9uwtxv",sidebar_class_name:"get api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Delete Document",permalink:"/docs/API-docs/deletedocument"},next:{title:"Resend request mail",permalink:"/docs/API-docs/resendrequestmail"}},g={},y=[{value:"Document Types:",id:"document-types",level:3},{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)("h1",{className:"openapi__heading",children:(0,n.jsx)(s.p,{children:"Get Document list from status"})}),"\n",(0,n.jsx)(t(),{method:"get",path:"/documentlist/{doctype}"}),"\n",(0,n.jsx)(s.h3,{id:"document-types",children:"Document Types:"}),"\n",(0,n.jsx)(s.p,{children:"Retrieve a list of documents based on type"}),"\n",(0,n.jsxs)(s.ol,{children:["\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Draft Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in draft status."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"In-Progress Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that are currently in progress."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Completed Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been successfully completed with all required signatures."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Expired Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have expired and are no longer accessible."}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(s.li,{children:["\n",(0,n.jsx)(s.p,{children:(0,n.jsx)(s.strong,{children:"Declined Documents:"})}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsx)(s.li,{children:"Documents that have been declined by the user."}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Path Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsx)("ul",{children:(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"doctype",in:"path",description:"The type of documents to retrieve",required:!0,style:"simple",explode:!1,schema:{type:"string",enum:["draft","inprogress","completed","expired","declined"]}}})})})]}),"\n",(0,n.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,n.jsx)(s.p,{children:"Query Parameters"})})}),(0,n.jsx)("div",{children:(0,n.jsxs)("ul",{children:[(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"limit",in:"query",required:!1,style:"form",explode:!0,schema:{maximum:500,type:"number"},example:10}}),(0,n.jsx)(c.Z,{className:"paramsItem",param:{name:"skip",in:"query",required:!1,style:"form",explode:!0,schema:{type:"number"},example:0}})]})})]}),"\n",(0,n.jsx)("div",{children:(0,n.jsx)("div",{children:(0,n.jsxs)(l.Z,{children:[(0,n.jsxs)(h.default,{label:"200",value:"200",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"successful operation"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"result"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"document[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"file",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://exampleurl.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"title",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample doc"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"please sign document"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"folder"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)(o.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"FGik23bhUJ"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder name"}})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"owner",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"signers"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"role",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"ceo"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joe bee"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"email",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"joebee@example.com"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"phone",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"456213871"}}),(0,n.jsx)(o.Z,{collapsible:!0,className:"schemaItem",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,n.jsx)("summary",{style:{},children:(0,n.jsxs)("span",{className:"openapi-schema__container",children:[(0,n.jsx)("strong",{className:"openapi-schema__property",children:(0,n.jsx)(s.p,{children:"widgets"})}),(0,n.jsx)("span",{className:"openapi-schema__name",children:(0,n.jsx)(s.p,{children:"object[]"})})]})}),(0,n.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem",paddingBottom:".5rem"},children:(0,n.jsx)(s.p,{children:"Array ["})})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"type",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Allowed values - signature, stamp.",format:"string",example:"signature"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"x",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:244}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"y",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:71}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"w",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:38}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"h",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:46}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"page",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",format:"number",example:1}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})}),(0,n.jsx)(o.Z,{collapsible:!1,name:"sendInOrder",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",example:!1}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"createdAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)(o.Z,{collapsible:!1,name:"updatedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}}),(0,n.jsx)("li",{children:(0,n.jsx)("div",{style:{fontSize:"var(--ifm-code-font-size)",opacity:"0.6",marginLeft:"-.5rem"},children:(0,n.jsx)(s.p,{children:"]"})})})]})]})})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "result": [\n {\n "objectId": "FGik23bhUJ",\n "file": "https://exampleurl.com",\n "title": "sample doc",\n "note": "please sign document",\n "folder": {\n "objectId": "FGik23bhUJ",\n "name": "folder name"\n },\n "owner": "joe bee",\n "signers": [\n {\n "role": "ceo",\n "name": "joe bee",\n "email": "joebee@example.com",\n "phone": "456213871",\n "widgets": [\n {\n "type": "signature",\n "x": 244,\n "y": 71,\n "w": 38,\n "h": 46,\n "page": 1\n }\n ]\n }\n ],\n "sendInOrder": false,\n "createdAt": "2023-10-07T16:49:56.000Z",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n }\n ]\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"404",value:"404",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Report not available!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Report not available!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Report not available!"\n}',language:"json"})})]})})})})]}),(0,n.jsxs)(h.default,{label:"405",value:"405",children:[(0,n.jsx)("div",{children:(0,n.jsx)(s.p,{children:"Invalid API Token!"})}),(0,n.jsx)("div",{children:(0,n.jsx)(m.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,n.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,n.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,n.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,n.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,n.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,n.jsx)("strong",{children:(0,n.jsx)(s.p,{children:"Schema"})})}),(0,n.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,n.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,n.jsx)(o.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,n.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,n.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink