|
| 1 | +# pylint: disable=duplicate-code |
| 2 | +import os |
| 3 | + |
| 4 | +from python_anvil.api import Anvil |
| 5 | +from python_anvil.api_resources.mutations.create_etch_packet import CreateEtchPacket |
| 6 | +from python_anvil.api_resources.payload import ( |
| 7 | + DocumentUpload, |
| 8 | + EtchSigner, |
| 9 | + SignatureField, |
| 10 | + SignerField, |
| 11 | +) |
| 12 | + |
| 13 | + |
| 14 | +API_KEY = os.environ.get("ANVIL_API_KEY") |
| 15 | +# or set your own key here |
| 16 | +# API_KEY = 'my-api-key' |
| 17 | + |
| 18 | + |
| 19 | +def main(): |
| 20 | + anvil = Anvil(api_key=API_KEY) |
| 21 | + |
| 22 | + # Create an instance of the builder |
| 23 | + packet = CreateEtchPacket( |
| 24 | + name="Etch packet with existing template multipart", |
| 25 | + # |
| 26 | + # Optional changes to email subject and body content |
| 27 | + signature_email_subject="Please sign these forms", |
| 28 | + signature_email_body="This form requires information from your driver's " |
| 29 | + "license. Please have that available.", |
| 30 | + # |
| 31 | + # URL where Anvil will send POST requests when server events happen. |
| 32 | + # Take a look at https://www.useanvil.com/docs/api/e-signatures#webhook-notifications |
| 33 | + # for other details on how to configure webhooks on your account. |
| 34 | + # You can also use sites like webhook.site, requestbin.com or ngrok to |
| 35 | + # test webhooks. |
| 36 | + # webhook_url="https://my.webhook.example.com/etch-events/", |
| 37 | + # |
| 38 | + # Email overrides for the "reply-to" email header for signer emails. |
| 39 | + # If used, both `reply_to_email` and `reply_to_name` are required. |
| 40 | + # By default, this will point to your organization support email. |
| 41 | + # reply_to_email="[email protected]", |
| 42 | + # reply_to_name="My Name", |
| 43 | + # |
| 44 | + # Merge all PDFs into one. Use this if you have many PDF templates |
| 45 | + # and/or files, but want the final downloaded package to be only |
| 46 | + # 1 PDF file. |
| 47 | + # merge_pdfs=True, |
| 48 | + ) |
| 49 | + |
| 50 | + # Get your file(s) ready to sign. |
| 51 | + # For this example, the PDF hasn't been uploaded to Anvil yet. |
| 52 | + # In the `create_etch_upload_file.py` example, we are base64 encoding our |
| 53 | + # file(s) before sending. In this case, we will be providing a file's path |
| 54 | + # or file descriptor (from an `open()` call) |
| 55 | + filename = "my_local_file.pdf" |
| 56 | + file_dir = os.path.dirname(os.path.realpath(__file__)) |
| 57 | + file_path = os.path.join(file_dir, filename) |
| 58 | + |
| 59 | + # You can check manually if your file exists, however, the validator being |
| 60 | + # used in the `GraphqlUpload` below will also check if the file exists. |
| 61 | + # |
| 62 | + # if not os.path.exists(file_path): |
| 63 | + # raise FileNotFoundError('File does not exist. Please check `file_path` ' |
| 64 | + # 'and ensure it points to an existing file.') |
| 65 | + |
| 66 | + # Upload the file and define signer field locations. |
| 67 | + file1 = DocumentUpload( |
| 68 | + id="myNewFile", |
| 69 | + title="Please sign this important form", |
| 70 | + # You can send a callable that returns a file handle and the filename |
| 71 | + # you want to use in the Anvil app. |
| 72 | + # (IMPORTANT: The data must be read in as _bytes_, not text.) |
| 73 | + file=lambda: ( |
| 74 | + open(file_path, "rb"), # pylint: disable=consider-using-with |
| 75 | + filename, |
| 76 | + ), |
| 77 | + # or just the valid path itself |
| 78 | + # file=file_path, |
| 79 | + fields=[ |
| 80 | + SignatureField( |
| 81 | + id="sign1", |
| 82 | + type="signature", |
| 83 | + page_num=0, |
| 84 | + # The position and size of the field. The coordinates provided here |
| 85 | + # (x=100, y=100) is the top-left of the rectangle. |
| 86 | + rect=dict(x=183, y=100, width=250, height=50), |
| 87 | + ) |
| 88 | + ], |
| 89 | + ) |
| 90 | + |
| 91 | + # Gather your signer data |
| 92 | + signer1 = EtchSigner( |
| 93 | + name="Jackie", |
| 94 | + |
| 95 | + # Fields where the signer needs to sign. |
| 96 | + # Check your cast fields via the CLI (`anvil cast [cast_eid]`) or the |
| 97 | + # PDF Templates section on the Anvil app. |
| 98 | + # This basically says: "In the 'myNewFile' file (defined in |
| 99 | + # `file1` above), assign the signature field with cast id of |
| 100 | + # 'sign1' to this signer." You can add multiple signer fields here. |
| 101 | + fields=[ |
| 102 | + SignerField( |
| 103 | + # this is the `id` in the `DocumentUpload` object above |
| 104 | + file_id="myNewFile", |
| 105 | + # This is the signing field id in the `SignatureField` above |
| 106 | + field_id="sign1", |
| 107 | + ) |
| 108 | + ], |
| 109 | + signer_type="embedded", |
| 110 | + # |
| 111 | + # You can also change how signatures will be collected. |
| 112 | + # "draw" will allow the signer to draw their signature |
| 113 | + # "text" will insert a text version of the signer's name into the |
| 114 | + # signature field. |
| 115 | + # signature_mode="draw", |
| 116 | + # |
| 117 | + # Whether to the signer is required to click each signature |
| 118 | + # field manually. If `False`, the PDF will be signed once the signer |
| 119 | + # accepts the PDF without making the user go through the PDF. |
| 120 | + # accept_each_field=False, |
| 121 | + # |
| 122 | + # URL of where the signer will be redirected after signing. |
| 123 | + # The URL will also have certain URL params added on, so the page |
| 124 | + # can be customized based on the signing action. |
| 125 | + # redirect_url="https://www.google.com", |
| 126 | + ) |
| 127 | + |
| 128 | + # Add your signer. |
| 129 | + packet.add_signer(signer1) |
| 130 | + |
| 131 | + # Add files to your payload |
| 132 | + packet.add_file(file1) |
| 133 | + |
| 134 | + # If needed, you can also override or add additional payload fields this way. |
| 135 | + # This is useful if the Anvil API has new features, but `python-anvil` has not |
| 136 | + # yet been updated to support it. |
| 137 | + # payload = packet.create_payload() |
| 138 | + # payload.aNewFeature = True |
| 139 | + |
| 140 | + # Create your packet |
| 141 | + # If overriding/adding new fields, use the modified payload from |
| 142 | + # `packet.create_payload()` |
| 143 | + res = anvil.create_etch_packet(payload=packet, include_headers=True) |
| 144 | + print(res) |
| 145 | + |
| 146 | + |
| 147 | +if __name__ == '__main__': |
| 148 | + main() |
0 commit comments