python-terminusgps 36.9.0__tar.gz → 36.9.1__tar.gz

{python_terminusgps-36.9.0 → python_terminusgps-36.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-terminusgps
-Version: 36.9.0
+Version: 36.9.1
 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-36.9.0 → python_terminusgps-36.9.1}/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 36.9.0 documentation</title>
-    <meta property="og:title" content="Overview: module code | python-terminusgps 36.9.0 documentation" />
-    <meta name="twitter:title" content="Overview: module code | python-terminusgps 36.9.0 documentation" />
+    <title>Overview: module code | python-terminusgps 36.9.1 documentation</title>
+    <meta property="og:title" content="Overview: module code | python-terminusgps 36.9.1 documentation" />
+    <meta name="twitter:title" content="Overview: module code | python-terminusgps 36.9.1 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 36.9.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 36.9.1 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 36.9.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 36.9.1 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
@@ -158,7 +158,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 36.9.0 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 36.9.1 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -220,7 +220,7 @@
 </footer>
   </div>
   
-    <script src="../_static/documentation_options.js?v=fd833ad5"></script>
+    <script src="../_static/documentation_options.js?v=59fbbecc"></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-36.9.0 → python_terminusgps-36.9.1}/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 36.9.0 documentation</title>
-    <meta property="og:title" content="terminusgps.authorizenet.utils | python-terminusgps 36.9.0 documentation" />
-    <meta name="twitter:title" content="terminusgps.authorizenet.utils | python-terminusgps 36.9.0 documentation" />
+    <title>terminusgps.authorizenet.utils | python-terminusgps 36.9.1 documentation</title>
+    <meta property="og:title" content="terminusgps.authorizenet.utils | python-terminusgps 36.9.1 documentation" />
+    <meta name="twitter:title" content="terminusgps.authorizenet.utils | python-terminusgps 36.9.1 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 36.9.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 36.9.1 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 36.9.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 36.9.1 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
@@ -158,7 +158,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 36.9.0 documentation</span>
+    <span class="hidden md:inline">python-terminusgps 36.9.1 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -203,198 +203,143 @@
 </span><span id="line-21"><span class="sd">    &quot;&quot;&quot;</span>
 </span><span id="line-22">    <span class="k">return</span> <span class="p">(</span><span class="n">end_date</span> <span class="o">-</span> <span class="n">start_date</span><span class="p">)</span><span class="o">.</span><span class="n">days</span>
 </span><span id="line-23">
-</span><span id="line-24">
-</span><span id="line-25"><span class="k">def</span><span class="w"> </span><span class="nf">get_payment_profile_transactions</span><span class="p">(</span>
-</span><span id="line-26">    <span class="n">customer_profile_id</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
-</span><span id="line-27">    <span class="n">payment_profile_id</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
-</span><span id="line-28">    <span class="n">descending</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
-</span><span id="line-29">    <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">100</span><span class="p">,</span>
-</span><span id="line-30">    <span class="n">offset</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
-</span><span id="line-31"><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-32"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-33"><span class="sd">    Returns a transaction list for a customer payment profile.</span>
-</span><span id="line-34">
-</span><span id="line-35"><span class="sd">    `getTransactionListForCustomerRequest &lt;https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-customer-profile-transaction-list&gt;`_</span>
-</span><span id="line-36">
-</span><span id="line-37"><span class="sd">    :param customer_profile_id: A customer profile id.</span>
-</span><span id="line-38"><span class="sd">    :type customer_profile_id: :py:obj:`int` | :py:obj:`str`</span>
-</span><span id="line-39"><span class="sd">    :param payment_profile_id: A customer payment profile id.</span>
-</span><span id="line-40"><span class="sd">    :type payment_profile_id: :py:obj:`int` | :py:obj:`str`</span>
-</span><span id="line-41"><span class="sd">    :param descending: Whether or not to sort the response in descending order. Default is :py:obj:`False`.</span>
-</span><span id="line-42"><span class="sd">    :type descending: :py:obj:`bool`</span>
-</span><span id="line-43"><span class="sd">    :param limit: Maximum amount of transactions to return in the response. Default is :py:obj:`100` .</span>
-</span><span id="line-44"><span class="sd">    :type limit: :py:obj:`int`</span>
-</span><span id="line-45"><span class="sd">    :param offset: Offsets the response for pagination. Default is :py:obj:`0` for page 0.</span>
-</span><span id="line-46"><span class="sd">    :type offset: :py:obj:`int`</span>
-</span><span id="line-47"><span class="sd">    :raises ValueError: If ``customer_profile_id`` was provided as a string containing non-digits.</span>
-</span><span id="line-48"><span class="sd">    :raises ValueError: If ``payment_profile_id`` was provided as a string containing non-digits.</span>
-</span><span id="line-49"><span class="sd">    :raises AuthorizenetControllerExecutionError: If the API call fails.</span>
-</span><span id="line-50"><span class="sd">    :returns: A merchant details object, if found.</span>
-</span><span id="line-51"><span class="sd">    :rtype: :py:obj:`dict` | :py:obj:`None`</span>
-</span><span id="line-52">
-</span><span id="line-53"><span class="sd">    &quot;&quot;&quot;</span>
-</span><span id="line-54">    <span class="k">raise</span> <span class="ne">NotImplementedError</span>
-</span><span id="line-55">
-</span><span id="line-56">    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">customer_profile_id</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">customer_profile_id</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
-</span><span id="line-57">        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-</span><span id="line-58">            <span class="sa">f</span><span class="s2">&quot;&#39;customer_profile_id&#39; can only contain digits, got &#39;</span><span class="si">{</span><span class="n">customer_profile_id</span><span class="si">}</span><span class="s2">&#39;.&quot;</span>
-</span><span id="line-59">        <span class="p">)</span>
-</span><span id="line-60">    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">payment_profile_id</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">payment_profile_id</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
-</span><span id="line-61">        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-</span><span id="line-62">            <span class="sa">f</span><span class="s2">&quot;&#39;payment_profile_id&#39; can only contain digits, got &#39;</span><span class="si">{</span><span class="n">payment_profile_id</span><span class="si">}</span><span class="s2">&#39;.&quot;</span>
-</span><span id="line-63">        <span class="p">)</span>
+</span><span id="line-24"><span class="k">def</span><span class="w"> </span><span class="nf">get_merchant_details</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">dict</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-25"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-26"><span class="sd">    Returns Authorizenet merchant details.</span>
+</span><span id="line-27">
+</span><span id="line-28"><span class="sd">    `getMerchantDetailsRequest &lt;http://developer.authorize.net/api/reference/index.html#transaction-reporting-get-merchant-details&gt;`_</span>
+</span><span id="line-29">
+</span><span id="line-30"><span class="sd">    :raises AuthorizenetControllerExecutionError: If the API call fails.</span>
+</span><span id="line-31"><span class="sd">    :returns: A merchant details object, if found.</span>
+</span><span id="line-32"><span class="sd">    :rtype: :py:obj:`dict` | :py:obj:`None`</span>
+</span><span id="line-33">
+</span><span id="line-34"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-35">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getMerchantDetailsRequest</span><span class="p">(</span>
+</span><span id="line-36">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</span><span class="p">()</span>
+</span><span id="line-37">    <span class="p">)</span>
+</span><span id="line-38">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getMerchantDetailsController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
+</span><span id="line-39">    <span class="k">return</span> <span class="n">AuthorizenetControllerExecutor</span><span class="o">.</span><span class="n">execute_controller</span><span class="p">(</span><span class="n">controller</span><span class="p">)</span>
+</span><span id="line-40">
+</span><span id="line-41">
+</span><span id="line-42"><span class="k">def</span><span class="w"> </span><span class="nf">get_transaction</span><span class="p">(</span><span class="nb">id</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-43"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-44"><span class="sd">    Returns Authorizenet transaction details by id.</span>
+</span><span id="line-45">
+</span><span id="line-46"><span class="sd">    `getTransactionDetailsRequest &lt;https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-transaction-details&gt;`_</span>
+</span><span id="line-47">
+</span><span id="line-48"><span class="sd">    :param id: An Authorizenet transaction id.</span>
+</span><span id="line-49"><span class="sd">    :type id: :py:obj:`int` | :py:obj:`str`</span>
+</span><span id="line-50"><span class="sd">    :raises ValueError: If ``id`` was provided as a string containing non-digits.</span>
+</span><span id="line-51"><span class="sd">    :raises AuthorizenetControllerExecutionError: If the API call fails.</span>
+</span><span id="line-52"><span class="sd">    :returns: A transaction object, if found.</span>
+</span><span id="line-53"><span class="sd">    :rtype: :py:obj:`dict` | :py:obj:`None`</span>
+</span><span id="line-54">
+</span><span id="line-55"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-56">    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">id</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
+</span><span id="line-57">        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;&#39;id&#39; can only contain digits, got &#39;</span><span class="si">{</span><span class="nb">id</span><span class="si">}</span><span class="s2">&#39;.&quot;</span><span class="p">)</span>
+</span><span id="line-58">
+</span><span id="line-59">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getTransactionDetailsRequest</span><span class="p">(</span>
+</span><span id="line-60">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</span><span class="p">(),</span> <span class="n">transId</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
+</span><span id="line-61">    <span class="p">)</span>
+</span><span id="line-62">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getTransactionDetailsController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
+</span><span id="line-63">    <span class="k">return</span> <span class="n">AuthorizenetControllerExecutor</span><span class="o">.</span><span class="n">execute_controller</span><span class="p">(</span><span class="n">controller</span><span class="p">)</span>
 </span><span id="line-64">
-</span><span id="line-65">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getTransactionListForCustomerRequest</span><span class="p">(</span>
-</span><span id="line-66">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</span><span class="p">(),</span>
-</span><span id="line-67">        <span class="n">customerProfileId</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">customer_profile_id</span><span class="p">),</span>
-</span><span id="line-68">        <span class="n">customerPaymentProfileId</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">payment_profile_id</span><span class="p">),</span>
-</span><span id="line-69">        <span class="n">sorting</span><span class="o">=</span><span class="p">{</span>
-</span><span id="line-70">            <span class="s2">&quot;orderBy&quot;</span><span class="p">:</span> <span class="s2">&quot;submitTimeUTC&quot;</span><span class="p">,</span>
-</span><span id="line-71">            <span class="s2">&quot;orderDescending&quot;</span><span class="p">:</span> <span class="nb">str</span><span class="p">(</span><span class="n">descending</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span>
-</span><span id="line-72">        <span class="p">},</span>
-</span><span id="line-73">        <span class="n">paging</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;limit&quot;</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span> <span class="s2">&quot;offset&quot;</span><span class="p">:</span> <span class="n">offset</span><span class="p">},</span>
-</span><span id="line-74">    <span class="p">)</span>
-</span><span id="line-75">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getTransactionListForCustomerController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
-</span><span id="line-76">    <span class="k">return</span> <span class="n">AuthorizenetControllerExecutor</span><span class="o">.</span><span class="n">execute_controller</span><span class="p">(</span><span class="n">controller</span><span class="p">)</span>
-</span><span id="line-77">
-</span><span id="line-78">
-</span><span id="line-79"><span class="k">def</span><span class="w"> </span><span class="nf">get_merchant_details</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">dict</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-80"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-81"><span class="sd">    Returns Authorizenet merchant details.</span>
-</span><span id="line-82">
-</span><span id="line-83"><span class="sd">    `getMerchantDetailsRequest &lt;http://developer.authorize.net/api/reference/index.html#transaction-reporting-get-merchant-details&gt;`_</span>
-</span><span id="line-84">
-</span><span id="line-85"><span class="sd">    :raises AuthorizenetControllerExecutionError: If the API call fails.</span>
-</span><span id="line-86"><span class="sd">    :returns: A merchant details object, if found.</span>
-</span><span id="line-87"><span class="sd">    :rtype: :py:obj:`dict` | :py:obj:`None`</span>
-</span><span id="line-88">
-</span><span id="line-89"><span class="sd">    &quot;&quot;&quot;</span>
-</span><span id="line-90">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getMerchantDetailsRequest</span><span class="p">(</span>
-</span><span id="line-91">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</span><span class="p">()</span>
-</span><span id="line-92">    <span class="p">)</span>
-</span><span id="line-93">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getMerchantDetailsController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
-</span><span id="line-94">    <span class="k">return</span> <span class="n">AuthorizenetControllerExecutor</span><span class="o">.</span><span class="n">execute_controller</span><span class="p">(</span><span class="n">controller</span><span class="p">)</span>
-</span><span id="line-95">
-</span><span id="line-96">
-</span><span id="line-97"><span class="k">def</span><span class="w"> </span><span class="nf">get_transaction</span><span class="p">(</span><span class="nb">id</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-98"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-99"><span class="sd">    Returns Authorizenet transaction details by id.</span>
-</span><span id="line-100">
-</span><span id="line-101"><span class="sd">    `getTransactionDetailsRequest &lt;https://developer.authorize.net/api/reference/index.html#transaction-reporting-get-transaction-details&gt;`_</span>
-</span><span id="line-102">
-</span><span id="line-103"><span class="sd">    :param id: An Authorizenet transaction id.</span>
-</span><span id="line-104"><span class="sd">    :type id: :py:obj:`int` | :py:obj:`str`</span>
-</span><span id="line-105"><span class="sd">    :raises ValueError: If ``id`` was provided as a string containing non-digits.</span>
-</span><span id="line-106"><span class="sd">    :raises AuthorizenetControllerExecutionError: If the API call fails.</span>
-</span><span id="line-107"><span class="sd">    :returns: A transaction object, if found.</span>
-</span><span id="line-108"><span class="sd">    :rtype: :py:obj:`dict` | :py:obj:`None`</span>
-</span><span id="line-109">
-</span><span id="line-110"><span class="sd">    &quot;&quot;&quot;</span>
-</span><span id="line-111">    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">id</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
-</span><span id="line-112">        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;&#39;id&#39; can only contain digits, got &#39;</span><span class="si">{</span><span class="nb">id</span><span class="si">}</span><span class="s2">&#39;.&quot;</span><span class="p">)</span>
-</span><span id="line-113">
-</span><span id="line-114">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getTransactionDetailsRequest</span><span class="p">(</span>
-</span><span id="line-115">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</span><span class="p">(),</span> <span class="n">transId</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
-</span><span id="line-116">    <span class="p">)</span>
-</span><span id="line-117">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getTransactionDetailsController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
-</span><span id="line-118">    <span class="k">return</span> <span class="n">AuthorizenetControllerExecutor</span><span class="o">.</span><span class="n">execute_controller</span><span class="p">(</span><span class="n">controller</span><span class="p">)</span>
-</span><span id="line-119">
-</span><span id="line-120">
+</span><span id="line-65">
 <div class="viewcode-block" id="get_customer_profile_ids">
 <a class="viewcode-back" href="../../../authorizenet/utils.html#terminusgps.authorizenet.utils.get_customer_profile_ids">[docs]</a>
-</span><span id="line-121"><span class="k">def</span><span class="w"> </span><span class="nf">get_customer_profile_ids</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
-</span><span id="line-122"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-123"><span class="sd">    Returns a list of all customer profile ids in Authorizenet.</span>
-</span><span id="line-124">
-</span><span id="line-125"><span class="sd">    :raises AuthorizenetControllerExecutionError: If the API call fails.</span>
-</span><span id="line-126"><span class="sd">    :returns: A list of all customer profile ids in Authorizenet.</span>
-</span><span id="line-127"><span class="sd">    :rtype: :py:obj:`list`</span>
-</span><span id="line-128">
-</span><span id="line-129"><span class="sd">    &quot;&quot;&quot;</span>
-</span><span id="line-130">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getCustomerProfileIdsRequest</span><span class="p">(</span>
-</span><span id="line-131">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</span><span class="p">()</span>
-</span><span id="line-132">    <span class="p">)</span>
-</span><span id="line-133">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getCustomerProfileIdsController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
-</span><span id="line-134">    <span class="n">response</span> <span class="o">=</span> <span class="n">AuthorizenetControllerExecutor</span><span class="o">.</span><span class="n">execute_controller</span><span class="p">(</span><span class="n">controller</span><span class="p">)</span>
-</span><span id="line-135">    <span class="k">if</span> <span class="n">response</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="s2">&quot;ids&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">getchildren</span><span class="p">():</span>
-</span><span id="line-136">        <span class="k">return</span> <span class="p">[]</span>
-</span><span id="line-137">    <span class="k">return</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span> <span class="k">for</span> <span class="nb">id</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">ids</span><span class="o">.</span><span class="n">getchildren</span><span class="p">()]</span></div>
+</span><span id="line-66"><span class="k">def</span><span class="w"> </span><span class="nf">get_customer_profile_ids</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="nb">int</span><span class="p">]:</span>
+</span><span id="line-67"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-68"><span class="sd">    Returns a list of all customer profile ids in Authorizenet.</span>
+</span><span id="line-69">
+</span><span id="line-70"><span class="sd">    :raises AuthorizenetControllerExecutionError: If the API call fails.</span>
+</span><span id="line-71"><span class="sd">    :returns: A list of all customer profile ids in Authorizenet.</span>
+</span><span id="line-72"><span class="sd">    :rtype: :py:obj:`list`</span>
+</span><span id="line-73">
+</span><span id="line-74"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-75">    <span class="n">request</span> <span class="o">=</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">getCustomerProfileIdsRequest</span><span class="p">(</span>
+</span><span id="line-76">        <span class="n">merchantAuthentication</span><span class="o">=</span><span class="n">get_merchant_auth</span><span class="p">()</span>
+</span><span id="line-77">    <span class="p">)</span>
+</span><span id="line-78">    <span class="n">controller</span> <span class="o">=</span> <span class="n">apicontrollers</span><span class="o">.</span><span class="n">getCustomerProfileIdsController</span><span class="p">(</span><span class="n">request</span><span class="p">)</span>
+</span><span id="line-79">    <span class="n">response</span> <span class="o">=</span> <span class="n">AuthorizenetControllerExecutor</span><span class="o">.</span><span class="n">execute_controller</span><span class="p">(</span><span class="n">controller</span><span class="p">)</span>
+</span><span id="line-80">    <span class="k">if</span> <span class="n">response</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="s2">&quot;ids&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">getchildren</span><span class="p">():</span>
+</span><span id="line-81">        <span class="k">return</span> <span class="p">[]</span>
+</span><span id="line-82">    <span class="k">return</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span> <span class="k">for</span> <span class="nb">id</span> <span class="ow">in</span> <span class="n">response</span><span class="o">.</span><span class="n">ids</span><span class="o">.</span><span class="n">getchildren</span><span class="p">()]</span></div>
 
-</span><span id="line-138">
-</span><span id="line-139">
+</span><span id="line-83">
+</span><span id="line-84">
 <div class="viewcode-block" id="generate_customer_address">
 <a class="viewcode-back" href="../../../authorizenet/utils.html#terminusgps.authorizenet.utils.generate_customer_address">[docs]</a>
-</span><span id="line-140"><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-141"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-142"><span class="sd">    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`.</span>
-</span><span id="line-143">
-</span><span id="line-144"><span class="sd">    Required form fields:</span>
-</span><span id="line-145">
-</span><span id="line-146"><span class="sd">    +----------------+------------------------------------------------------------+</span>
-</span><span id="line-147"><span class="sd">    | name           | type                                                       |</span>
-</span><span id="line-148"><span class="sd">    +================+============================================================+</span>
-</span><span id="line-149"><span class="sd">    | ``address``    | :py:obj:`~authorizenet.apicontractsv1.customerAddressType` |</span>
-</span><span id="line-150"><span class="sd">    +----------------+------------------------------------------------------------+</span>
-</span><span id="line-151"><span class="sd">    | ``first_name`` | :py:obj:`str`                                              |</span>
-</span><span id="line-152"><span class="sd">    +----------------+------------------------------------------------------------+</span>
-</span><span id="line-153"><span class="sd">    | ``last_name``  | :py:obj:`str`                                              |</span>
-</span><span id="line-154"><span class="sd">    +----------------+------------------------------------------------------------+</span>
-</span><span id="line-155">
-</span><span id="line-156"><span class="sd">    :param form: A Django form.</span>
-</span><span id="line-157"><span class="sd">    :type form: :py:obj:`~django.forms.Form`</span>
-</span><span id="line-158"><span class="sd">    :raises ValueError: If ``address`` wasn&#39;t in the form.</span>
-</span><span id="line-159"><span class="sd">    :raises ValueError: If ``first_name`` wasn&#39;t in the form.</span>
-</span><span id="line-160"><span class="sd">    :raises ValueError: If ``last_name`` wasn&#39;t in the form.</span>
-</span><span id="line-161"><span class="sd">    :returns: A customer address object.</span>
-</span><span id="line-162"><span class="sd">    :rtype: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`</span>
-</span><span id="line-163">
-</span><span id="line-164"><span class="sd">    &quot;&quot;&quot;</span>
-</span><span id="line-165">    <span class="n">required_fields</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;address&quot;</span><span class="p">,</span> <span class="s2">&quot;first_name&quot;</span><span class="p">,</span> <span class="s2">&quot;last_name&quot;</span><span class="p">]</span>
-</span><span id="line-166">    <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">required_fields</span><span class="p">:</span>
-</span><span id="line-167">        <span class="k">if</span> <span class="n">field</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span> <span class="ow">or</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-168">            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-</span><span id="line-169">                <span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">field</span><span class="si">}</span><span class="s2">&#39; was not provided by the form, got &#39;</span><span class="si">{</span><span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;.&quot;</span>
-</span><span id="line-170">            <span class="p">)</span>
-</span><span id="line-171">
-</span><span id="line-172">    <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-173">    <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-174">    <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-175">    <span class="k">if</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;phone&quot;</span><span class="p">):</span>
-</span><span id="line-176">        <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-177">    <span class="k">return</span> <span class="n">address</span></div>
+</span><span id="line-85"><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-86"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-87"><span class="sd">    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.customerAddressType`.</span>
+</span><span id="line-88">
+</span><span id="line-89"><span class="sd">    Required form fields:</span>
+</span><span id="line-90">
+</span><span id="line-91"><span class="sd">    +----------------+------------------------------------------------------------+</span>
+</span><span id="line-92"><span class="sd">    | name           | type                                                       |</span>
+</span><span id="line-93"><span class="sd">    +================+============================================================+</span>
+</span><span id="line-94"><span class="sd">    | ``address``    | :py:obj:`~authorizenet.apicontractsv1.customerAddressType` |</span>
+</span><span id="line-95"><span class="sd">    +----------------+------------------------------------------------------------+</span>
+</span><span id="line-96"><span class="sd">    | ``first_name`` | :py:obj:`str`                                              |</span>
+</span><span id="line-97"><span class="sd">    +----------------+------------------------------------------------------------+</span>
+</span><span id="line-98"><span class="sd">    | ``last_name``  | :py:obj:`str`                                              |</span>
+</span><span id="line-99"><span class="sd">    +----------------+------------------------------------------------------------+</span>
+</span><span id="line-100">
+</span><span id="line-101"><span class="sd">    :param form: A Django form.</span>
+</span><span id="line-102"><span class="sd">    :type form: :py:obj:`~django.forms.Form`</span>
+</span><span id="line-103"><span class="sd">    :raises ValueError: If ``address`` wasn&#39;t in the form.</span>
+</span><span id="line-104"><span class="sd">    :raises ValueError: If ``first_name`` wasn&#39;t in the form.</span>
+</span><span id="line-105"><span class="sd">    :raises ValueError: If ``last_name`` wasn&#39;t in the form.</span>
+</span><span id="line-106"><span class="sd">    :returns: A customer address object.</span>
+</span><span id="line-107"><span class="sd">    :rtype: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`</span>
+</span><span id="line-108">
+</span><span id="line-109"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-110">    <span class="n">required_fields</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;address&quot;</span><span class="p">,</span> <span class="s2">&quot;first_name&quot;</span><span class="p">,</span> <span class="s2">&quot;last_name&quot;</span><span class="p">]</span>
+</span><span id="line-111">    <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">required_fields</span><span class="p">:</span>
+</span><span id="line-112">        <span class="k">if</span> <span class="n">field</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span> <span class="ow">or</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-113">            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
+</span><span id="line-114">                <span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">field</span><span class="si">}</span><span class="s2">&#39; was not provided by the form, got &#39;</span><span class="si">{</span><span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;.&quot;</span>
+</span><span id="line-115">            <span class="p">)</span>
+</span><span id="line-116">
+</span><span id="line-117">    <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-118">    <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-119">    <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-120">    <span class="k">if</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;phone&quot;</span><span class="p">):</span>
+</span><span id="line-121">        <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-122">    <span class="k">return</span> <span class="n">address</span></div>
 
-</span><span id="line-178">
-</span><span id="line-179">
+</span><span id="line-123">
+</span><span id="line-124">
 <div class="viewcode-block" id="generate_customer_payment">
 <a class="viewcode-back" href="../../../authorizenet/utils.html#terminusgps.authorizenet.utils.generate_customer_payment">[docs]</a>
-</span><span id="line-180"><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-181"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="line-182"><span class="sd">    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.paymentType`.</span>
-</span><span id="line-183">
-</span><span id="line-184"><span class="sd">    Required form fields:</span>
-</span><span id="line-185">
-</span><span id="line-186"><span class="sd">    +-----------------+-------------------------------------------------------+</span>
-</span><span id="line-187"><span class="sd">    | name            | type                                                  |</span>
-</span><span id="line-188"><span class="sd">    +=================+=======================================================+</span>
-</span><span id="line-189"><span class="sd">    | ``credit_card`` | :py:obj:`~authorizenet.apicontractsv1.creditCardType` |</span>
-</span><span id="line-190"><span class="sd">    +-----------------+-------------------------------------------------------+</span>
-</span><span id="line-191">
-</span><span id="line-192"><span class="sd">    :param form: A Django form.</span>
-</span><span id="line-193"><span class="sd">    :type form: :py:obj:`~django.forms.Form`</span>
-</span><span id="line-194"><span class="sd">    :raises ValueError: If ``credit_card`` wasn&#39;t in the form.</span>
-</span><span id="line-195"><span class="sd">    :returns: A payment object.</span>
-</span><span id="line-196"><span class="sd">    :rtype: :py:obj:`~authorizenet.apicontractsv1.paymentType`</span>
-</span><span id="line-197">
-</span><span id="line-198"><span class="sd">    &quot;&quot;&quot;</span>
-</span><span id="line-199">    <span class="n">required_fields</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;credit_card&quot;</span><span class="p">]</span>
-</span><span id="line-200">    <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">required_fields</span><span class="p">:</span>
-</span><span id="line-201">        <span class="k">if</span> <span class="n">field</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span> <span class="ow">or</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-</span><span id="line-202">            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-</span><span id="line-203">                <span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">field</span><span class="si">}</span><span class="s2">&#39; was not provided by the form, got &#39;</span><span class="si">{</span><span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;.&quot;</span>
-</span><span id="line-204">            <span class="p">)</span>
-</span><span id="line-205">
-</span><span id="line-206">    <span class="n">credit_card</span><span class="p">:</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">creditCardType</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-207">    <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></div>
+</span><span id="line-125"><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-126"><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+</span><span id="line-127"><span class="sd">    Takes a form and returns a :py:obj:`~authorizenet.apicontractsv1.paymentType`.</span>
+</span><span id="line-128">
+</span><span id="line-129"><span class="sd">    Required form fields:</span>
+</span><span id="line-130">
+</span><span id="line-131"><span class="sd">    +-----------------+-------------------------------------------------------+</span>
+</span><span id="line-132"><span class="sd">    | name            | type                                                  |</span>
+</span><span id="line-133"><span class="sd">    +=================+=======================================================+</span>
+</span><span id="line-134"><span class="sd">    | ``credit_card`` | :py:obj:`~authorizenet.apicontractsv1.creditCardType` |</span>
+</span><span id="line-135"><span class="sd">    +-----------------+-------------------------------------------------------+</span>
+</span><span id="line-136">
+</span><span id="line-137"><span class="sd">    :param form: A Django form.</span>
+</span><span id="line-138"><span class="sd">    :type form: :py:obj:`~django.forms.Form`</span>
+</span><span id="line-139"><span class="sd">    :raises ValueError: If ``credit_card`` wasn&#39;t in the form.</span>
+</span><span id="line-140"><span class="sd">    :returns: A payment object.</span>
+</span><span id="line-141"><span class="sd">    :rtype: :py:obj:`~authorizenet.apicontractsv1.paymentType`</span>
+</span><span id="line-142">
+</span><span id="line-143"><span class="sd">    &quot;&quot;&quot;</span>
+</span><span id="line-144">    <span class="n">required_fields</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;credit_card&quot;</span><span class="p">]</span>
+</span><span id="line-145">    <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">required_fields</span><span class="p">:</span>
+</span><span id="line-146">        <span class="k">if</span> <span class="n">field</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span> <span class="ow">or</span> <span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+</span><span id="line-147">            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
+</span><span id="line-148">                <span class="sa">f</span><span class="s2">&quot;&#39;</span><span class="si">{</span><span class="n">field</span><span class="si">}</span><span class="s2">&#39; was not provided by the form, got &#39;</span><span class="si">{</span><span class="n">form</span><span class="o">.</span><span class="n">cleaned_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">)</span><span class="si">}</span><span class="s2">&#39;.&quot;</span>
+</span><span id="line-149">            <span class="p">)</span>
+</span><span id="line-150">
+</span><span id="line-151">    <span class="n">credit_card</span><span class="p">:</span> <span class="n">apicontractsv1</span><span class="o">.</span><span class="n">creditCardType</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-152">    <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></div>
 
 </span></code></pre></div>
     </div></div>
@@ -411,7 +356,7 @@
 </footer>
   </div>
   
-    <script src="../../../_static/documentation_options.js?v=fd833ad5"></script>
+    <script src="../../../_static/documentation_options.js?v=59fbbecc"></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>