WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-22 01:24:54 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
3be80c6255e1ccf676b5372bb83703fdea40bb5f
OpenSign/assets/js/5a2de241.a62323e7.js
T

1 line
14 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[8163],{85763:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>f});var l=s(85893),i=s(11151),t=s(58219),n=(s(62316),s(51039)),r=s.n(n),d=(s(82723),s(9487)),o=s(41429),p=s(5397),m=s(4667),c=s(9472),h=s(85162);const u={id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWOuO4zQUfpWD/7BI6WVmBxARQiywghGIGTFdrcRONXLjk8aMYxvbaaeq8o8n4dF4EnTspE2n3YHl+qdKnXP7zt3ZssCXnuVv2Axrq3hAz+YZE+gLJ22QRrOczSqEV1bwgNBTwYvrS0DNFwo9bEwDwUBthCw3wLWAJlGHCkFg4FJ5MCVw8BYLWcoCQidnzDJmLDpOqi4Fy1li7fWwjFnueI0BHZm5ZZrXyHLWC7iTgmVMkpmWh4o9tv3yK9JMhvQcECoeQCMKT1YvsLOW5Dj8uZEOBcuDazBjPmwUafOytoqMwQerjECWl1x5IigqrDnLtyxsbKQMTuoly1hpXM3D/qRt50k++vCFERviOTT12pmVFAgLVGYNO9hkZO/PPkbwjAdQyH0Ao3FA2wP4gGWsMDqgDqSIW6tkEZ08+cmTtu2x6WbxExaBPO4oJEGip7fJ4X8MkJzDo5ty5uPDzl7WZkyb8M5irgkigsOVxHVMLC+XGkIlPQhTNDXBax+F/N1U7LJiKKMlHiXQUUYey9tzE2WqgqvZ9YB0YYxCro+ykbIKRgmAiYewlkp1lQRXs2tYoaMKibEawyuPzicahwXKFQI/IIHCCISV5IA1lyqDdSWLihJ+A3XjA6DucqhzHe48N4aYxDCCY4OE9CctyoArZdZSL6GJpp0SDEI6LILawFqGyjQBuBCS2LkCH9D68dCL0YqdI2emcX/fkxyWjRQoIJjGQWlctBKdz8DGMiMEUvvgmoKYPYiGohtxECk9W2cK9H7vp94rRDSQnwFqn9g5lNwHdBk0WpLnXWMDip1IfLDoJOoCT7igzViQ4SAt7wZ97m5BbaNtic6ht0b7VKHn0+lxN9l16q67gW8KQlM2Sm3e++faQzr+o0LhXpx/468vvrFUMp1JL8LTTOfT8+ejs+lo+vHs7KP84pP8w4/G0+n0R5axh1rtexMTXY/pvZf+Dw6kVlLjXe+1u/Pp9O5558qLU97rOo/tWvKKKymglKgEkE7/DzoQnTPuL3bGJ+x7Cj5B7sFfPJE62gQoTaPF/w33lEVPA7y4+3gH8cNjiJc6uYzWmJm5R/1fINzjGaoPST2ZepjVMhHF9+wA7PA8gfRYNE6GTVyRHkbcylF6n7+Z0+JRY6gMrVe2iQbTqpSzSd9dJttBn2kZyXOrfuNqnGI5q0KwPp9MPNdiYR7GxqKmrqb4wo8LU0+4lZPVGWuzxxzc2neg9oEvpV6OnuSa7xHfUFSS4w9w79zPrfwWNyzr3Tqk6jbHCrlAF0NAwf5hv6W97EO2i8rj1abfbP7csnI0xk6tH8Ptg7GDDaNbO4ejsh+fUpcmwu7S5MqiviELKMlWZ0eqX6MqTI00wWme9eS//fJr5OhNjjXwHlw1DqxZoysbFcGVCh8kDUMijkvB7iLgkdcKvVcboBm4dBGgXMpA87+bhAW3fCGVpKohMkPcDgaF58fwusJQoaNX7zua6gJXqKjYQBlzHwe2Ad4EU0cd/QKyNu6+JJMy4LBovNToPXjEngV1xXWB0GdRBsYB12lbsk56BC5rIqbdActSFpIEU4twvAhQc82XSMoyILvJC1039uDMglYvb1STlgu6HSGGBDFePcbwFS1zETgdpmsSirRX+CztdV3HIBhawAJ9AEvqZYFp9Qrc0UVghS5WTYwkTXiwhlqZ5IquP8PYkqDguPbUb5NBfWh27usWn6hD8M0YbvWtvqFkaTxSAiip731+q0fwZpdmr3HhZcD5s76S1+v1UQV/cMjztQxVswCH1uz5lvEw1vuQffeH7jYBXe2vyht0K1lg1z7eonMSiSddg+dFbPBxW07d4fPHDNRslSxQ+2Hhv/j6+jtYwfPxlGWDnvUnDJ58d/nly+9vXpJc6qqp/s7G0/GUjqzxoeZ6oOrRZftx6W73k+rfvpt3PTTgQ5hYxWUcRBH8thsib9igFebDa/k8Y5XxgUi22wX3+MqptqXjnxt0NKrmGVtxJ8nSOGm6/Vrs+txbYT/7ob/owrvd8E8C6ieFpjGx4qrB1HjvcfPoU0M7b7N+XJDFieLLZNdoRnL2Eo6WCJp2ieNFUaANT9IOp/b1qxnL2KL7bFDHLxDM8TV9suBrlrNbdsvip5TYb4gonm+Z4nrZ8CXRJ7E05HhDkRtOyPs4IbsHAnbSJYejMyGhX8J1kuFTSsVvcfPZjjy9eStD59qemsIzb9v2d/SZiGg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={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.",source:"@site/docs/API-docs/update-template.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/update-template",permalink:"/docs/API-docs/update-template",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"update-template",title:"Update Template",description:"The Update Template API enables you to modify and update the details of a specific template.",sidebar_label:"Update Template",hide_title:!0,hide_table_of_contents:!0,api:"eJzFWOuO4zQUfpWD/7BI6WVmBxARQiywghGIGTFdrcRONXLjk8aMYxvbaaeq8o8n4dF4EnTspE2n3YHl+qdKnXP7zt3ZssCXnuVv2Axrq3hAz+YZE+gLJ22QRrOczSqEV1bwgNBTwYvrS0DNFwo9bEwDwUBthCw3wLWAJlGHCkFg4FJ5MCVw8BYLWcoCQidnzDJmLDpOqi4Fy1li7fWwjFnueI0BHZm5ZZrXyHLWC7iTgmVMkpmWh4o9tv3yK9JMhvQcECoeQCMKT1YvsLOW5Dj8uZEOBcuDazBjPmwUafOytoqMwQerjECWl1x5IigqrDnLtyxsbKQMTuoly1hpXM3D/qRt50k++vCFERviOTT12pmVFAgLVGYNO9hkZO/PPkbwjAdQyH0Ao3FA2wP4gGWsMDqgDqSIW6tkEZ08+cmTtu2x6WbxExaBPO4oJEGip7fJ4X8MkJzDo5ty5uPDzl7WZkyb8M5irgkigsOVxHVMLC+XGkIlPQhTNDXBax+F/N1U7LJiKKMlHiXQUUYey9tzE2WqgqvZ9YB0YYxCro+ykbIKRgmAiYewlkp1lQRXs2tYoaMKibEawyuPzicahwXKFQI/IIHCCISV5IA1lyqDdSWLihJ+A3XjA6DucqhzHe48N4aYxDCCY4OE9CctyoArZdZSL6GJpp0SDEI6LILawFqGyjQBuBCS2LkCH9D68dCL0YqdI2emcX/fkxyWjRQoIJjGQWlctBKdz8DGMiMEUvvgmoKYPYiGohtxECk9W2cK9H7vp94rRDSQnwFqn9g5lNwHdBk0WpLnXWMDip1IfLDoJOoCT7igzViQ4SAt7wZ97m5BbaNtic6ht0b7VKHn0+lxN9l16q67gW8KQlM2Sm3e++faQzr+o0LhXpx/468vvrFUMp1JL8LTTOfT8+ejs+lo+vHs7KP84pP8w4/G0+n0R5axh1rtexMTXY/pvZf+Dw6kVlLjXe+1u/Pp9O5558qLU97rOo/tWvKKKymglKgEkE7/DzoQnTPuL3bGJ+x7Cj5B7sFfPJE62gQoTaPF/w33lEVPA7y4+3gH8cNjiJc6uYzWmJm5R/1fINzjGaoPST2ZepjVMhHF9+wA7PA8gfRYNE6GTVyRHkbcylF6n7+Z0+JRY6gMrVe2iQbTqpSzSd9dJttBn2kZyXOrfuNqnGI5q0KwPp9MPNdiYR7GxqKmrqb4wo8LU0+4lZPVGWuzxxzc2neg9oEvpV6OnuSa7xHfUFSS4w9w79zPrfwWNyzr3Tqk6jbHCrlAF0NAwf5hv6W97EO2i8rj1abfbP7csnI0xk6tH8Ptg7GDDaNbO4ejsh+fUpcmwu7S5MqiviELKMlWZ0eqX6MqTI00wWme9eS//fJr5OhNjjXwHlw1DqxZoysbFcGVCh8kDUMijkvB7iLgkdcKvVcboBm4dBGgXMpA87+bhAW3fCGVpKohMkPcDgaF58fwusJQoaNX7zua6gJXqKjYQBlzHwe2Ad4EU0cd/QKyNu6+JJMy4LBovNToPXjEngV1xXWB0GdRBsYB12lbsk56BC5rIqbdActSFpIEU4twvAhQc82XSMoyILvJC1039uDMglYvb1STlgu6HSGGBDFePcbwFS1zETgdpmsSirRX+CztdV3HIBhawAJ9AEvqZYFp9Qrc0UVghS5WTYwkTXiwhlqZ5IquP8PYkqDguPbUb5NBfWh27usWn6hD8M0YbvWtvqFkaTxSAiip731+q0fwZpdmr3HhZcD5s76S1+v1UQV/cMjztQxVswCH1uz5lvEw1vuQffeH7jYBXe2vyht0K1lg1z7eonMSiSddg+dFbPBxW07d4fPHDNRslSxQ+2Hhv/j6+jtYwfPxlGWDnvUnDJ58d/nly+9vXpJc6qqp/s7G0/GUjqzxoeZ6oOrRZftx6W73k+rfvpt3PTTgQ5hYxWUcRBH8thsib9igFebDa/k8Y5XxgUi22wX3+MqptqXjnxt0NKrmGVtxJ8nSOGm6/Vrs+txbYT/7ob/owrvd8E8C6ieFpjGx4qrB1HjvcfPoU0M7b7N+XJDFieLLZNdoRnL2Eo6WCJp2ieNFUaANT9IOp/b1qxnL2KL7bFDHLxDM8TV9suBrlrNbdsvip5TYb4gonm+Z4nrZ8CXRJ7E05HhDkRtOyPs4IbsHAnbSJYejMyGhX8J1kuFTSsVvcfPZjjy9eStD59qemsIzb9v2d/SZiGg=",sidebar_class_name:"put api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get Template",permalink:"/docs/API-docs/get-template"},next:{title:"Delete Template",permalink:"/docs/API-docs/delete-template"}},g={},f=[{value:"Request",id:"request",level:2}];function v(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:"Update Template"})}),"\n",(0,l.jsx)(r(),{method:"put",path:"/template/{template_id}"}),"\n",(0,l.jsx)(a.p,{children:"The Update Template API enables you to modify and update the details of a specific template."}),"\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)(o.Z,{className:"paramsItem",param:{name:"template_id",in:"path",description:"ID of the template that needs to be updated",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string"}}})})})]}),"\n",(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json-schema",children:(0,l.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,l.jsx)(a.p,{children:"Body"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,l.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:(0,l.jsx)(a.p,{children:"Provide below parameter to update templates (at least one parameter required)"})})}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"sample template"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please review and sign this document"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"template description"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"folderId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:""}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableOTP",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable OTP verification. Users will receive a verification code via email, which they must enter to sign the document. false - this option will disable OTP verification, allowing users to sign the document directly without additional steps.",example:!1}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"enableTour",required:!1,schemaName:"boolean",qualifierMessage:void 0,schema:{type:"boolean",description:"true - this option will enable a guided tour for signers, providing instructions during the signing process. false - disable the guided tour, ensuring a faster, uninterrupted signing experience.",example:!1}})]})]})})}),"\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)(a.p,{children:"Template updated successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"asd2HsP4Hp"}}),(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)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "objectId": "asd2HsP4Hp",\n "updatedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"400",value:"400",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Please provide valid field names!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Please provide valid field names!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Please provide valid field names!"\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(h.default,{label:"404",value:"404",children:[(0,l.jsx)("div",{children:(0,l.jsx)(a.p,{children:"Template not found!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Template not found!"}})})]})}),(0,l.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(p.Z,{responseExample:'{\n "error": "Template 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)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(c.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)(m.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)(p.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:a}={...(0,i.a)(),...e.components};return a?(0,l.jsx)(a,{...e,children:(0,l.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink