Files
OpenSign/assets/js/5ce9853b.28eaefb4.js
T

1 line
13 KiB
JavaScript

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2542],{158:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>j,contentTitle:()=>u,default:()=>b,frontMatter:()=>h,metadata:()=>x,toc:()=>g});var l=a(85893),i=a(11151),n=a(58219),r=(a(62316),a(51039)),t=a.n(r),d=(a(82723),a(9487)),o=(a(41429),a(5397)),c=a(4667),m=a(9472),p=a(85162);const h={id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT52VRFEmdIDAS1EGcIg+2IFC7oxVjLsnwogsW+9Yv6af1S4rhXrSyFCdp0fahL4ZMzu0MZ87MVszzwrH0hr3QWShRecdmCcvRZVYYL7RiKXuHDlUOFj8FdB5KLiR4DcGhhaW24EShhCogb02MbxVLmDZoOVm4zHsbrQmywBLW/vezzncsrVimlUfl6Sc3Roosak8+OgqiYi5bYcnpF+kJizmF3fmci5wlDKPlWcL8ziBLmV58xMyzhBlL4XiBjgwMldKqE3beClWQlS0vjaQjY/Va5NgjA5GzunNzQvMwb512TFTM2tLqMqYLraMUWhwdpbbJ3j4G0n7W/jvOdNkHMHehgffFQC6C861j7oPF3l+0A60dEAo8bv1k5UtJD1tyP4YLrkCoTIYcYaml1Bt66jW3gi8kOoCq6tPphZdY11BVhArtXPES6zrZH5C/gwOz0qoVsZihWB9o9Ue4V+zPBqq4NcLu5jn37UGmS8PVbhhAU6TzYGVdjw8yvM/ooi3Fv5VOMvI/zmWdsBg7S5mNTb/PbE2X++71NmA8cEYr17Tmk+k0duhBwlny9eTwcOdbdEGe7JjmjU7TQNMl1P8uZBk6twxS7sYHWIWSQuG8AzN/Mp3Oz6YEuU7Y+T+LCq3V9ltBXesS/YoKcEPINlar4mFI59Pp/EmP6PwY0WhPlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjgULLnHlz1bRVq2hiUUWyaogUpHAe9N5L5M//MrMnkqDtPZRfyvT5/KzP9NPjTF+qNZcih+dvL+G9vkP16F/AvEc4dO8b9xTqtoxTkYgigopC8Z4dgB2eNyAdZsEKv2PpTcW2I27EqLlPb2b1LGFUqpr2CKNdjJj7FUvZZM8wjIzYNVoXbQQrWcpW3huXTiaOq3yht2NtUFHVSL5wNEsn3IjJ+ozVyX0Nbsw3SDvPC6GK0YNasz3Ma3qKJtsHYPuccyNe444lXS6HUgkTVAIr5DnamHd64Xf7Zepl9073Np2T60y/zRwvGkd7BmOHgzJOTqGWOkbePu+VQXUtChWLY312ND0/oMx0ibT++BVCJ/7Hb79HjS62WLuP4CpYMHqDdhkkcJXDUuJWLCRGYU4z1MFOBzLnkJcSnZM0fj0WlnuEXBTCc9kvqRk3fCGkoGonMU3aFgYN48bwYYV+hZauvrMIHHJco6QmAan1HdnxGnjwuow+unxutL1bUkgJcFgEJxQ6Bw6xU0G14ipD6AohIWbgClB5tMYKh8BFScK0WONyKTJBhqm1Lc9oQ1S8QHKWAMVNWWif1YHVi+A8OC1DBEIeS0TfQFSIuRvDC7HGBjgd5ui5kJhDEchEApnOEdoqIBgqhwXtNobciwyjUee59SBxjTYWfnxJGopgNFGQ4JIYefi2ZMhbrhwxZxNQ9zR9+ozVNF2jj5zvxnCrbhXNKSJPKgAp1J1LaWbc9GX2ARdOeJx93zXjZrM5asLHhzqvhF+FBVg0eq9XxMPYskP1/p/HLGEebemultdo1yLDlgE+43MShSctMfNmUe+ajRvx7L4CdZMUGSqHAxp9/urtG1jDD+MpSwa08xUBT95cXrz85fol2SVibPrvbDwdT+mIqLTkauDqxIfe/fYdfKb9xe/CluHidmwkF3E2RFxVS+s3g8WRPuZWxPnpDauqBXf4Ky2ddPwpoKWBMUtYt0LHcZF01Ehz4A6Jpy6amEfvyTeJy9Cw7L0pSczeaDzPMjT+QdnhWHp7df2eJaz7fih1HvdfvqHPXL5hKbtltyx+FcfOjLsonVdMclUEXpB8Y5cYnQdKxHAc3MVx0P4gZN2V2g2iPJwTDRT6S8BOKvxIBPIadz/14s3NZxXa3HbS9Hyzuq7/BNpxzI0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,x={id:"API-docs/resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",source:"@site/docs/API-docs/resendrequestmail.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/resendrequestmail",permalink:"/docs/API-docs/resendrequestmail",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"resendrequestmail",title:"Resend request mail",description:"Resend request mail to user for signing document.",sidebar_label:"Resend request mail",hide_title:!0,hide_table_of_contents:!0,api:"eJzlV9tuGzcQ/ZUJX9oAq4tT52VRFEmdIDAS1EGcIg+2IFC7oxVjLsnwogsW+9Yv6af1S4rhXrSyFCdp0fahL4ZMzu0MZ87MVszzwrH0hr3QWShRecdmCcvRZVYYL7RiKXuHDlUOFj8FdB5KLiR4DcGhhaW24EShhCogb02MbxVLmDZoOVm4zHsbrQmywBLW/vezzncsrVimlUfl6Sc3Roosak8+OgqiYi5bYcnpF+kJizmF3fmci5wlDKPlWcL8ziBLmV58xMyzhBlL4XiBjgwMldKqE3beClWQlS0vjaQjY/Va5NgjA5GzunNzQvMwb512TFTM2tLqMqYLraMUWhwdpbbJ3j4G0n7W/jvOdNkHMHehgffFQC6C861j7oPF3l+0A60dEAo8bv1k5UtJD1tyP4YLrkCoTIYcYaml1Bt66jW3gi8kOoCq6tPphZdY11BVhArtXPES6zrZH5C/gwOz0qoVsZihWB9o9Ue4V+zPBqq4NcLu5jn37UGmS8PVbhhAU6TzYGVdjw8yvM/ooi3Fv5VOMvI/zmWdsBg7S5mNTb/PbE2X++71NmA8cEYr17Tmk+k0duhBwlny9eTwcOdbdEGe7JjmjU7TQNMl1P8uZBk6twxS7sYHWIWSQuG8AzN/Mp3Oz6YEuU7Y+T+LCq3V9ltBXesS/YoKcEPINlar4mFI59Pp/EmP6PwY0WhPlEp7WOqgchDLIX2CcPEu09ZiRqNi1PDjgULLnHlz1bRVq2hiUUWyaogUpHAe9N5L5M//MrMnkqDtPZRfyvT5/KzP9NPjTF+qNZcih+dvL+G9vkP16F/AvEc4dO8b9xTqtoxTkYgigopC8Z4dgB2eNyAdZsEKv2PpTcW2I27EqLlPb2b1LGFUqpr2CKNdjJj7FUvZZM8wjIzYNVoXbQQrWcpW3huXTiaOq3yht2NtUFHVSL5wNEsn3IjJ+ozVyX0Nbsw3SDvPC6GK0YNasz3Ma3qKJtsHYPuccyNe444lXS6HUgkTVAIr5DnamHd64Xf7Zepl9073Np2T60y/zRwvGkd7BmOHgzJOTqGWOkbePu+VQXUtChWLY312ND0/oMx0ibT++BVCJ/7Hb79HjS62WLuP4CpYMHqDdhkkcJXDUuJWLCRGYU4z1MFOBzLnkJcSnZM0fj0WlnuEXBTCc9kvqRk3fCGkoGonMU3aFgYN48bwYYV+hZauvrMIHHJco6QmAan1HdnxGnjwuow+unxutL1bUkgJcFgEJxQ6Bw6xU0G14ipD6AohIWbgClB5tMYKh8BFScK0WONyKTJBhqm1Lc9oQ1S8QHKWAMVNWWif1YHVi+A8OC1DBEIeS0TfQFSIuRvDC7HGBjgd5ui5kJhDEchEApnOEdoqIBgqhwXtNobciwyjUee59SBxjTYWfnxJGopgNFGQ4JIYefi2ZMhbrhwxZxNQ9zR9+ozVNF2jj5zvxnCrbhXNKSJPKgAp1J1LaWbc9GX2ARdOeJx93zXjZrM5asLHhzqvhF+FBVg0eq9XxMPYskP1/p/HLGEebemultdo1yLDlgE+43MShSctMfNmUe+ajRvx7L4CdZMUGSqHAxp9/urtG1jDD+MpSwa08xUBT95cXrz85fol2SVibPrvbDwdT+mIqLTkauDqxIfe/fYdfKb9xe/CluHidmwkF3E2RFxVS+s3g8WRPuZWxPnpDauqBXf4Ky2ddPwpoKWBMUtYt0LHcZF01Ehz4A6Jpy6amEfvyTeJy9Cw7L0pSczeaDzPMjT+QdnhWHp7df2eJaz7fih1HvdfvqHPXL5hKbtltyx+FcfOjLsonVdMclUEXpB8Y5cYnQdKxHAc3MVx0P4gZN2V2g2iPJwTDRT6S8BOKvxIBPIadz/14s3NZxXa3HbS9Hyzuq7/BNpxzI0=",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Document list from status",permalink:"/docs/API-docs/getdocumentlist"},next:{title:"Draft Template",permalink:"/docs/API-docs/drafttemplate"}},j={},g=[{value:"Request",id:"request",level:2}];function f(e){const s={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Resend request mail"})}),"\n",(0,l.jsx)(t(),{method:"post",path:"/resendmail"}),"\n",(0,l.jsx)(s.p,{children:"Resend request mail to user for signing document."}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(s.p,{children:"Body"})}),(0,l.jsx)("strong",{className:"openapi-schema__required",children:(0,l.jsx)(s.p,{children:"required"})})]}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(c.Z,{collapsible:!1,name:"document_id",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"provide document id"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email",required:!0,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"provide user mail from signers to re-send request mail.\n",example:"user@example.com"}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email_subject",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email subject in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}}),(0,l.jsx)(c.Z,{collapsible:!1,name:"email_body",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",description:"Custom signature request email body in text/html format. Can include following variables {{document_title}} {{sender_name}}, {{sender_mail}}, {{sender_phone}}, {{receiver_name}}, {{receiver_email}}, {{receiver_phone}}, {{expiry_date}}, {{company_name}}, {{signing_url}}.",example:""}})]})]})})}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(n.Z,{children:[(0,l.jsxs)(p.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"result",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"mail sent successfully."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "result": "mail sent successfully."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Something went wrong."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Something went wrong."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsxs)(s.ul,{children:["\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"document not found if document id is not correct."}),"\n"]}),"\n",(0,l.jsxs)(s.li,{children:["\n",(0,l.jsx)(s.p,{children:"user not found if provided user email is not present in signer list of document"}),"\n"]}),"\n"]})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"document not found or user not found."}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "document not found or user not found."\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(p.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(p.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(p.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,l.jsx)(c.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,l.jsx)(p.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:s}={...(0,i.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(f,{...e})}):f(e)}}}]);