feat: Update package version to 1.0.9 and add currency-related API functionality

- Updated package version in config.json, pyproject.toml, setup.py, and __init__.py to 1.0.9.
- Added CurrencyInfo model to represent currency details.
- Introduced GetCurrenciesResponse and GetCurrenciesResponseAllOfCurrencies models for handling currency API responses.
- Implemented get_currencies API endpoint in DefaultApi to retrieve configured currencies.
- Added documentation for the new currency models and API endpoint.
- Created unit tests for CurrencyInfo, GetCurrenciesResponse, and GetCurrenciesResponseAllOfCurrencies models.
- Updated openapi.yaml to include new endpoint and response schemas.

Author: willymwai

.openapi-generator/FILES

@@ -6,9 +6,12 @@ README.md
 docs/AddClientResponse.md
 docs/AddOrderResponse.md
 docs/ClientInfo.md
+docs/CurrencyInfo.md
 docs/DefaultApi.md
 docs/GetClientsResponse.md
 docs/GetClientsResponseAllOfClients.md
+docs/GetCurrenciesResponse.md
+docs/GetCurrenciesResponseAllOfCurrencies.md
 docs/UpdateClientResponse.md
 docs/WHMCSBaseResponse.md
 docs/WHMCSErrorResponse.md
@@ -20,6 +23,9 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_currency_info.py
+test/test_get_currencies_response.py
+test/test_get_currencies_response_all_of_currencies.py
 tox.ini
 whmcs_client/__init__.py
 whmcs_client/api/__init__.py
@@ -32,8 +38,11 @@ whmcs_client/models/__init__.py
 whmcs_client/models/add_client_response.py
 whmcs_client/models/add_order_response.py
 whmcs_client/models/client_info.py
+whmcs_client/models/currency_info.py
 whmcs_client/models/get_clients_response.py
 whmcs_client/models/get_clients_response_all_of_clients.py
+whmcs_client/models/get_currencies_response.py
+whmcs_client/models/get_currencies_response_all_of_currencies.py
 whmcs_client/models/update_client_response.py
 whmcs_client/models/whmcs_base_response.py
 whmcs_client/models/whmcs_error_response.py

README.md

@@ -9,7 +9,7 @@ each action as an independent path while routing all requests to the /api.php en
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 1.0.8
+- Package version: 1.0.9
 - Generator version: 7.13.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -121,6 +121,7 @@ Class | Method | HTTP request | Description
 *DefaultApi* | [**add_client**](docs/DefaultApi.md#add_client) | **POST** /api.php?action=AddClient | Add a new client
 *DefaultApi* | [**add_order**](docs/DefaultApi.md#add_order) | **POST** /api.php?action=AddOrder | Create a new order
 *DefaultApi* | [**get_clients**](docs/DefaultApi.md#get_clients) | **POST** /api.php?action=GetClients | Get clients
+*DefaultApi* | [**get_currencies**](docs/DefaultApi.md#get_currencies) | **POST** /api.php?action=GetCurrencies | Get currencies
 *DefaultApi* | [**update_client**](docs/DefaultApi.md#update_client) | **POST** /api.php?action=UpdateClient | Update client details
 
 
@@ -129,8 +130,11 @@ Class | Method | HTTP request | Description
  - [AddClientResponse](docs/AddClientResponse.md)
  - [AddOrderResponse](docs/AddOrderResponse.md)
  - [ClientInfo](docs/ClientInfo.md)
+ - [CurrencyInfo](docs/CurrencyInfo.md)
  - [GetClientsResponse](docs/GetClientsResponse.md)
  - [GetClientsResponseAllOfClients](docs/GetClientsResponseAllOfClients.md)
+ - [GetCurrenciesResponse](docs/GetCurrenciesResponse.md)
+ - [GetCurrenciesResponseAllOfCurrencies](docs/GetCurrenciesResponseAllOfCurrencies.md)
  - [UpdateClientResponse](docs/UpdateClientResponse.md)
  - [WHMCSBaseResponse](docs/WHMCSBaseResponse.md)
  - [WHMCSErrorResponse](docs/WHMCSErrorResponse.md)

config.json

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

docs/CurrencyInfo.md

@@ -0,0 +1,34 @@
+# CurrencyInfo
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** | The currency ID | [optional] 
+**code** | **str** | The currency code (e.g., USD, EUR, GBP) | [optional] 
+**prefix** | **str** | The currency prefix symbol (e.g., $, €, £) | [optional] 
+**suffix** | **str** | The currency suffix (e.g., \" USD\") | [optional] 
+**format** | **int** | The currency format setting | [optional] 
+**rate** | **str** | The currency exchange rate | [optional] 
+
+## Example
+
+```python
+from whmcs_client.models.currency_info import CurrencyInfo
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CurrencyInfo from a JSON string
+currency_info_instance = CurrencyInfo.from_json(json)
+# print the JSON string representation of the object
+print(CurrencyInfo.to_json())
+
+# convert the object into a dict
+currency_info_dict = currency_info_instance.to_dict()
+# create an instance of CurrencyInfo from a dict
+currency_info_from_dict = CurrencyInfo.from_dict(currency_info_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/DefaultApi.md

@@ -7,6 +7,7 @@ Method | HTTP request | Description
 [**add_client**](DefaultApi.md#add_client) | **POST** /api.php?action=AddClient | Add a new client
 [**add_order**](DefaultApi.md#add_order) | **POST** /api.php?action=AddOrder | Create a new order
 [**get_clients**](DefaultApi.md#get_clients) | **POST** /api.php?action=GetClients | Get clients
+[**get_currencies**](DefaultApi.md#get_currencies) | **POST** /api.php?action=GetCurrencies | Get currencies
 [**update_client**](DefaultApi.md#update_client) | **POST** /api.php?action=UpdateClient | Update client details
 
 
@@ -387,6 +388,81 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **get_currencies**
+> GetCurrenciesResponse get_currencies(username, password, accesskey=accesskey, responsetype=responsetype)
+
+Get currencies
+
+Obtain the currencies configured in the system
+
+### Example
+
+
+```python
+import whmcs_client
+from whmcs_client.models.get_currencies_response import GetCurrenciesResponse
+from whmcs_client.rest import ApiException
+from pprint import pprint
+
+# 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
+    accesskey = 'accesskey_example' # str | Optional API access key (optional)
+    responsetype = json # str | Response format (optional) (default to json)
+
+    try:
+        # Get currencies
+        api_response = api_instance.get_currencies(username, password, accesskey=accesskey, responsetype=responsetype)
+        print("The response of DefaultApi->get_currencies:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling DefaultApi->get_currencies: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **username** | **str**| Admin username/API identifier | 
+ **password** | **str**| Admin password/API secret | 
+ **accesskey** | **str**| Optional API access key | [optional] 
+ **responsetype** | **str**| Response format | [optional] [default to json]
+
+### Return type
+
+[**GetCurrenciesResponse**](GetCurrenciesResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Currencies retrieved successfully |  -  |
+**0** | Error response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **update_client**
 > UpdateClientResponse update_client(username, password, clientid, accesskey=accesskey, responsetype=responsetype, clientemail=clientemail, 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, 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)
 

docs/GetCurrenciesResponse.md

@@ -0,0 +1,32 @@
+# GetCurrenciesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**result** | **str** |  | [optional] 
+**message** | **str** | Response message | [optional] 
+**totalresults** | **int** | The total number of currencies available | [optional] 
+**currencies** | [**GetCurrenciesResponseAllOfCurrencies**](GetCurrenciesResponseAllOfCurrencies.md) |  | [optional] 
+
+## Example
+
+```python
+from whmcs_client.models.get_currencies_response import GetCurrenciesResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetCurrenciesResponse from a JSON string
+get_currencies_response_instance = GetCurrenciesResponse.from_json(json)
+# print the JSON string representation of the object
+print(GetCurrenciesResponse.to_json())
+
+# convert the object into a dict
+get_currencies_response_dict = get_currencies_response_instance.to_dict()
+# create an instance of GetCurrenciesResponse from a dict
+get_currencies_response_from_dict = GetCurrenciesResponse.from_dict(get_currencies_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/GetCurrenciesResponseAllOfCurrencies.md

@@ -0,0 +1,29 @@
+# GetCurrenciesResponseAllOfCurrencies
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | [**List[CurrencyInfo]**](CurrencyInfo.md) | Array of currency information | [optional] 
+
+## Example
+
+```python
+from whmcs_client.models.get_currencies_response_all_of_currencies import GetCurrenciesResponseAllOfCurrencies
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of GetCurrenciesResponseAllOfCurrencies from a JSON string
+get_currencies_response_all_of_currencies_instance = GetCurrenciesResponseAllOfCurrencies.from_json(json)
+# print the JSON string representation of the object
+print(GetCurrenciesResponseAllOfCurrencies.to_json())
+
+# convert the object into a dict
+get_currencies_response_all_of_currencies_dict = get_currencies_response_all_of_currencies_instance.to_dict()
+# create an instance of GetCurrenciesResponseAllOfCurrencies from a dict
+get_currencies_response_all_of_currencies_from_dict = GetCurrenciesResponseAllOfCurrencies.from_dict(get_currencies_response_all_of_currencies_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

openapi.yaml

@@ -106,6 +106,27 @@ paths:
         default:
           $ref: '#/components/responses/Error'
 
+  /api.php?action=GetCurrencies:
+    post:
+      summary: Get currencies
+      description: Obtain the currencies configured in the system
+      operationId: getCurrencies
+      requestBody:
+        required: true
+        content:
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/WHMCSBaseRequest'
+      responses:
+        '200':
+          description: Currencies retrieved successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetCurrenciesResponse'
+        default:
+          $ref: '#/components/responses/Error'
+
 components:
   schemas:
     WHMCSBaseRequest:
@@ -668,6 +689,23 @@ components:
                     $ref: '#/components/schemas/ClientInfo'
                   description: Array of client information
 
+    GetCurrenciesResponse:
+      allOf:
+        - $ref: '#/components/schemas/WHMCSSuccessResponse'
+        - type: object
+          properties:
+            totalresults:
+              type: integer
+              description: The total number of currencies available
+            currencies:
+              type: object
+              properties:
+                currency:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/CurrencyInfo'
+                  description: Array of currency information
+
     ClientInfo:
       type: object
       properties:
@@ -697,6 +735,28 @@ components:
           type: string
           description: The client's status (Active, Inactive, Closed)
 
+    CurrencyInfo:
+      type: object
+      properties:
+        id:
+          type: integer
+          description: The currency ID
+        code:
+          type: string
+          description: The currency code (e.g., USD, EUR, GBP)
+        prefix:
+          type: string
+          description: The currency prefix symbol (e.g., $, €, £)
+        suffix:
+          type: string
+          description: The currency suffix (e.g., " USD")
+        format:
+          type: integer
+          description: The currency format setting
+        rate:
+          type: string
+          description: The currency exchange rate
+
   responses:
     Error:
       description: Error response

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "whmcs_client"
-version = "1.0.8"
+version = "1.0.9"
 description = "WHMCS API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"

setup.py

@@ -21,7 +21,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "whmcs-api-client"
-VERSION = "1.0.8"
+VERSION = "1.0.9"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",