|
| 1 | +""" Example 045: Delete and Restore an Envelope """ |
| 2 | + |
| 3 | +from os import path |
| 4 | + |
| 5 | +from docusign_esign.client.api_exception import ApiException |
| 6 | +from flask import render_template, session, Blueprint, request, redirect |
| 7 | + |
| 8 | +from ..examples.eg045_delete_restore_envelope import Eg045DeleteRestoreEnvelopeController |
| 9 | +from ...docusign import authenticate, ensure_manifest, get_example_by_number |
| 10 | +from ...ds_config import DS_CONFIG |
| 11 | +from ...error_handlers import process_error |
| 12 | +from ...consts import pattern, API_TYPE |
| 13 | + |
| 14 | +example_number = 45 |
| 15 | +api = API_TYPE["ESIGNATURE"] |
| 16 | +eg = f"eg0{example_number}" # reference (and url) for this example |
| 17 | +restore_endpoint = f"{eg}restore" |
| 18 | +delete_folder_id = "recyclebin" |
| 19 | +restore_folder_id = "sentitems" |
| 20 | +eg045 = Blueprint(eg, __name__) |
| 21 | + |
| 22 | +@eg045.route(f"/{eg}", methods=["POST"]) |
| 23 | +@authenticate(eg=eg, api=api) |
| 24 | +@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"]) |
| 25 | +def delete_envelope(): |
| 26 | + """ |
| 27 | + 1. Get required arguments |
| 28 | + 2. Call the worker method |
| 29 | + 3. Render success response |
| 30 | + """ |
| 31 | + |
| 32 | + # 1. Get required arguments |
| 33 | + args = { |
| 34 | + "account_id": session["ds_account_id"], |
| 35 | + "base_path": session["ds_base_path"], |
| 36 | + "access_token": session["ds_access_token"], |
| 37 | + "envelope_id": pattern.sub("", request.form.get("envelope_id")), |
| 38 | + "folder_id": delete_folder_id |
| 39 | + } |
| 40 | + try: |
| 41 | + # 2. Call the worker method |
| 42 | + Eg045DeleteRestoreEnvelopeController.move_envelope(args) |
| 43 | + except ApiException as err: |
| 44 | + return process_error(err) |
| 45 | + |
| 46 | + session["envelope_id"] = args["envelope_id"] # Save for use by second part of example |
| 47 | + |
| 48 | + # 3. Render success response |
| 49 | + example = get_example_by_number(session["manifest"], example_number, api) |
| 50 | + additional_page_data = next( |
| 51 | + (p for p in example["AdditionalPage"] if p["Name"] == "envelope_is_deleted"), |
| 52 | + None |
| 53 | + ) |
| 54 | + return render_template( |
| 55 | + "example_done.html", |
| 56 | + title=example["ExampleName"], |
| 57 | + message=additional_page_data["ResultsPageText"], |
| 58 | + redirect_url=restore_endpoint |
| 59 | + ) |
| 60 | + |
| 61 | +@eg045.route(f"/{restore_endpoint}", methods=["POST"]) |
| 62 | +@authenticate(eg=eg, api=api) |
| 63 | +@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"]) |
| 64 | +def restore_envelope(): |
| 65 | + """ |
| 66 | + 1. Get required arguments |
| 67 | + 2. Call the worker method |
| 68 | + 3. Render success response |
| 69 | + """ |
| 70 | + |
| 71 | + # 1. Get required arguments |
| 72 | + args = { |
| 73 | + "account_id": session["ds_account_id"], |
| 74 | + "base_path": session["ds_base_path"], |
| 75 | + "access_token": session["ds_access_token"], |
| 76 | + "envelope_id": pattern.sub("", session.get("envelope_id")), |
| 77 | + "folder_id": restore_folder_id, |
| 78 | + "from_folder_id": delete_folder_id |
| 79 | + } |
| 80 | + try: |
| 81 | + # 2. Call the worker method |
| 82 | + Eg045DeleteRestoreEnvelopeController.move_envelope(args) |
| 83 | + except ApiException as err: |
| 84 | + return process_error(err) |
| 85 | + |
| 86 | + # 3. Render success response with envelopeId |
| 87 | + example = get_example_by_number(session["manifest"], example_number, api) |
| 88 | + return render_template( |
| 89 | + "example_done.html", |
| 90 | + title=example["ExampleName"], |
| 91 | + message=example["ResultsPageText"] |
| 92 | + ) |
| 93 | + |
| 94 | +@eg045.route(f"/{eg}", methods=["GET"]) |
| 95 | +@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"]) |
| 96 | +@authenticate(eg=eg, api=api) |
| 97 | +def get_view(): |
| 98 | + """responds with the form for the example""" |
| 99 | + example = get_example_by_number(session["manifest"], example_number, api) |
| 100 | + |
| 101 | + return render_template( |
| 102 | + "eSignature/eg045_delete_envelope.html", |
| 103 | + title=example["ExampleName"], |
| 104 | + example=example, |
| 105 | + envelope_id=session.get("envelope_id", ""), |
| 106 | + submit_button_text=session["manifest"]["SupportingTexts"]["HelpingTexts"]["SubmitButtonDeleteText"], |
| 107 | + source_file="eg045_delete_restore_envelope.py", |
| 108 | + source_url=DS_CONFIG["github_example_url"] + "eg045_delete_restore_envelope.py", |
| 109 | + documentation=DS_CONFIG["documentation"] + eg, |
| 110 | + show_doc=DS_CONFIG["documentation"], |
| 111 | + signer_name=DS_CONFIG["signer_name"], |
| 112 | + signer_email=DS_CONFIG["signer_email"] |
| 113 | + ) |
| 114 | + |
| 115 | +@eg045.route(f"/{restore_endpoint}", methods=["GET"]) |
| 116 | +@ensure_manifest(manifest_url=DS_CONFIG["example_manifest_url"]) |
| 117 | +@authenticate(eg=eg, api=api) |
| 118 | +def get_restore_view(): |
| 119 | + """responds with the form for the example""" |
| 120 | + example = get_example_by_number(session["manifest"], example_number, api) |
| 121 | + |
| 122 | + if not session.get("envelope_id"): |
| 123 | + return redirect(eg) |
| 124 | + |
| 125 | + return render_template( |
| 126 | + "eSignature/eg045_restore_envelope.html", |
| 127 | + title=example["ExampleName"], |
| 128 | + example=example, |
| 129 | + envelope_id=session.get("envelope_id"), |
| 130 | + submit_button_text=session["manifest"]["SupportingTexts"]["HelpingTexts"]["SubmitButtonRestoreText"], |
| 131 | + source_file="eg045_delete_restore_envelope.py", |
| 132 | + source_url=DS_CONFIG["github_example_url"] + "eg045_delete_restore_envelope.py", |
| 133 | + documentation=DS_CONFIG["documentation"] + eg, |
| 134 | + show_doc=DS_CONFIG["documentation"], |
| 135 | + signer_name=DS_CONFIG["signer_name"], |
| 136 | + signer_email=DS_CONFIG["signer_email"] |
| 137 | + ) |
0 commit comments