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

- Removed the WHMCSBaseRequest class and its associated methods.
- Updated WHMCSBaseResponse, WHMCSErrorResponse, and WHMCSSuccessResponse classes to inherit from Pydantic's BaseModel.
- Implemented field validation using Pydantic's field validators.
- Simplified the to_dict and from_dict methods using Pydantic's built-in functionality.
- Enhanced error handling in the REST client and improved request methods.
- Added type hints and improved code readability throughout the client.
- Removed deprecated imports and unnecessary code.
- Added a py.typed file for type hinting support.

Author: willymwai

.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,26 @@
 # 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 specification presents each action as an independent path while routing all requests 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 specification presents
+each action as an independent path while routing all requests 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.4
-- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
+- Package version: 1.0.5
+- 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 +29,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,46 +46,71 @@ 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))
-
-try:
-    # Add a new client
-    api_response = api_instance.add_client()
-    pprint(api_response)
-except ApiException as e:
-    print("Exception when calling DefaultApi->add_client: %s\n" % e)
-
-# create an instance of the API class
-api_instance = whmcs_client.DefaultApi(whmcs_client.ApiClient(configuration))
-
-try:
-    # Create a new order
-    api_response = api_instance.add_order()
-    pprint(api_response)
-except ApiException as e:
-    print("Exception when calling DefaultApi->add_order: %s\n" % e)
-
-# create an instance of the API class
-api_instance = whmcs_client.DefaultApi(whmcs_client.ApiClient(configuration))
-
-try:
-    # Update client details
-    api_response = api_instance.update_client()
-    pprint(api_response)
-except ApiException as e:
-    print("Exception when calling DefaultApi->update_client: %s\n" % e)
+# 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
+    password = 'password_example' # str | Admin password/API secret
+    action = AddClient # str | Must be 'AddClient' (default to AddClient)
+    firstname = 'firstname_example' # str | First name of the client
+    lastname = 'lastname_example' # str | Last name of the client
+    email = 'email_example' # str | Email address of the client
+    address1 = 'address1_example' # str | Address line 1
+    city = 'city_example' # str | City
+    state = 'state_example' # str | State
+    postcode = 'postcode_example' # str | Postal code
+    country = 'country_example' # str | 2 character ISO country code
+    phonenumber = 'phonenumber_example' # str | Phone number
+    accesskey = 'accesskey_example' # str | Optional API access key (optional)
+    responsetype = json # str | Response format (optional) (default to json)
+    owner_user_id = 56 # int | The ID of the user that should own the client (optional)
+    companyname = 'companyname_example' # str | Company name (optional)
+    address2 = 'address2_example' # str | Address line 2 (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' # str | Base64 encoded serialized array of custom field values (optional)
+    language = 'language_example' # str | Default language setting (optional)
+    clientip = 'clientip_example' # str | Originating IP address (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)
+
+    try:
+        # Add a new client
+        api_response = api_instance.add_client(username, password, action, firstname, lastname, email, address1, city, state, postcode, country, phonenumber, accesskey=accesskey, responsetype=responsetype, owner_user_id=owner_user_id, companyname=companyname, address2=address2, 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)
+        print("The response of DefaultApi->add_client:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling DefaultApi->add_client: %s\n" % e)
+
 ```
 
 ## Documentation for API Endpoints
@@ -92,27 +123,25 @@ Class | Method | HTTP request | Description
 *DefaultApi* | [**add_order**](docs/DefaultApi.md#add_order) | **POST** /AddOrder | Create a new order
 *DefaultApi* | [**update_client**](docs/DefaultApi.md#update_client) | **POST** /UpdateClient | Update client details
 
+
 ## Documentation For Models
 
- - [AddClientBody](docs/AddClientBody.md)
- - [AddClientRequest](docs/AddClientRequest.md)
  - [AddClientResponse](docs/AddClientResponse.md)
- - [AddOrderBody](docs/AddOrderBody.md)
- - [AddOrderRequest](docs/AddOrderRequest.md)
  - [AddOrderResponse](docs/AddOrderResponse.md)
- - [UpdateClientBody](docs/UpdateClientBody.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.4",
+  "packageVersion": "1.0.5",
   "packageUrl": "https://github.com/truehostcloud/whmcs-python-client",
   "packageCompany": "Truehost",
   "packageAuthor": "William Mwai",