Clearer version number support, updates (anvilco#45)

aalmazan · web-flow · commit 7a351ca07c52 · 2023-01-25T23:03:05.000-08:00
* Really fix changelog

* Update cast api call, cli, docs

* Add additional variables for `createEtchPacket` mutation

* Add missing webhookURL on ForgeSubmit

* Add forgeSubmit example
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# 1.8.0 (2022-01-10)
+# 1.8.0 (2023-01-10)
 
 - Added support for multipart uploads on `CreateEtchPacket` requests.
 - New example for multipart uploads in `examples/create_etch_upload_file_multipart.py`
diff --git a/docs/api_usage.md b/docs/api_usage.md
@@ -119,6 +119,8 @@ casts, but this can be changed with the `fields` argument.
 
 * `eid` - The eid of the Cast
 * `fields` - (Optional) list of fields you want from the Cast instance.
+* `version_number` - (Optional) Version number of the cast to fill out. If this is not provided, the latest published
+  version will be used.
 
 ### Anvil.get_welds
 
diff --git a/examples/fill_pdf.py b/examples/fill_pdf.py
@@ -38,12 +38,15 @@ def main():
     # to a file.
     res = anvil.fill_pdf('abc123', data)
 
+    # Version number support
+    # ----------------------
     # A version number can also be passed in. This will retrieve a specific
     # version of the PDF to be filled if you don't want the current version
     # to be used.
-    # You can also use the constant `Anvil.VERSION_LATEST` to fill a PDF that has not
-    # been published yet. Use this if you'd like to fill out a draft version of
-    # your template/PDF.
+    #
+    # You can also use the constant `Anvil.VERSION_LATEST` to fill a PDF with
+    # your latest, unpublished changes. Use this if you'd like to fill out a
+    # draft version of your template/PDF.
     #
     # res = anvil.fill_pdf('abc123', data, version_number=Anvil.VERSION_LATEST)
 
diff --git a/examples/forge_submit.py b/examples/forge_submit.py
@@ -0,0 +1,33 @@
+import os
+
+from python_anvil.api import Anvil
+from python_anvil.api_resources.payload import ForgeSubmitPayload
+
+API_KEY = os.environ.get("ANVIL_API_KEY")
+# or set your own key here
+# API_KEY = 'my-api-key'
+
+
+def main():
+    anvil = Anvil(api_key=API_KEY)
+
+    # Your ForgeSubmit payload.
+    # In this example, we have a basic Webform containing a name and email field.
+    # For both fields, we are using the field's eid which can be found in the
+    # weld or forge GraphQL query.
+    # More info here: https://www.useanvil.com/docs/api/graphql/reference/#definition-Forge
+    payload = ForgeSubmitPayload(
+        forge_eid="myForgeEidHere",
+        payload=dict(
+            forge16401fc09c3e11ed85f5a91873b464b4="FirstName LastName",
+            forge1b57aeb09c3e11ed85f5a91873b464b4="myemail@example.com",
+        ),
+    )
+
+    # Submit the above payload
+    res = anvil.forge_submit(payload)
+    print(res)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/python_anvil/api.py b/python_anvil/api.py
@@ -146,14 +146,37 @@ def generate_pdf(self, payload: Union[AnyStr, Dict, GeneratePDFPayload], **kwarg
             "generate-pdf", data=data.dict(by_alias=True, exclude_none=True), **kwargs
         )
 
-    def get_cast(self, eid: str, fields=None, **kwargs):
+    def get_cast(
+        self,
+        eid: str,
+        fields: Optional[List[str]] = None,
+        version_number: Optional[int] = None,
+        cast_args: Optional[List[str]] = None,
+        **kwargs,
+    ):
+
         if not fields:
             # Use default fields
             fields = ['eid', 'title', 'fieldInfo']
 
+        if not cast_args:
+            cast_args = []
+
+        cast_args.append(('eid', f'"{eid}"'))
+
+        # If `version_number` isn't provided, the API will default to the
+        # latest published version.
+        if version_number:
+            cast_args.append(("versionNumber", str(version_number)))
+
+        arg_str = ""
+        if len(cast_args):
+            joined_args = [(":".join(arg)) for arg in cast_args]
+            arg_str = f"({','.join(joined_args)})"
+
         res = self.query(
             f"""{{
-              cast(eid: "{eid}") {{
+              cast {arg_str} {{
                 {" ".join(fields)}
               }}
             }}""",
diff --git a/python_anvil/api_resources/cast.py b/python_anvil/api_resources/cast.py
diff --git a/python_anvil/api_resources/mutations/create_etch_packet.py b/python_anvil/api_resources/mutations/create_etch_packet.py
@@ -56,6 +56,9 @@
     $replyToName: String,
     $replyToEmail: String,
     $data: JSON,
+    $enableEmails: JSON,
+    $createCastTemplatesFromUploads: Boolean,
+    $duplicateCasts: Boolean=false,
   ) {{
     createEtchPacket (
       name: $name,
@@ -71,7 +74,10 @@
       webhookURL: $webhookURL,
       replyToName: $replyToName,
       replyToEmail: $replyToEmail,
-      data: $data
+      data: $data,
+      enableEmails: $enableEmails,
+      createCastTemplatesFromUploads: $createCastTemplatesFromUploads,
+      duplicateCasts: $duplicateCasts
     )
         {query}
   }}
@@ -82,7 +88,7 @@ class CreateEtchPacket(BaseQuery):
     mutation = CREATE_ETCH_PACKET
     mutation_res_query = DEFAULT_RESPONSE_QUERY
 
-    def __init__(
+    def __init__(  # pylint: disable=too-many-locals
         self,
         name: Optional[str] = None,
         signature_email_subject: Optional[str] = None,
@@ -98,6 +104,9 @@ def __init__(
         reply_to_name: Optional[str] = None,
         reply_to_email: Optional[str] = None,
         merge_pdfs: Optional[bool] = None,
+        enable_emails: Optional[Union[bool, List[str]]] = None,
+        create_cast_templates_from_uploads: Optional[bool] = None,
+        duplicate_casts: Optional[bool] = None,
     ):
         # `name` is required when `payload` is not present.
         if not payload and not name:
@@ -120,6 +129,9 @@ def __init__(
         self.reply_to_name = reply_to_name
         self.reply_to_email = reply_to_email
         self.merge_pdfs = merge_pdfs
+        self.enable_emails = enable_emails
+        self.create_cast_templates_from_uploads = create_cast_templates_from_uploads
+        self.duplicate_casts = duplicate_casts
 
     @classmethod
     def create_from_dict(cls, payload: Dict) -> 'CreateEtchPacket':
@@ -268,6 +280,9 @@ def create_payload(self) -> Tuple[CreateEtchPacketPayload, List]:
             reply_to_email=self.reply_to_email,
             reply_to_name=self.reply_to_name,
             merge_pdfs=self.merge_pdfs,
+            enable_emails=self.enable_emails,
+            create_cast_templates_from_uploads=self.create_cast_templates_from_uploads,
+            duplicate_casts=self.duplicate_casts,
         )
 
         return payload, file_refs
diff --git a/python_anvil/api_resources/mutations/forge_submit.py b/python_anvil/api_resources/mutations/forge_submit.py
@@ -48,6 +48,7 @@
     $groupArrayId: String,
     $groupArrayIndex: Int,
     $errorType: String,
+    $webhookURL: String,
 ) {{
     forgeSubmit (
         forgeEid: $forgeEid,
@@ -60,7 +61,8 @@
         timezone: $timezone,
         groupArrayId: $groupArrayId,
         groupArrayIndex: $groupArrayIndex,
-        errorType: $errorType
+        errorType: $errorType,
+        webhookURL: $webhookURL
     ) {query}
 }}
 """
diff --git a/python_anvil/api_resources/payload.py b/python_anvil/api_resources/payload.py
@@ -230,6 +230,9 @@ class CreateEtchPacketPayload(BaseModel):
     webhook_url: Optional[str] = Field(None, alias="webhookURL")
     reply_to_name: Optional[Any] = None
     reply_to_email: Optional[Any] = None
+    enable_emails: Optional[Union[bool, List[str]]] = None
+    create_cast_templates_from_uploads: Optional[bool] = None
+    duplicate_casts: Optional[bool] = None
 
 
 class ForgeSubmitPayload(BaseModel):
diff --git a/python_anvil/cli.py b/python_anvil/cli.py
@@ -125,18 +125,19 @@ def weld(ctx, eid, list_all):
 @click.option(
     "-a", "--all", "list_all", help="List all casts, even non-templates", is_flag=True
 )
+@click.option("--version_number", help="Get the specified version of this cast")
 @click.argument("eid", default="")
 @click.pass_context
-def cast(ctx, eid, list_all, list_templates):
+def cast(ctx, eid, version_number, list_all, list_templates):
     """Fetch Cast data given a Cast eid."""
-    anvil = ctx.obj["anvil"]
+    anvil = ctx.obj["anvil"]  # type: Anvil
     debug = ctx.obj["debug"]
 
     if not eid and not (list_templates or list_all):
         raise AssertionError("Cast eid or --list/--all option required")
 
     if list_all or list_templates:
-        res = anvil.get_casts(debug=debug, show_all=list_all)
+        res = anvil.get_casts(show_all=list_all, debug=debug)
 
         if contains_headers(res):
             res, headers = process_response(res)
@@ -149,7 +150,7 @@ def cast(ctx, eid, list_all, list_templates):
 
     if eid:
         click.echo(f"Getting cast with eid '{eid}' \n")
-        res = anvil.get_cast(eid, debug=debug)
+        res = anvil.get_cast(eid, version_number=version_number, debug=debug)
 
         if contains_headers(res):
             res, headers = process_response(res)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# 1.8.0 (2022-01-10)`
	`1`	`+# 1.8.0 (2023-01-10)`
`2`	`2`
`3`	`3`	- Added support for multipart uploads on `CreateEtchPacket` requests.
`4`	`4`	- New example for multipart uploads in `examples/create_etch_upload_file_multipart.py`