python-terminusgps 31.7.2__tar.gz → 31.8.0__tar.gz

{python_terminusgps-31.7.2 → python_terminusgps-31.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 31.7.2
+Version: 31.8.0
 Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
 Project-URL: Documentation, https://docs.terminusgps.com
 Project-URL: Repository, https://github.com/terminusgps/python-terminusgps

{python_terminusgps-31.7.2 → python_terminusgps-31.8.0}/docs/build/html/_modules/index.html

@@ -12,9 +12,9 @@
   <meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
   <meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />
   
-    <title>Overview: module code | python-terminusgps 31.7.2 documentation</title>
-    <meta property="og:title" content="Overview: module code | python-terminusgps 31.7.2 documentation" />
-    <meta name="twitter:title" content="Overview: module code | python-terminusgps 31.7.2 documentation" />
+    <title>Overview: module code | python-terminusgps 31.8.0 documentation</title>
+    <meta property="og:title" content="Overview: module code | python-terminusgps 31.8.0 documentation" />
+    <meta name="twitter:title" content="Overview: module code | python-terminusgps 31.8.0 documentation" />
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d691ff6c" />
       <link rel="stylesheet" type="text/css" href="../_static/theme.css?v=42baaae4" />
       <link rel="stylesheet" type="text/css" href="../_static/autoclasstoc.css?v=08871587" />
@@ -40,7 +40,7 @@
     </a><header
   class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
     <div class="hidden mr-4 md:flex">
-      <a href="../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 31.7.2 documentation</span>
+      <a href="../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 31.8.0 documentation</span>
       </a></div><button
       class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
       type="button" @click="showSidebar = true">
@@ -95,7 +95,7 @@
   class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
   :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">
 
-    <a href="../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 31.7.2 documentation</span>
+    <a href="../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 31.8.0 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
@@ -153,7 +153,7 @@
      class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
   <a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
      href="../index.html">
-    <span class="hidden md:inline">python-terminusgps 31.7.2 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 31.8.0 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -210,7 +210,7 @@
 </footer>
   </div>
   
-    <script src="../_static/documentation_options.js?v=3606676a"></script>
+    <script src="../_static/documentation_options.js?v=1395c69d"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script defer="defer" src="../_static/theme.js?v=073f68d9"></script>

{python_terminusgps-31.7.2 → python_terminusgps-31.8.0}/docs/build/html/_modules/terminusgps/authorizenet/utils.html

@@ -12,9 +12,9 @@
   <meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
   <meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />
   
-    <title>terminusgps.authorizenet.utils | python-terminusgps 31.6.0 documentation</title>
-    <meta property="og:title" content="terminusgps.authorizenet.utils | python-terminusgps 31.6.0 documentation" />
-    <meta name="twitter:title" content="terminusgps.authorizenet.utils | python-terminusgps 31.6.0 documentation" />
+    <title>terminusgps.authorizenet.utils | python-terminusgps 31.8.0 documentation</title>
+    <meta property="og:title" content="terminusgps.authorizenet.utils | python-terminusgps 31.8.0 documentation" />
+    <meta name="twitter:title" content="terminusgps.authorizenet.utils | python-terminusgps 31.8.0 documentation" />
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d691ff6c" />
       <link rel="stylesheet" type="text/css" href="../../../_static/theme.css?v=42baaae4" />
       <link rel="stylesheet" type="text/css" href="../../../_static/autoclasstoc.css?v=08871587" />
@@ -40,7 +40,7 @@
     </a><header
   class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
     <div class="hidden mr-4 md:flex">
-      <a href="../../../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 31.6.0 documentation</span>
+      <a href="../../../index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">python-terminusgps 31.8.0 documentation</span>
       </a></div><button
       class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
       type="button" @click="showSidebar = true">
@@ -95,7 +95,7 @@
   class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
   :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">
 
-    <a href="../../../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 31.6.0 documentation</span>
+    <a href="../../../index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">python-terminusgps 31.8.0 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
@@ -153,7 +153,7 @@
      class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
   <a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
      href="../../../index.html">
-    <span class="hidden md:inline">python-terminusgps 31.6.0 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 31.8.0 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -242,19 +242,46 @@
 
 </span><span id="line-57">
 </span><span id="line-58">
-</span><span id="line-59"><span class="k">def</span><span class="w"> </span><span class="nf">generate_customer_address</span><span class="p">(</span><span class="n">form</span><span class="p">:</span> <span class="n">forms</span><span class="o">.</span><span class="n">Form</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">customerAddressType</span><span class="p">:</span>
-</span><span id="line-60"><span class="w">    </span><span class="sd">&quot;&quot;&quot;Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`.&quot;&quot;&quot;</span>
-</span><span id="line-61">    <span class="n">address</span><span class="p">:</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">customerAddressType</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;address&quot;</span><span class="p">]</span>
-</span><span id="line-62">    <span class="n">address</span><span class="o">.</span><span class="n">firstName</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;first_name&quot;</span><span class="p">]</span>
-</span><span id="line-63">    <span class="n">address</span><span class="o">.</span><span class="n">lastName</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;last_name&quot;</span><span class="p">]</span>
-</span><span id="line-64">    <span class="n">address</span><span class="o">.</span><span class="n">phone</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;phone&quot;</span><span class="p">]</span>
-</span><span id="line-65">    <span class="k">return</span> <span class="n">address</span>
-</span><span id="line-66">
-</span><span id="line-67">
-</span><span id="line-68"><span class="k">def</span><span class="w"> </span><span class="nf">generate_customer_payment</span><span class="p">(</span><span class="n">form</span><span class="p">:</span> <span class="n">forms</span><span class="o">.</span><span class="n">Form</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">paymentType</span><span class="p">:</span>
-</span><span id="line-69"><span class="w">    </span><span class="sd">&quot;&quot;&quot;Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.paymentType`.&quot;&quot;&quot;</span>
-</span><span id="line-70">    <span class="n">credit_card</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;credit_card&quot;</span><span class="p">]</span>
-</span><span id="line-71">    <span class="k">return</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">paymentType</span><span class="p">(</span><span class="n">creditCard</span><span class="o">=</span><span class="n">credit_card</span><span class="p">)</span>
+</span><span id="line-59"><span class="k">def</span><span class="w"> </span><span class="nf">get_customer_profile_id</span><span class="p">(</span><span class="n">email</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-60"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-61"><span class="sd">    Retrieves an Authorizenet customer profile id by email address.</span>
+</span><span id="line-62">
+</span><span id="line-63"><span class="sd">    :param email: A customer email address.</span>
+</span><span id="line-64"><span class="sd">    :type email: :py:obj:`str`</span>
+</span><span id="line-65"><span class="sd">    :raises ControllerExecutionError: If something goes wrong with the Authorizenet API.</span>
+</span><span id="line-66"><span class="sd">    :returns: A customer profile id, if found.</span>
+</span><span id="line-67"><span class="sd">    :rtype: :py:obj:`int` | :py:obj:`None`</span>
+</span><span id="line-68">
+</span><span id="line-69"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-70">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getCustomerProfileRequest</span><span class="p">(</span>
+</span><span id="line-71">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</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="n">includeIssuerInfo</span><span class="o">=</span><span class="kc">False</span>
+</span><span id="line-72">    <span class="p">)</span>
+</span><span id="line-73">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getCustomerProfileController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
+</span><span id="line-74">    <span class="n">controller</span><span class="o">.</span><span class="n">setenvironment</span><span class="p">(</span><span class="n">get_environment</span><span class="p">())</span>
+</span><span id="line-75">    <span class="n">controller</span><span class="o">.</span><span class="n">execute</span><span class="p">()</span>
+</span><span id="line-76">    <span class="n">response</span> <span class="o">=</span> <span class="n">controller</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>
+</span><span id="line-77">
+</span><span id="line-78">    <span class="k">if</span> <span class="n">response</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">response</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">resultCode</span> <span class="o">!=</span> <span class="s2">&quot;Ok&quot;</span><span class="p">:</span>
+</span><span id="line-79">        <span class="k">raise</span> <span class="n">ControllerExecutionError</span><span class="p">(</span>
+</span><span id="line-80">            <span class="n">message</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">message</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s2">&quot;text&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">text</span><span class="p">,</span>
+</span><span id="line-81">            <span class="n">code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">message</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="s2">&quot;code&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">text</span><span class="p">,</span>
+</span><span id="line-82">        <span class="p">)</span>
+</span><span id="line-83">    <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">profile</span><span class="o">.</span><span class="n">customerProfileId</span><span class="p">)</span>
+</span><span id="line-84">
+</span><span id="line-85">
+</span><span id="line-86"><span class="k">def</span><span class="w"> </span><span class="nf">generate_customer_address</span><span class="p">(</span><span class="n">form</span><span class="p">:</span> <span class="n">forms</span><span class="o">.</span><span class="n">Form</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">customerAddressType</span><span class="p">:</span>
+</span><span id="line-87"><span class="w">    </span><span class="sd">&quot;&quot;&quot;Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`.&quot;&quot;&quot;</span>
+</span><span id="line-88">    <span class="n">address</span><span class="p">:</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">customerAddressType</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;address&quot;</span><span class="p">]</span>
+</span><span id="line-89">    <span class="n">address</span><span class="o">.</span><span class="n">firstName</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;first_name&quot;</span><span class="p">]</span>
+</span><span id="line-90">    <span class="n">address</span><span class="o">.</span><span class="n">lastName</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;last_name&quot;</span><span class="p">]</span>
+</span><span id="line-91">    <span class="n">address</span><span class="o">.</span><span class="n">phone</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;phone&quot;</span><span class="p">]</span>
+</span><span id="line-92">    <span class="k">return</span> <span class="n">address</span>
+</span><span id="line-93">
+</span><span id="line-94">
+</span><span id="line-95"><span class="k">def</span><span class="w"> </span><span class="nf">generate_customer_payment</span><span class="p">(</span><span class="n">form</span><span class="p">:</span> <span class="n">forms</span><span class="o">.</span><span class="n">Form</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">paymentType</span><span class="p">:</span>
+</span><span id="line-96"><span class="w">    </span><span class="sd">&quot;&quot;&quot;Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.paymentType`.&quot;&quot;&quot;</span>
+</span><span id="line-97">    <span class="n">credit_card</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="p">[</span><span class="s2">&quot;credit_card&quot;</span><span class="p">]</span>
+</span><span id="line-98">    <span class="k">return</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">paymentType</span><span class="p">(</span><span class="n">creditCard</span><span class="o">=</span><span class="n">credit_card</span><span class="p">)</span>
 </span></code></pre></div>
     </div></div>
         </main>
@@ -270,7 +297,7 @@
 </footer>
   </div>
   
-    <script src="../../../_static/documentation_options.js?v=d4532340"></script>
+    <script src="../../../_static/documentation_options.js?v=1395c69d"></script>
     <script src="../../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script defer="defer" src="../../../_static/theme.js?v=073f68d9"></script>