Refactor WHMCS API client models to use Pydantic for data validation and serialization

- Updated WHMCSBaseResponse, WHMCSErrorResponse, and WHMCSSuccessResponse classes to inherit from Pydantic's BaseModel.
- Implemented field validation using Pydantic's field_validator for result attributes.
- Added methods for JSON serialization and deserialization in response models.
- Removed old Swagger-generated code and replaced it with Pydantic's functionality for better type safety and validation.
- Enhanced REST client to support SOCKS proxies and improved request handling.
- Cleaned up and optimized the request method in RESTClientObject for better readability and maintainability.
- Added type hints and improved documentation throughout the codebase.

Author: willymwai

.github/workflows/python.yml

@@ -0,0 +1,31 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: whmcs_client Python package
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r test-requirements.txt
+      - name: Test with pytest
+        run: |
+          pytest --cov=whmcs_client

.gitignore

@@ -45,7 +45,9 @@ coverage.xml
 *,cover
 .hypothesis/
 venv/
+.venv/
 .python-version
+.pytest_cache
 
 # Translations
 *.mo

.gitlab-ci.yml

@@ -0,0 +1,31 @@
+# NOTE: This file is auto generated by OpenAPI Generator.
+# URL: https://openapi-generator.tech
+#
+# ref: https://docs.gitlab.com/ee/ci/README.html
+# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
+
+stages:
+  - test
+
+.pytest:
+  stage: test
+  script:
+   - pip install -r requirements.txt
+   - pip install -r test-requirements.txt
+   - pytest --cov=whmcs_client
+
+pytest-3.9:
+  extends: .pytest
+  image: python:3.9-alpine
+pytest-3.10:
+  extends: .pytest
+  image: python:3.10-alpine
+pytest-3.11:
+  extends: .pytest
+  image: python:3.11-alpine
+pytest-3.12:
+  extends: .pytest
+  image: python:3.12-alpine
+pytest-3.13:
+  extends: .pytest
+  image: python:3.13-alpine

.swagger-codegen-ignore .openapi-generator-ignore.swagger-codegen-ignore renamed to .openapi-generator-ignore

@@ -1,11 +1,11 @@
-# Swagger Codegen Ignore
-# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
 
 # Use this file to prevent files from being overwritten by the generator.
 # The patterns follow closely to .gitignore or .dockerignore.
 
 # As an example, the C# client generator defines ApiClient.cs.
-# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
 #ApiClient.cs
 
 # You can match any string of characters against a directory, file or extension with a single asterisk (*):

.openapi-generator/FILES

@@ -0,0 +1,36 @@
+.github/workflows/python.yml
+.gitignore
+.gitlab-ci.yml
+.travis.yml
+README.md
+docs/AddClientResponse.md
+docs/AddOrderResponse.md
+docs/DefaultApi.md
+docs/UpdateClientResponse.md
+docs/WHMCSBaseResponse.md
+docs/WHMCSErrorResponse.md
+docs/WHMCSSuccessResponse.md
+git_push.sh
+pyproject.toml
+requirements.txt
+setup.cfg
+setup.py
+test-requirements.txt
+test/__init__.py
+tox.ini
+whmcs_client/__init__.py
+whmcs_client/api/__init__.py
+whmcs_client/api/default_api.py
+whmcs_client/api_client.py
+whmcs_client/api_response.py
+whmcs_client/configuration.py
+whmcs_client/exceptions.py
+whmcs_client/models/__init__.py
+whmcs_client/models/add_client_response.py
+whmcs_client/models/add_order_response.py
+whmcs_client/models/update_client_response.py
+whmcs_client/models/whmcs_base_response.py
+whmcs_client/models/whmcs_error_response.py
+whmcs_client/models/whmcs_success_response.py
+whmcs_client/py.typed
+whmcs_client/rest.py

.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.13.0

.swagger-codegen/VERSION

@@ -1,13 +1,17 @@
 # ref: https://docs.travis-ci.com/user/languages/python
 language: python
 python:
-  - "3.2"
-  - "3.3"
-  - "3.4"
-  - "3.5"
-  #- "3.5-dev" # 3.5 development branch
-  #- "nightly" # points to the latest development branch e.g. 3.6-dev
+  - "3.9"
+  - "3.10"
+  - "3.11"
+  - "3.12"
+  - "3.13"
+  # uncomment the following if needed
+  #- "3.13-dev"  # 3.13 development branch
+  #- "nightly"  # nightly build
 # command to install dependencies
-install: "pip install -r requirements.txt"
+install:
+  - "pip install -r requirements.txt"
+  - "pip install -r test-requirements.txt"
 # command to run tests
-script: nosetests
+script: pytest --cov=whmcs_client

.travis.yml

@@ -1,20 +1,29 @@
 # whmcs-api-client
-Python client for the WHMCS API.  WHMCS (Web Host Manager Complete Solution) provides a single API endpoint that handles multiple operations through different 'action' parameters. This client supports various WHMCS operations for managing clients, orders, and other resources.  Authentication is handled through username/password or API credentials. All requests are sent as form-encoded data to the /api.php endpoint. 
+Python client for the WHMCS API.
 
-This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+WHMCS (Web Host Manager Complete Solution) provides a single API endpoint that handles
+multiple operations through different 'action' parameters. This client supports various
+WHMCS operations for managing clients, orders, and other resources.
+
+Authentication is handled through username/password or API credentials.
+All requests are sent as form-encoded data to the /api.php endpoint.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.0.2
-- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
+- Package version: 1.0.3
+- Generator version: 7.13.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 ## Requirements.
 
-Python 2.7 and 3.4+
+Python 3.9+
 
 ## Installation & Usage
 ### pip install
 
-If the python package is hosted on Github, you can install directly from Github
+If the python package is hosted on a repository, you can install directly using:
 
 ```sh
 pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
@@ -23,7 +32,7 @@ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
 
 Then import the package:
 ```python
-import whmcs_client 
+import whmcs_client
 ```
 
 ### Setuptools
@@ -40,26 +49,130 @@ Then import the package:
 import whmcs_client
 ```
 
+### Tests
+
+Execute `pytest` to run the tests.
+
 ## Getting Started
 
 Please follow the [installation procedure](#installation--usage) and then run the following:
 
 ```python
-from __future__ import print_function
-import time
+
 import whmcs_client
 from whmcs_client.rest import ApiException
 from pprint import pprint
 
-# create an instance of the API class
-api_instance = whmcs_client.DefaultApi(whmcs_client.ApiClient(configuration))
+# Defining the host is optional and defaults to https://your-whmcs-instance.com/includes
+# See configuration.py for a list of all supported configuration parameters.
+configuration = whmcs_client.Configuration(
+    host = "https://your-whmcs-instance.com/includes"
+)
+
+
+
+# Enter a context with an instance of the API client
+with whmcs_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = whmcs_client.DefaultApi(api_client)
+    username = 'username_example' # str | Admin username/API identifier (optional)
+    password = 'password_example' # str | Admin password/API secret (optional)
+    accesskey = 'accesskey_example' # str | Optional API access key (optional)
+    responsetype = json # str | Response format (optional) (default to json)
+    action = 'action_example' # str | Must be 'AddOrder' (optional)
+    owner_user_id = 56 # int | The ID of the user that should own the client (optional)
+    firstname = 'firstname_example' # str | First name of the client (optional)
+    lastname = 'lastname_example' # str | Last name of the client (optional)
+    companyname = 'companyname_example' # str | Company name (optional)
+    email = 'email_example' # str | Email address of the client (optional)
+    address1 = 'address1_example' # str | Address line 1 (optional)
+    address2 = 'address2_example' # str | Address line 2 (optional)
+    city = 'city_example' # str | City (optional)
+    state = 'state_example' # str | State (optional)
+    postcode = 'postcode_example' # str | Postal code (optional)
+    country = 'country_example' # str | 2 character ISO country code (optional)
+    phonenumber = 'phonenumber_example' # str | Phone number (optional)
+    tax_id = 'tax_id_example' # str | Client's tax ID (optional)
+    password2 = 'password2_example' # str | Password for the new user account (optional)
+    securityqid = 56 # int | Security question ID (optional)
+    securityqans = 'securityqans_example' # str | Security question answer (optional)
+    currency = 56 # int | Currency ID (optional)
+    groupid = 56 # int | Client group ID (optional)
+    customfields = ['customfields_example'] # List[str] | Array of base64 encoded serialized array of product custom field values (optional)
+    language = 'language_example' # str | Default language setting (optional)
+    clientip = 'clientip_example' # str | The IP address to associate with the order (optional)
+    notes = 'notes_example' # str | Admin only notes (optional)
+    marketingoptin = True # bool | Opt-in to marketing emails (optional)
+    noemail = True # bool | Set to true to suppress the Order Confirmation email being sent (optional)
+    skipvalidation = True # bool | Ignore required field validation (optional)
+    clientid = 56 # int | The ID of the client to add the order for (optional)
+    clientemail = 'clientemail_example' # str | The email address of the client to update (optional)
+    status = 'status_example' # str | The status (e.g., Active) (optional)
+    paymentmethod = 'paymentmethod_example' # str | The payment method for the order in the system format (e.g., paypal, mailin) (optional)
+    email_preferences_general = True # bool | Receive general emails (optional)
+    email_preferences_product = True # bool | Receive product emails (optional)
+    email_preferences_domain = True # bool | Receive domain emails (optional)
+    email_preferences_invoice = True # bool | Receive invoice emails (optional)
+    email_preferences_support = True # bool | Receive support emails (optional)
+    email_preferences_affiliate = True # bool | Receive affiliate emails (optional)
+    clearcreditcard = True # bool | Clear stored credit card details (optional)
+    latefeeoveride = True # bool | Override Late Fees setting (optional)
+    overideduenotices = True # bool | Override Overdue Notices setting (optional)
+    taxexempt = True # bool | Exempt from tax collections (optional)
+    separateinvoices = True # bool | Group items into one invoice (optional)
+    disableautocc = True # bool | Enable/disable automatic credit card processing (optional)
+    overrideautoclose = True # bool | Enable/disable automatic account closure (optional)
+    pid = [56] # List[int] | Array of product IDs to add to the order (optional)
+    qty = [56] # List[int] | Array of product quantities (optional)
+    domain = ['domain_example'] # List[str] | Array of domain names associated with the products/domains (optional)
+    billingcycle = ['billingcycle_example'] # List[str] | Array of billing cycles for the products (optional)
+    domaintype = ['domaintype_example'] # List[str] | For domain registrations, array of register or transfer values (optional)
+    regperiod = [56] # List[int] | For domain registrations, the registration periods for the domains (optional)
+    idnlanguage = ['idnlanguage_example'] # List[str] | For IDN domain registrations, the language codes for the domains (optional)
+    eppcode = ['eppcode_example'] # List[str] | For domain transfers, the EPP codes for the domains being transferred (optional)
+    nameserver1 = 'nameserver1_example' # str | The first nameserver to apply to all domains in the order (optional)
+    nameserver2 = 'nameserver2_example' # str | The second nameserver to apply to all domains in the order (optional)
+    nameserver3 = 'nameserver3_example' # str | The third nameserver to apply to all domains in the order (optional)
+    nameserver4 = 'nameserver4_example' # str | The fourth nameserver to apply to all domains in the order (optional)
+    nameserver5 = 'nameserver5_example' # str | The fifth nameserver to apply to all domains in the order (optional)
+    configoptions = ['configoptions_example'] # List[str] | Array of base64 encoded serialized array of product configurable options values (optional)
+    priceoverride = [3.4] # List[float] | Override the price of the product being ordered (optional)
+    promocode = 'promocode_example' # str | The promotion code to apply to the order (optional)
+    promooverride = True # bool | Should the promotion apply to the order even without matching promotional products (optional)
+    affid = 56 # int | The affiliate ID to associate with the order (optional)
+    noinvoice = True # bool | Set to true to suppress the invoice generating for the whole order (optional)
+    noinvoiceemail = True # bool | Set to true to suppress the Invoice Created email being sent for the order (optional)
+    addons = ['addons_example'] # List[str] | Array of comma separated lists of addons to create on order with the products (optional)
+    addonsqty = ['addonsqty_example'] # List[str] | Array of comma-separated lists of quantities for addons associated with products (optional)
+    hostname = ['hostname_example'] # List[str] | Array of hostnames for VPS/Dedicated Server orders (optional)
+    ns1prefix = ['ns1prefix_example'] # List[str] | Array of first nameserver prefixes for VPS/Dedicated servers (e.g., ns1 in ns1.hostname.com) (optional)
+    ns2prefix = ['ns2prefix_example'] # List[str] | Array of second nameserver prefixes for VPS/Dedicated servers (e.g., ns2 in ns2.hostname.com) (optional)
+    rootpw = ['rootpw_example'] # List[str] | Array of desired root passwords for VPS/Dedicated servers (optional)
+    contactid = 56 # int | The ID of the contact, associated with the client, that should apply to all domains in the order (optional)
+    dnsmanagement = [True] # List[bool] | Add DNS Management to the Domain Order (optional)
+    domainfields = ['domainfields_example'] # List[str] | Array of base64 encoded serialized array of TLD Specific Field Values (optional)
+    emailforwarding = [True] # List[bool] | Add Email Forwarding to the Domain Order (optional)
+    idprotection = [True] # List[bool] | Add ID Protection to the Domain Order (optional)
+    domainpriceoverride = [3.4] # List[float] | Override the price of the registration price on the domain being ordered (optional)
+    domainrenewoverride = [3.4] # List[float] | Override the price of the renewal price on the domain being ordered (optional)
+    domainrenewals = None # Dict[str, int] | A name -> value object of domainName -> renewalPeriod renewals to add an order for (optional)
+    addonid = 56 # int | The Addon ID for an Addon Only Order (optional)
+    addonidqty = 56 # int | The quantity of addons in an addon-only order (optional)
+    serviceid = 56 # int | The service ID for the addon only order (optional)
+    addonids = [56] # List[int] | Array of addon IDs for an Addon Only Order (optional)
+    addonidsqty = [56] # List[int] | Array of quantities for an addon-only order (optional)
+    serviceids = [56] # List[int] | Array of service IDs to associate the addons for an Addon Only order (optional)
+    servicerenewals = [56] # List[int] | Array of service IDs to be on-demand renewed (optional)
+    addonrenewals = [56] # List[int] | Array of service addon IDs to be on-demand renewed (optional)
+
+    try:
+        # Execute WHMCS API action
+        api_response = api_instance.api_post(username=username, password=password, accesskey=accesskey, responsetype=responsetype, action=action, owner_user_id=owner_user_id, firstname=firstname, lastname=lastname, companyname=companyname, email=email, address1=address1, address2=address2, city=city, state=state, postcode=postcode, country=country, phonenumber=phonenumber, tax_id=tax_id, password2=password2, securityqid=securityqid, securityqans=securityqans, currency=currency, groupid=groupid, customfields=customfields, language=language, clientip=clientip, notes=notes, marketingoptin=marketingoptin, noemail=noemail, skipvalidation=skipvalidation, clientid=clientid, clientemail=clientemail, status=status, paymentmethod=paymentmethod, email_preferences_general=email_preferences_general, email_preferences_product=email_preferences_product, email_preferences_domain=email_preferences_domain, email_preferences_invoice=email_preferences_invoice, email_preferences_support=email_preferences_support, email_preferences_affiliate=email_preferences_affiliate, clearcreditcard=clearcreditcard, latefeeoveride=latefeeoveride, overideduenotices=overideduenotices, taxexempt=taxexempt, separateinvoices=separateinvoices, disableautocc=disableautocc, overrideautoclose=overrideautoclose, pid=pid, qty=qty, domain=domain, billingcycle=billingcycle, domaintype=domaintype, regperiod=regperiod, idnlanguage=idnlanguage, eppcode=eppcode, nameserver1=nameserver1, nameserver2=nameserver2, nameserver3=nameserver3, nameserver4=nameserver4, nameserver5=nameserver5, configoptions=configoptions, priceoverride=priceoverride, promocode=promocode, promooverride=promooverride, affid=affid, noinvoice=noinvoice, noinvoiceemail=noinvoiceemail, addons=addons, addonsqty=addonsqty, hostname=hostname, ns1prefix=ns1prefix, ns2prefix=ns2prefix, rootpw=rootpw, contactid=contactid, dnsmanagement=dnsmanagement, domainfields=domainfields, emailforwarding=emailforwarding, idprotection=idprotection, domainpriceoverride=domainpriceoverride, domainrenewoverride=domainrenewoverride, domainrenewals=domainrenewals, addonid=addonid, addonidqty=addonidqty, serviceid=serviceid, addonids=addonids, addonidsqty=addonidsqty, serviceids=serviceids, servicerenewals=servicerenewals, addonrenewals=addonrenewals)
+        print("The response of DefaultApi->api_post:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling DefaultApi->api_post: %s\n" % e)
 
-try:
-    # Execute WHMCS API action
-    api_response = api_instance.api_post()
-    pprint(api_response)
-except ApiException as e:
-    print("Exception when calling DefaultApi->api_post: %s\n" % e)
 ```
 
 ## Documentation for API Endpoints
@@ -70,25 +183,25 @@ Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
 *DefaultApi* | [**api_post**](docs/DefaultApi.md#api_post) | **POST** /api.php | Execute WHMCS API action
 
+
 ## Documentation For Models
 
- - [AddClientRequest](docs/AddClientRequest.md)
  - [AddClientResponse](docs/AddClientResponse.md)
- - [AddOrderRequest](docs/AddOrderRequest.md)
  - [AddOrderResponse](docs/AddOrderResponse.md)
- - [RequestBody](docs/RequestBody.md)
- - [UpdateClientRequest](docs/UpdateClientRequest.md)
  - [UpdateClientResponse](docs/UpdateClientResponse.md)
- - [WHMCSBaseRequest](docs/WHMCSBaseRequest.md)
  - [WHMCSBaseResponse](docs/WHMCSBaseResponse.md)
  - [WHMCSErrorResponse](docs/WHMCSErrorResponse.md)
  - [WHMCSSuccessResponse](docs/WHMCSSuccessResponse.md)
 
+
+<a id="documentation-for-authorization"></a>
 ## Documentation For Authorization
 
- All endpoints do not require authorization.
+Endpoints do not require authorization.
 
 
 ## Author
 
 
+
+

README.md

@@ -1,7 +1,7 @@
 {
   "packageName": "whmcs_client",
   "projectName": "whmcs-api-client",
-  "packageVersion": "1.0.2",
+  "packageVersion": "1.0.3",
   "packageUrl": "https://github.com/truehostcloud/whmcs-python-client",
   "packageCompany": "Truehost",
   "packageAuthor": "William Mwai",