python-terminusgps 43.0.1__tar.gz → 43.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of python-terminusgps might be problematic. Click here for more details.

Files changed (79) hide show
  1. python_terminusgps-43.2.0/.github/workflows/sphinx.yml +30 -0
  2. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/.gitignore +3 -1
  3. python_terminusgps-43.2.0/.python-version +1 -0
  4. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/PKG-INFO +4 -7
  5. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/README.md +1 -4
  6. python_terminusgps-43.2.0/docs/requirements.txt +5 -0
  7. python_terminusgps-43.2.0/docs/source/authorizenet/api.rst +38 -0
  8. python_terminusgps-43.2.0/docs/source/authorizenet/constants.rst +9 -0
  9. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/authorizenet/controllers.rst +0 -3
  10. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/authorizenet/index.rst +2 -3
  11. python_terminusgps-43.2.0/docs/source/authorizenet/usage.rst +20 -0
  12. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/conf.py +3 -10
  13. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/django/mixins.rst +0 -1
  14. python_terminusgps-43.2.0/docs/source/wialon/index.rst +11 -0
  15. python_terminusgps-43.2.0/docs/source/wialon/items.rst +46 -0
  16. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/wialon/session.rst +3 -2
  17. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/pyproject.toml +7 -5
  18. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/api/address_profiles.py +21 -21
  19. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/api/customer_profiles.py +18 -18
  20. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/api/payment_profiles.py +29 -28
  21. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/api/subscriptions.py +38 -38
  22. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/api/transactions.py +11 -11
  23. python_terminusgps-43.2.0/terminusgps/authorizenet/constants.py +30 -0
  24. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/account.py +45 -36
  25. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/base.py +39 -15
  26. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/factory.py +39 -29
  27. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/resource.py +35 -23
  28. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/retranslator.py +13 -8
  29. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/route.py +7 -4
  30. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/unit.py +28 -20
  31. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/unit_group.py +13 -9
  32. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/user.py +30 -22
  33. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/session.py +10 -9
  34. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/uv.lock +8 -6
  35. python_terminusgps-43.0.1/docs/source/authorizenet/constants.rst +0 -7
  36. python_terminusgps-43.0.1/docs/source/authorizenet/examples.rst +0 -165
  37. python_terminusgps-43.0.1/docs/source/authorizenet/profiles.rst +0 -23
  38. python_terminusgps-43.0.1/docs/source/authorizenet/subscriptions.rst +0 -5
  39. python_terminusgps-43.0.1/docs/source/authorizenet/utils.rst +0 -5
  40. python_terminusgps-43.0.1/docs/source/wialon/constants.rst +0 -20
  41. python_terminusgps-43.0.1/docs/source/wialon/errors.rst +0 -10
  42. python_terminusgps-43.0.1/docs/source/wialon/examples.rst +0 -339
  43. python_terminusgps-43.0.1/docs/source/wialon/flags.rst +0 -16
  44. python_terminusgps-43.0.1/docs/source/wialon/index.rst +0 -30
  45. python_terminusgps-43.0.1/docs/source/wialon/items.rst +0 -37
  46. python_terminusgps-43.0.1/docs/source/wialon/utils.rst +0 -28
  47. python_terminusgps-43.0.1/terminusgps/authorizenet/constants.py +0 -15
  48. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/COPYING +0 -0
  49. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/Makefile +0 -0
  50. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/make.bat +0 -0
  51. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/authorizenet/auth.rst +0 -0
  52. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/authorizenet/validators.rst +0 -0
  53. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/django/forms.rst +0 -0
  54. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/django/index.rst +0 -0
  55. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/django/settings.rst +0 -0
  56. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/django/validators.rst +0 -0
  57. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/docs/source/index.rst +0 -0
  58. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/__init__.py +0 -0
  59. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/__init__.py +0 -0
  60. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/api/__init__.py +0 -0
  61. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/auth.py +0 -0
  62. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/controllers.py +0 -0
  63. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/authorizenet/validators.py +0 -0
  64. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/__init__.py +0 -0
  65. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/forms/__init__.py +0 -0
  66. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/forms/fields.py +0 -0
  67. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/forms/forms.py +0 -0
  68. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/forms/renderer.py +0 -0
  69. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/forms/widgets.py +0 -0
  70. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/mixins.py +0 -0
  71. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/settings.py +0 -0
  72. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/utils.py +0 -0
  73. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/django/validators.py +0 -0
  74. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/__init__.py +0 -0
  75. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/constants.py +0 -0
  76. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/flags.py +0 -0
  77. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/items/__init__.py +0 -0
  78. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/utils.py +0 -0
  79. {python_terminusgps-43.0.1 → python_terminusgps-43.2.0}/terminusgps/wialon/validators.py +0 -0
@@ -0,0 +1,30 @@
1
+ name: "Sphinx: Render docs"
2
+ on: push
3
+
4
+ jobs:
5
+ builds:
6
+ runs-on: ubuntu-latest
7
+ permissions:
8
+ contents: write
9
+
10
+ steps:
11
+ - uses: actions/checkout@v4
12
+ with:
13
+ persist-credentials: false
14
+
15
+ - name: Build HTML
16
+ uses: ammaraskar/sphinx-action@8.2.3
17
+
18
+ - name: Upload artifacts
19
+ uses: actions/upload-artifact@v4
20
+ with:
21
+ name: Documentation
22
+ path: docs/build/html/
23
+
24
+ - name: Deploy
25
+ uses: peaceiris/actions-gh-pages@v3
26
+ if: github.ref == 'refs/heads/main'
27
+ with:
28
+ github_token: ${{ secrets.GITHUB_TOKEN }}
29
+ publish_dir: docs/build/html
30
+
@@ -1,5 +1,8 @@
1
1
  .*
2
2
  !.gitignore
3
+ !.github/
4
+ !.python-version
5
+ docs/build/
3
6
 
4
7
  # Python-generated files
5
8
  __pycache__/
@@ -11,4 +14,3 @@ wheels/
11
14
  # Virtual environments
12
15
  .venv
13
16
  venv
14
- docs/build/
@@ -0,0 +1 @@
1
+ 3.12
@@ -1,8 +1,8 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: python-terminusgps
3
- Version: 43.0.1
3
+ Version: 43.2.0
4
4
  Summary: Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more.
5
- Project-URL: Documentation, https://docs.terminusgps.com
5
+ Project-URL: Documentation, https://terminusgps.github.io/python-terminusgps
6
6
  Project-URL: Repository, https://github.com/terminusgps/python-terminusgps
7
7
  Author-email: Blake Nall <blake@terminusgps.com>
8
8
  License-File: COPYING
@@ -12,13 +12,10 @@ Classifier: Programming Language :: Python :: 3
12
12
  Classifier: Programming Language :: Python :: 3.12
13
13
  Requires-Python: >=3.12
14
14
  Requires-Dist: authorizenet>=1.1.5
15
- Requires-Dist: django>=5.1.5
15
+ Requires-Dist: django>=5.2.6
16
16
  Requires-Dist: python-wialon>=1.2.4
17
17
  Description-Content-Type: text/markdown
18
18
 
19
- # Terminus GPS Internal Tools
19
+ # python-terminusgps
20
20
 
21
21
  *python-terminusgps* adds libraries for working with web APIs used by [Terminus GPS](https://terminusgps.com/) developers.
22
-
23
- [Documentation](https://docs.terminusgps.com/)
24
-
@@ -1,6 +1,3 @@
1
- # Terminus GPS Internal Tools
1
+ # python-terminusgps
2
2
 
3
3
  *python-terminusgps* adds libraries for working with web APIs used by [Terminus GPS](https://terminusgps.com/) developers.
4
-
5
- [Documentation](https://docs.terminusgps.com/)
6
-
@@ -0,0 +1,5 @@
1
+ autoclasstoc>=1.7.0
2
+ django>=5.2.1
3
+ furo==2024.04.27
4
+ python-wialon>=1.2.4
5
+ sphinxawesome-theme>=5.3.2
@@ -0,0 +1,38 @@
1
+ Authorizenet API Endpoints
2
+ ==========================
3
+
4
+ ================
5
+ Address Profiles
6
+ ================
7
+
8
+ .. automodule:: terminusgps.authorizenet.api.address_profiles
9
+ :members:
10
+
11
+ =================
12
+ Customer Profiles
13
+ =================
14
+
15
+ .. automodule:: terminusgps.authorizenet.api.customer_profiles
16
+ :members:
17
+
18
+ ================
19
+ Payment Profiles
20
+ ================
21
+
22
+ .. automodule:: terminusgps.authorizenet.api.payment_profiles
23
+ :members:
24
+
25
+ =============
26
+ Subscriptions
27
+ =============
28
+
29
+ .. automodule:: terminusgps.authorizenet.api.subscriptions
30
+ :members:
31
+
32
+ ============
33
+ Transactions
34
+ ============
35
+
36
+ .. automodule:: terminusgps.authorizenet.api.transactions
37
+ :members:
38
+
@@ -0,0 +1,9 @@
1
+ Constants
2
+ =========
3
+
4
+ .. py:currentmodule:: terminusgps.authorizenet.constants
5
+
6
+ .. autodata:: ANET_XMLNS
7
+
8
+ .. autoclass:: AuthorizenetSubscriptionStatus
9
+ :members:
@@ -1,7 +1,4 @@
1
1
  API Controllers
2
2
  ===============
3
3
 
4
- .. autoclass:: terminusgps.authorizenet.controllers.AuthorizenetControllerExecutor
5
- :members:
6
-
7
4
  .. autoexception:: terminusgps.authorizenet.controllers.AuthorizenetControllerExecutionError
@@ -7,10 +7,9 @@ Authorizenet API
7
7
  :maxdepth: 2
8
8
  :caption: Contents:
9
9
 
10
+ api.rst
10
11
  auth.rst
11
12
  constants.rst
12
13
  controllers.rst
13
- profiles.rst
14
- subscriptions.rst
15
- utils.rst
14
+ usage.rst
16
15
  validators.rst
@@ -0,0 +1,20 @@
1
+ Usage
2
+ =====
3
+
4
+ Check the Authorizenet API documentation for expected attributes in each response.
5
+
6
+ .. code:: python
7
+
8
+ from terminusgps.authorizenet import api as anet
9
+
10
+ # An Authorizenet 'createCustomerProfileRequest'
11
+ response = anet.create_customer_profile(
12
+ merchant_id="1",
13
+ email="blake@terminusgps.com",
14
+ description="Blake Nall"
15
+ )
16
+
17
+ # Authorizenet API calls may return None
18
+ # Check first before trying to access attributes on it
19
+ if response is not None and hasattr(response, "customerProfileId"):
20
+ response.customerProfileId
@@ -8,17 +8,11 @@
8
8
  import os
9
9
  import sys
10
10
 
11
- import django
12
- from sphinxawesome_theme.postprocess import Icons
13
-
14
- sys.path.insert(0, os.path.abspath("../.."))
15
- os.environ["DJANGO_SETTINGS_MODULE"] = "terminusgps.django.settings"
16
- django.setup()
17
-
11
+ sys.path.insert(0, os.path.abspath("../../"))
18
12
  project = "python-terminusgps"
19
13
  copyright = "2025, Terminus GPS, LLC"
20
14
  author = "Terminus GPS, LLC"
21
- release = "43.0.1"
15
+ release = "43.2.0"
22
16
 
23
17
  # -- General configuration ---------------------------------------------------
24
18
  # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -32,7 +26,7 @@ extensions = [
32
26
  ]
33
27
 
34
28
  intersphinx_mapping = {
35
- "python": ("https://docs.python.org/3", None),
29
+ "python": ("https://docs.python.org/3/", None),
36
30
  "django": (
37
31
  "http://docs.djangoproject.com/en/stable/",
38
32
  "http://docs.djangoproject.com/en/stable/_objects/",
@@ -47,7 +41,6 @@ exclude_patterns = []
47
41
  # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
48
42
 
49
43
  html_theme = "sphinxawesome_theme"
50
- html_permalinks_icon = Icons.permalinks_icon
51
44
  pygments_style = "sas"
52
45
  pygments_style_dark = "lightbulb"
53
46
  html_static_path = ["_static"]
@@ -3,7 +3,6 @@ Mixins
3
3
 
4
4
  .. autoclass:: terminusgps.django.mixins.HtmxTemplateResponseMixin
5
5
  :members:
6
- :autoclasstoc:
7
6
 
8
7
  =====
9
8
  Usage
@@ -0,0 +1,11 @@
1
+ Wialon API
2
+ ==========
3
+
4
+ :py:mod:`terminusgps` offers the :py:mod:`wialon` package.
5
+
6
+ .. toctree::
7
+ :maxdepth: 2
8
+ :caption: Contents:
9
+
10
+ items.rst
11
+ session.rst
@@ -0,0 +1,46 @@
1
+ Items
2
+ =====
3
+
4
+ ====
5
+ Base
6
+ ====
7
+
8
+ .. autoclass:: terminusgps.wialon.items.base.WialonObject
9
+ :autoclasstoc:
10
+ :members:
11
+
12
+ =======
13
+ Factory
14
+ =======
15
+
16
+ .. autoclass:: terminusgps.wialon.items.factory.WialonObjectFactory
17
+ :autoclasstoc:
18
+ :members:
19
+
20
+ ==============
21
+ Wialon objects
22
+ ==============
23
+
24
+ .. autoclass:: terminusgps.wialon.items.account.WialonAccount
25
+ :members:
26
+
27
+ .. autoclass:: terminusgps.wialon.items.resource.WialonResource
28
+ :members:
29
+
30
+ .. autoclass:: terminusgps.wialon.items.retranslator.WialonRetranslator
31
+ :members:
32
+
33
+ .. autoclass:: terminusgps.wialon.items.retranslator.WialonRetranslatorConfiguration
34
+ :members:
35
+
36
+ .. autoclass:: terminusgps.wialon.items.route.WialonRoute
37
+ :members:
38
+
39
+ .. autoclass:: terminusgps.wialon.items.unit.WialonUnit
40
+ :members:
41
+
42
+ .. autoclass:: terminusgps.wialon.items.unit_group.WialonUnitGroup
43
+ :members:
44
+
45
+ .. autoclass:: terminusgps.wialon.items.user.WialonUser
46
+ :members:
@@ -1,10 +1,11 @@
1
1
  Wialon API Sessions
2
2
  ===================
3
3
 
4
- .. autoclass:: terminusgps.wialon.session.WialonSession
4
+ .. py:currentmodule:: terminusgps.wialon.session
5
+
6
+ .. autoclass:: WialonSession
5
7
  :members:
6
8
  :class-doc-from: init
7
- :autoclasstoc:
8
9
 
9
10
 
10
11
  =====
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "python-terminusgps"
3
- version = "43.0.1"
3
+ version = "43.2.0"
4
4
  description = "Provides abstractions/utilities for working with Wialon API, Authorize.NET API, AWS API, and more."
5
5
  readme = "README.md"
6
6
  authors = [ {name = "Blake Nall", email = "blake@terminusgps.com" } ]
@@ -13,12 +13,12 @@ classifiers = [
13
13
  requires-python = ">=3.12"
14
14
  dependencies = [
15
15
  "authorizenet>=1.1.5",
16
- "django>=5.1.5",
16
+ "django>=5.2.6",
17
17
  "python-wialon>=1.2.4",
18
18
  ]
19
19
 
20
20
  [project.urls]
21
- Documentation = "https://docs.terminusgps.com"
21
+ Documentation = "https://terminusgps.github.io/python-terminusgps"
22
22
  Repository = "https://github.com/terminusgps/python-terminusgps"
23
23
 
24
24
  [build-system]
@@ -70,8 +70,10 @@ skip-magic-trailing-comma = true
70
70
 
71
71
  [dependency-groups]
72
72
  dev = [
73
- "autoclasstoc>=1.7.0",
74
73
  "django-stubs>=5.1.3",
75
- "sphinx>=8.1.3",
74
+ ]
75
+ docs = [
76
+ "autoclasstoc>=1.7.0",
77
+ "sphinx>=8.2.3",
76
78
  "sphinxawesome-theme>=5.3.2",
77
79
  ]
@@ -15,19 +15,19 @@ __all__ = [
15
15
  def create_customer_shipping_address(
16
16
  customer_profile_id: int,
17
17
  address: apicontractsv1.customerAddressType,
18
- default: bool = True,
18
+ default: bool = False,
19
19
  ) -> ObjectifiedElement | None:
20
20
  """
21
21
  `createCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-shipping-address>`_.
22
22
 
23
23
  :param customer_profile_id: An Authorizenet customer profile id.
24
- :type customer_profile_id: :py:obj:`int`
25
- :param elem: An Authorizenet customer address element.
26
- :type elem: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
27
- :param default: Whether or not to mark the new shipping address as default. Default is :py:obj:`True`.
28
- :type default: :py:obj:`bool`
29
- :returns: An Authorizenet createCustomerShippingAddress response.
30
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
24
+ :type customer_profile_id: int
25
+ :param address: An Authorizenet customer address element.
26
+ :type address: ~authorizenet.apicontractsv1.customerAddressType
27
+ :param default: Whether to set the address profile as default. Default is False.
28
+ :type default: bool
29
+ :returns: An Authorizenet createCustomerShippingAddressResponse element.
30
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
31
31
 
32
32
  """
33
33
  request = apicontractsv1.createCustomerShippingAddressRequest()
@@ -48,11 +48,11 @@ def get_customer_shipping_address(
48
48
  `getCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-shipping-address>`_.
49
49
 
50
50
  :param customer_profile_id: An Authorizenet customer profile id.
51
- :type customer_profile_id: :py:obj:`int`
51
+ :type customer_profile_id: int
52
52
  :param address_profile_id: An Authorizenet customer address profile id.
53
- :type address_profile_id: :py:obj:`int`
54
- :returns: An Authorizenet getCustomerShippingAddress response.
55
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
53
+ :type address_profile_id: int
54
+ :returns: An Authorizenet getCustomerShippingAddressResponse element.
55
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
56
56
 
57
57
  """
58
58
  request = apicontractsv1.getCustomerShippingAddressRequest()
@@ -74,13 +74,13 @@ def update_customer_shipping_address(
74
74
  `updateCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-shipping-address>`_.
75
75
 
76
76
  :param customer_profile_id: An Authorizenet customer profile id.
77
- :type customer_profile_id: :py:obj:`int`
77
+ :type customer_profile_id: int
78
78
  :param address: An Authorizenet customer address element.
79
- :type address: :py:obj:`~authorizenet.apicontractsv1.customerAddressType`
80
- :param default: Whether or not to mark the new shipping address as default. Default is :py:obj:`False`.
81
- :type default: :py:obj:`bool`
82
- :returns: An Authorizenet updateCustomerShippingAddress response.
83
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
79
+ :type address: ~authorizenet.apicontractsv1.customerAddressType
80
+ :param default: Whether to set the address profile as default. Default is False.
81
+ :type default: bool
82
+ :returns: An Authorizenet updateCustomerShippingAddressResponse element.
83
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
84
84
 
85
85
  """
86
86
  request = apicontractsv1.updateCustomerShippingAddressRequest()
@@ -101,11 +101,11 @@ def delete_customer_shipping_address(
101
101
  `deleteCustomerShippingAddressRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-shipping-address>`_.
102
102
 
103
103
  :param customer_profile_id: An Authorizenet customer profile id.
104
- :type customer_profile_id: :py:obj:`int`
104
+ :type customer_profile_id: int
105
105
  :param address_profile_id: An Authorizenet customer address profile id.
106
- :type address_profile_id: :py:obj:`int`
106
+ :type address_profile_id: int
107
107
  :returns: An Authorizenet deleteCustomerShippingAddressResponse element.
108
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
108
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
109
109
 
110
110
  """
111
111
  request = apicontractsv1.deleteCustomerShippingAddressRequest()
@@ -20,13 +20,13 @@ def create_customer_profile(
20
20
  `createCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile>`_.
21
21
 
22
22
  :param merchant_id: A merchant designated customer id.
23
- :type merchant_id: :py:obj:`str`
23
+ :type merchant_id: str
24
24
  :param email: A customer email address.
25
- :type email: :py:obj:`str`
25
+ :type email: str
26
26
  :param description: An optional customer description.
27
- :type description: :py:obj:`str`
28
- :returns: An Authorizenet createCustomerProfile response.
29
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
27
+ :type description: str
28
+ :returns: An Authorizenet createCustomerProfileResponse element.
29
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
30
30
 
31
31
  """
32
32
  request = apicontractsv1.createCustomerProfileRequest()
@@ -48,11 +48,11 @@ def get_customer_profile(
48
48
  `getCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile>`_.
49
49
 
50
50
  :param customer_profile_id: An Authorizenet customer profile id.
51
- :type customer_profile_id: :py:obj:`int`
52
- :param include_issuer_info: Whether or not to include issuer info in the response. Default is :py:obj:`False`.
53
- :type include_issuer_info: :py:obj:`bool`
54
- :returns: An Authorizenet getCustomerProfile response.
55
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
51
+ :type customer_profile_id: int
52
+ :param include_issuer_info: Whether to include issuer info in the response. Default is False.
53
+ :type include_issuer_info: bool
54
+ :returns: An Authorizenet getCustomerProfileResponse element.
55
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
56
56
 
57
57
  """
58
58
  request = apicontractsv1.getCustomerProfileRequest()
@@ -69,8 +69,8 @@ def get_customer_profile_ids() -> ObjectifiedElement | None:
69
69
  """
70
70
  `getCustomerProfileIdsRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile-ids>`_.
71
71
 
72
- :returns: An Authorizenet getCustomerProfileIds response.
73
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
72
+ :returns: An Authorizenet getCustomerProfileIdsResponse element.
73
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
74
74
 
75
75
  """
76
76
  request = apicontractsv1.getCustomerProfileIdsRequest()
@@ -88,9 +88,9 @@ def update_customer_profile(
88
88
  `updateCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-profile>`_.
89
89
 
90
90
  :param profile: An Authorizenet customer profile ex element.
91
- :type profile: :py:obj:`~authorizenet.apicontractsv1.customerProfileExType`
92
- :returns: An Authorizenet updateCustomerProfile response.
93
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
91
+ :type profile: ~authorizenet.apicontractsv1.customerProfileExType
92
+ :returns: An Authorizenet updateCustomerProfileResponse element.
93
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
94
94
 
95
95
  """
96
96
  request = apicontractsv1.updateCustomerProfileRequest()
@@ -109,9 +109,9 @@ def delete_customer_profile(
109
109
  `deleteCustomerProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-profile>`_.
110
110
 
111
111
  :param customer_profile_id: An Authorizenet customer profile id.
112
- :type customer_profile_id: :py:obj:`int`
113
- :returns: An Authorizenet deleteCustomerProfile response.
114
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
112
+ :type customer_profile_id: int
113
+ :returns: An Authorizenet deleteCustomerProfileResponse element.
114
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
115
115
 
116
116
  """
117
117
  request = apicontractsv1.deleteCustomerProfileRequest()
@@ -19,17 +19,18 @@ __all__ = [
19
19
  def create_customer_payment_profile(
20
20
  customer_profile_id: int,
21
21
  payment_profile: apicontractsv1.customerPaymentProfileType,
22
- validate: bool = False,
22
+ validate: bool = True,
23
23
  ) -> ObjectifiedElement | None:
24
24
  """
25
25
  `createCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-payment-profile>`_.
26
26
 
27
27
  :param customer_profile_id: An Authorizenet customer profile id.
28
- :type customer_profile_id: :py:obj:`int`
28
+ :type customer_profile_id: int
29
29
  :param payment_profile: An Authorizenet payment profile element.
30
- :type payment_profile: :py:obj:`~authorizenet.apicontractsv1.customerPaymentProfileType`
31
- :returns: An Authorizenet createCustomerPaymentProfile response.
32
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
30
+ :type payment_profile: ~authorizenet.apicontractsv1.customerPaymentProfileType
31
+ :param validate: Whether to validate the payment profile. Default is True.
32
+ :returns: An Authorizenet createCustomerPaymentProfileResponse element.
33
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
33
34
 
34
35
  """
35
36
  request = apicontractsv1.createCustomerPaymentProfileRequest()
@@ -53,13 +54,13 @@ def get_customer_payment_profile(
53
54
  `getCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile>`_.
54
55
 
55
56
  :param customer_profile_id: An Authorizenet customer profile id.
56
- :type customer_profile_id: :py:obj:`int`
57
+ :type customer_profile_id: int
57
58
  :param payment_profile_id: An Authorizenet customer payment profile id.
58
- :type payment_profile_id: :py:obj:`int`
59
- :param include_issuer_info: Whether to include issuer info in the response. Default is :py:obj:`False`.
60
- :type include_issuer_info: :py:obj:`bool`
61
- :returns: An Authorizenet getCustomerPaymentProfile response.
62
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
59
+ :type payment_profile_id: int
60
+ :param include_issuer_info: Whether to include issuer info in the response. Default is False.
61
+ :type include_issuer_info: bool
62
+ :returns: An Authorizenet getCustomerPaymentProfileResponse element.
63
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
63
64
 
64
65
  """
65
66
  request = apicontractsv1.getCustomerPaymentProfileRequest()
@@ -80,11 +81,11 @@ def validate_customer_payment_profile(
80
81
  `validateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-validate-customer-payment-profile>`_.
81
82
 
82
83
  :param customer_profile_id: An Authorizenet customer profile id.
83
- :type customer_profile_id: :py:obj:`int`
84
- :param customer_payment_profile_id: An Authorizenet customer payment profile id.
85
- :type customer_payment_profile_id: :py:obj:`int`
86
- :returns: An Authorizenet validateCustomerPaymentProfile response.
87
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
84
+ :type customer_profile_id: int
85
+ :param payment_profile_id: An Authorizenet customer payment profile id.
86
+ :type payment_profile_id: int
87
+ :returns: An Authorizenet validateCustomerPaymentProfileResponse element.
88
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
88
89
 
89
90
  """
90
91
  request = apicontractsv1.validateCustomerPaymentProfileRequest()
@@ -102,21 +103,21 @@ def update_customer_payment_profile(
102
103
  customer_profile_id: int,
103
104
  payment_profile_id: int,
104
105
  payment_profile: apicontractsv1.customerPaymentProfileType,
105
- validate: bool = False,
106
+ validate: bool = True,
106
107
  ) -> ObjectifiedElement | None:
107
108
  """
108
109
  `updateCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-update-customer-payment-profile>`_.
109
110
 
110
111
  :param customer_profile_id: An Authorizenet customer profile id.
111
- :type customer_profile_id: :py:obj:`int`
112
+ :type customer_profile_id: int
112
113
  :param payment_profile_id: An Authorizenet customer payment profile id.
113
- :type payment_profile_id: :py:obj:`int`
114
+ :type payment_profile_id: int
114
115
  :param payment_profile: An Authorizenet payment profile element.
115
- :type payment_profile: :py:obj:`~authorizenet.apicontractsv1.customerPaymentProfileType`
116
- :param validate: Whether to validate the updated payment profile. Default is :py:obj:`False`.
117
- :type validate: :py:obj:`bool`
118
- :returns: An Authorizenet updateCustomerPaymentProfile response.
119
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
116
+ :type payment_profile: ~authorizenet.apicontractsv1.customerPaymentProfileType
117
+ :param validate: Whether to validate the payment profile. Default is True.
118
+ :type validate: bool
119
+ :returns: An Authorizenet updateCustomerPaymentProfileResponse element.
120
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
120
121
 
121
122
  """
122
123
  if not hasattr(payment_profile, "customerPaymentProfileId"):
@@ -141,11 +142,11 @@ def delete_customer_payment_profile(
141
142
  `deleteCustomerPaymentProfileRequest <https://developer.authorize.net/api/reference/index.html#customer-profiles-delete-customer-payment-profile>`_.
142
143
 
143
144
  :param customer_profile_id: An Authorizenet customer profile id.
144
- :type customer_profile_id: :py:obj:`int`
145
+ :type customer_profile_id: int
145
146
  :param payment_profile_id: An Authorizenet customer payment profile id.
146
- :type payment_profile_id: :py:obj:`int`
147
- :returns: An Authorizenet deleteCustomerPaymentProfile response.
148
- :rtype: :py:obj:`~lxml.objectify.ObjectifiedElement` | :py:obj:`None`
147
+ :type payment_profile_id: int
148
+ :returns: An Authorizenet deleteCustomerPaymentProfileResponse element.
149
+ :rtype: ~lxml.objectify.ObjectifiedElement | None
149
150
 
150
151
  """
151
152
  request = apicontractsv1.deleteCustomerPaymentProfileRequest()