[skip ci] Updates

move-coop · Sep 8, 2023 · 75228db · 75228db
1 parent fbad0b7
commit 75228db
Show file tree

Hide file tree

Showing 395 changed files with 159 additions and 43 deletions.
diff --git a/html/latest/.buildinfo b/html/latest/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 24da10602a5ba1b5c5d310847a2fd410
+config: 92a4636e4e974db7d3bef726eab5cd2d
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/html/latest/.doctrees/actblue.doctree b/html/latest/.doctrees/actblue.doctree
diff --git a/html/latest/.doctrees/action_builder.doctree b/html/latest/.doctrees/action_builder.doctree
diff --git a/html/latest/.doctrees/action_kit.doctree b/html/latest/.doctrees/action_kit.doctree
diff --git a/html/latest/.doctrees/action_network.doctree b/html/latest/.doctrees/action_network.doctree
diff --git a/html/latest/.doctrees/airtable.doctree b/html/latest/.doctrees/airtable.doctree
diff --git a/html/latest/.doctrees/alchemer.doctree b/html/latest/.doctrees/alchemer.doctree
diff --git a/html/latest/.doctrees/auth0.doctree b/html/latest/.doctrees/auth0.doctree
diff --git a/html/latest/.doctrees/aws.doctree b/html/latest/.doctrees/aws.doctree
diff --git a/html/latest/.doctrees/azure.doctree b/html/latest/.doctrees/azure.doctree
diff --git a/html/latest/.doctrees/bill_com.doctree b/html/latest/.doctrees/bill_com.doctree
diff --git a/html/latest/.doctrees/bloomerang.doctree b/html/latest/.doctrees/bloomerang.doctree
diff --git a/html/latest/.doctrees/bluelink.doctree b/html/latest/.doctrees/bluelink.doctree
diff --git a/html/latest/.doctrees/box.doctree b/html/latest/.doctrees/box.doctree
diff --git a/html/latest/.doctrees/braintree.doctree b/html/latest/.doctrees/braintree.doctree
diff --git a/html/latest/.doctrees/build_a_connector.doctree b/html/latest/.doctrees/build_a_connector.doctree
diff --git a/html/latest/.doctrees/capitolcanary.doctree b/html/latest/.doctrees/capitolcanary.doctree
diff --git a/html/latest/.doctrees/census_geocoder.doctree b/html/latest/.doctrees/census_geocoder.doctree
diff --git a/html/latest/.doctrees/civis.doctree b/html/latest/.doctrees/civis.doctree
diff --git a/html/latest/.doctrees/contributing.doctree b/html/latest/.doctrees/contributing.doctree
diff --git a/html/latest/.doctrees/controlshift.doctree b/html/latest/.doctrees/controlshift.doctree
diff --git a/html/latest/.doctrees/copper.doctree b/html/latest/.doctrees/copper.doctree
diff --git a/html/latest/.doctrees/crowdtangle.doctree b/html/latest/.doctrees/crowdtangle.doctree
diff --git a/html/latest/.doctrees/databases.doctree b/html/latest/.doctrees/databases.doctree
diff --git a/html/latest/.doctrees/dbsync.doctree b/html/latest/.doctrees/dbsync.doctree
diff --git a/html/latest/.doctrees/donorbox.doctree b/html/latest/.doctrees/donorbox.doctree
diff --git a/html/latest/.doctrees/environment.pickle b/html/latest/.doctrees/environment.pickle
diff --git a/html/latest/.doctrees/facebook_ads.doctree b/html/latest/.doctrees/facebook_ads.doctree
diff --git a/html/latest/.doctrees/freshdesk.doctree b/html/latest/.doctrees/freshdesk.doctree
diff --git a/html/latest/.doctrees/github.doctree b/html/latest/.doctrees/github.doctree
diff --git a/html/latest/.doctrees/google.doctree b/html/latest/.doctrees/google.doctree
diff --git a/html/latest/.doctrees/hustle.doctree b/html/latest/.doctrees/hustle.doctree
diff --git a/html/latest/.doctrees/index.doctree b/html/latest/.doctrees/index.doctree
diff --git a/html/latest/.doctrees/mailchimp.doctree b/html/latest/.doctrees/mailchimp.doctree
diff --git a/html/latest/.doctrees/mobilize_america.doctree b/html/latest/.doctrees/mobilize_america.doctree
diff --git a/html/latest/.doctrees/nation_builder.doctree b/html/latest/.doctrees/nation_builder.doctree
diff --git a/html/latest/.doctrees/newmode.doctree b/html/latest/.doctrees/newmode.doctree
diff --git a/html/latest/.doctrees/ngpvan.doctree b/html/latest/.doctrees/ngpvan.doctree
diff --git a/html/latest/.doctrees/notifications.doctree b/html/latest/.doctrees/notifications.doctree
diff --git a/html/latest/.doctrees/p2a.doctree b/html/latest/.doctrees/p2a.doctree
diff --git a/html/latest/.doctrees/pdi.doctree b/html/latest/.doctrees/pdi.doctree
diff --git a/html/latest/.doctrees/quickbase.doctree b/html/latest/.doctrees/quickbase.doctree
diff --git a/html/latest/.doctrees/redash.doctree b/html/latest/.doctrees/redash.doctree
diff --git a/html/latest/.doctrees/rockthevote.doctree b/html/latest/.doctrees/rockthevote.doctree
diff --git a/html/latest/.doctrees/salesforce.doctree b/html/latest/.doctrees/salesforce.doctree
diff --git a/html/latest/.doctrees/scytl.doctree b/html/latest/.doctrees/scytl.doctree
diff --git a/html/latest/.doctrees/sftp.doctree b/html/latest/.doctrees/sftp.doctree
diff --git a/html/latest/.doctrees/shopify.doctree b/html/latest/.doctrees/shopify.doctree
diff --git a/html/latest/.doctrees/sisense.doctree b/html/latest/.doctrees/sisense.doctree
diff --git a/html/latest/.doctrees/table.doctree b/html/latest/.doctrees/table.doctree
diff --git a/html/latest/.doctrees/targetsmart.doctree b/html/latest/.doctrees/targetsmart.doctree
diff --git a/html/latest/.doctrees/targetsmart_api.doctree b/html/latest/.doctrees/targetsmart_api.doctree
diff --git a/html/latest/.doctrees/targetsmart_automation_workflows.doctree b/html/latest/.doctrees/targetsmart_automation_workflows.doctree
diff --git a/html/latest/.doctrees/training_guides/etl_best_practices.doctree b/html/latest/.doctrees/training_guides/etl_best_practices.doctree
diff --git a/html/latest/.doctrees/training_guides/getting_set_up.doctree b/html/latest/.doctrees/training_guides/getting_set_up.doctree
diff --git a/html/latest/.doctrees/turbovote.doctree b/html/latest/.doctrees/turbovote.doctree
diff --git a/html/latest/.doctrees/twilio.doctree b/html/latest/.doctrees/twilio.doctree
diff --git a/html/latest/.doctrees/use_cases/civis_job_status_slack_alert.doctree b/html/latest/.doctrees/use_cases/civis_job_status_slack_alert.doctree
diff --git a/html/latest/.doctrees/use_cases/contribute_use_cases.doctree b/html/latest/.doctrees/use_cases/contribute_use_cases.doctree
diff --git a/html/latest/.doctrees/use_cases/mysql_to_googlesheets.doctree b/html/latest/.doctrees/use_cases/mysql_to_googlesheets.doctree
diff --git a/html/latest/.doctrees/use_cases/opt_outs_to_everyaction.doctree b/html/latest/.doctrees/use_cases/opt_outs_to_everyaction.doctree
diff --git a/html/latest/.doctrees/utilities.doctree b/html/latest/.doctrees/utilities.doctree
diff --git a/html/latest/.doctrees/write_tests.doctree b/html/latest/.doctrees/write_tests.doctree
diff --git a/html/latest/.doctrees/zoom.doctree b/html/latest/.doctrees/zoom.doctree
diff --git a/html/latest/_modules/parsons/action_kit/action_kit.html b/html/latest/_modules/parsons/action_kit/action_kit.html
@@ -371,6 +371,63 @@ <h1>Source code for parsons.action_kit.action_kit</h1><div class="highlight"><pr
         <span class="p">)</span>
         <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">resp</span><span class="o">.</span><span class="n">status_code</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">event_id</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span></div>
 
+<div class="viewcode-block" id="ActionKit.get_blackholed_email"><a class="viewcode-back" href="../../../action_kit.html#parsons.ActionKit.get_blackholed_email">[docs]</a>    <span class="k">def</span> <span class="nf">get_blackholed_email</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">email</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get a blackholed email. A blackholed email is an email that has been prevented from</span>
+<span class="sd">        receiving bulk and transactional emails from ActionKit. `Documentation &lt;https://\</span>
+<span class="sd">        docs.actionkit.com/docs/manual/guide/mailings_tools.html#blackhole&gt;`_.</span>
+
+<span class="sd">        `Args:`</span>
+<span class="sd">            email: str</span>
+<span class="sd">                Blackholed email of the record to get.</span>
+<span class="sd">        `Returns`:</span>
+<span class="sd">            Parsons.Table</span>
+<span class="sd">                The blackholed email data.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">paginated_get</span><span class="p">(</span><span class="s2">&quot;blackholedemail&quot;</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="n">email</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="ActionKit.blackhole_email"><a class="viewcode-back" href="../../../action_kit.html#parsons.ActionKit.blackhole_email">[docs]</a>    <span class="k">def</span> <span class="nf">blackhole_email</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">email</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Prevent an email from receiving bulk and transactional emails from ActionKit.</span>
+<span class="sd">        `Documentation &lt;https://docs.actionkit.com/docs/manual/guide/\</span>
+<span class="sd">        mailings_tools.html#blackhole&gt;`_.</span>
+
+<span class="sd">        `Args:`</span>
+<span class="sd">            user_id: str</span>
+<span class="sd">                Email to blackhole</span>
+<span class="sd">        `Returns:`</span>
+<span class="sd">            API location of new resource</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_post</span><span class="p">(</span>
+            <span class="n">endpoint</span><span class="o">=</span><span class="s2">&quot;blackholedemail&quot;</span><span class="p">,</span>
+            <span class="n">exception_message</span><span class="o">=</span><span class="s2">&quot;Could not blackhole email&quot;</span><span class="p">,</span>
+            <span class="n">email</span><span class="o">=</span><span class="n">email</span><span class="p">,</span>
+        <span class="p">)</span></div>
+
+<div class="viewcode-block" id="ActionKit.delete_user_data"><a class="viewcode-back" href="../../../action_kit.html#parsons.ActionKit.delete_user_data">[docs]</a>    <span class="k">def</span> <span class="nf">delete_user_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">email</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Delete user data.</span>
+
+<span class="sd">        `Args:`</span>
+<span class="sd">            email: str</span>
+<span class="sd">                Email of user to delete data</span>
+<span class="sd">            **kwargs:</span>
+<span class="sd">                Optional arguments and fields to pass to the client. A full list can be found</span>
+<span class="sd">                in the `ActionKit API Documentation &lt;https://docs.actionkit.com/docs/manual/api/\</span>
+<span class="sd">                rest/users.html&gt;`_.</span>
+<span class="sd">        `Returns:`</span>
+<span class="sd">            API location of anonymized user</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_base_post</span><span class="p">(</span>
+            <span class="n">endpoint</span><span class="o">=</span><span class="s2">&quot;eraser&quot;</span><span class="p">,</span>
+            <span class="n">exception_message</span><span class="o">=</span><span class="s2">&quot;Could not delete user data&quot;</span><span class="p">,</span>
+            <span class="n">email</span><span class="o">=</span><span class="n">email</span><span class="p">,</span>
+            <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
+        <span class="p">)</span></div>
+
 <div class="viewcode-block" id="ActionKit.delete_user"><a class="viewcode-back" href="../../../action_kit.html#parsons.ActionKit.delete_user">[docs]</a>    <span class="k">def</span> <span class="nf">delete_user</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_id</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Delete a user.</span>
@@ -995,7 +1052,7 @@ <h1>Source code for parsons.action_kit.action_kit</h1><div class="highlight"><pr
 <span class="sd">                    ak.get_orders(import_id=&quot;my-import-123&quot;)</span>
 <span class="sd">        `Returns:`</span>
 <span class="sd">            Parsons.Table</span>
-<span class="sd">                The events data.</span>
+<span class="sd">                The orders data.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">paginated_get</span><span class="p">(</span><span class="s2">&quot;order&quot;</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
 
@@ -1172,7 +1229,7 @@ <h1>Source code for parsons.action_kit.action_kit</h1><div class="highlight"><pr
 <span class="sd">                    ak.get_transactions(order=&quot;order-1&quot;)</span>
 <span class="sd">        `Returns:`</span>
 <span class="sd">            Parsons.Table</span>
-<span class="sd">                The events data.</span>
+<span class="sd">                The transactions data.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">paginated_get</span><span class="p">(</span><span class="s2">&quot;transaction&quot;</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="n">limit</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>