Bump package version to 1.0.4 and update action descriptions in response models

willymwai · willymwai · commit 0afd6af75a6a · 2025-06-04T08:59:48.000+03:00
diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml
@@ -37,10 +37,25 @@ jobs:
         with:
           name: release-dists
           path: dist/
+
   pypi-publish:
     runs-on: ubuntu-latest
     needs:
       - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/YOURPROJECT
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
 
     steps:
       - name: Retrieve release distributions
@@ -52,6 +67,4 @@ jobs:
       - name: Publish release distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
           packages-dir: dist/
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -1,6 +1,7 @@
 .github/workflows/python.yml
 .gitignore
 .gitlab-ci.yml
+.openapi-generator-ignore
 .travis.yml
 README.md
 docs/AddClientResponse.md
@@ -17,6 +18,13 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
+test/test_add_client_response.py
+test/test_add_order_response.py
+test/test_default_api.py
+test/test_update_client_response.py
+test/test_whmcs_base_response.py
+test/test_whmcs_error_response.py
+test/test_whmcs_success_response.py
 tox.ini
 whmcs_client/__init__.py
 whmcs_client/api/__init__.py
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@ 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.3
+- Package version: 1.0.4
 - Generator version: 7.13.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
diff --git a/config.json b/config.json
@@ -1,7 +1,7 @@
 {
   "packageName": "whmcs_client",
   "projectName": "whmcs-api-client",
-  "packageVersion": "1.0.3",
+  "packageVersion": "1.0.4",
   "packageUrl": "https://github.com/truehostcloud/whmcs-python-client",
   "packageCompany": "Truehost",
   "packageAuthor": "William Mwai",
diff --git a/docs/AddClientResponse.md b/docs/AddClientResponse.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **result** | **str** | The result of the operation | 
-**action** | **str** | Always &#39;AddClient&#39; for AddClient responses | 
+**action** | **str** | The action that was performed | 
 **warnings** | **List[str]** | Any warning messages | [optional] 
 **message** | **str** | Success or error message | [optional] 
 **clientid** | **str** | The ID of the newly created client | [optional] 
diff --git a/docs/AddOrderResponse.md b/docs/AddOrderResponse.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **result** | **str** | The result of the operation | 
-**action** | **str** | Always &#39;AddOrder&#39; for AddOrder responses | 
+**action** | **str** | The action that was performed | 
 **warnings** | **List[str]** | Any warning messages | [optional] 
 **message** | **str** | Success or error message | [optional] 
 **orderid** | **str** | The Order ID for the created order | [optional] 
diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md
@@ -15,8 +15,6 @@ Execute WHMCS API action
 Executes a WHMCS API action. The specific action is determined by the 'action' field
 in the request body. Different actions have different required and optional parameters.
 
-Authentication credentials (username/password or API key) must be included in every request.
-
 
 ### Example
 
diff --git a/docs/UpdateClientResponse.md b/docs/UpdateClientResponse.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **result** | **str** | The result of the operation | 
-**action** | **str** | Always &#39;UpdateClient&#39; for UpdateClient responses | 
+**action** | **str** | The action that was performed | 
 **warnings** | **List[str]** | Any warning messages | [optional] 
 **message** | **str** | Success or error message | [optional] 
 **clientid** | **str** | The ID of the updated client | [optional] 
diff --git a/docs/WHMCSSuccessResponse.md b/docs/WHMCSSuccessResponse.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **result** | **str** | The result of the operation | 
-**action** | **str** | Always &#39;AddOrder&#39; for AddOrder responses | 
+**action** | **str** | The action that was performed | 
 **warnings** | **List[str]** | Any warning messages | [optional] 
 **message** | **str** | Success or error message | [optional] 
 **clientid** | **str** | The ID of the updated client | [optional] 
diff --git a/openapi.yaml b/openapi.yaml
@@ -23,15 +23,22 @@ paths:
       description: |
         Executes a WHMCS API action. The specific action is determined by the 'action' field
         in the request body. Different actions have different required and optional parameters.
-        
-        Authentication credentials (username/password or API key) must be included in every request.
       operationId: api_post
       requestBody:
         required: true
         content:
           application/x-www-form-urlencoded:
             schema:
-              $ref: '#/components/schemas/RequestBody'
+              oneOf:
+                - $ref: '#/components/schemas/AddClientRequest'
+                - $ref: '#/components/schemas/UpdateClientRequest'
+                - $ref: '#/components/schemas/AddOrderRequest'
+              discriminator:
+                propertyName: action
+                mapping:
+                  AddClient: '#/components/schemas/AddClientRequest'
+                  UpdateClient: '#/components/schemas/UpdateClientRequest'
+                  AddOrder: '#/components/schemas/AddOrderRequest'
       responses:
         '200':
           description: Successful response
@@ -568,22 +575,12 @@ components:
         - $ref: '#/components/schemas/AddClientResponse'
         - $ref: '#/components/schemas/UpdateClientResponse'
         - $ref: '#/components/schemas/AddOrderResponse'
-      discriminator:
-        propertyName: action
-        mapping:
-          AddClient: '#/components/schemas/AddClientResponse'
-          UpdateClient: '#/components/schemas/UpdateClientResponse'
-          AddOrder: '#/components/schemas/AddOrderResponse'
 
     AddClientResponse:
       allOf:
         - $ref: '#/components/schemas/WHMCSBaseResponse'
         - type: object
           properties:
-            action:
-              type: string
-              enum: [AddClient]
-              description: Always 'AddClient' for AddClient responses
             clientid:
               type: string
               description: The ID of the newly created client
@@ -593,10 +590,6 @@ components:
         - $ref: '#/components/schemas/WHMCSBaseResponse'
         - type: object
           properties:
-            action:
-              type: string
-              enum: [UpdateClient]
-              description: Always 'UpdateClient' for UpdateClient responses
             clientid:
               type: string
               description: The ID of the updated client
@@ -606,10 +599,6 @@ components:
         - $ref: '#/components/schemas/WHMCSBaseResponse'
         - type: object
           properties:
-            action:
-              type: string
-              enum: [AddOrder]
-              description: Always 'AddOrder' for AddOrder responses
             orderid:
               type: string
               description: The Order ID for the created order
@@ -640,15 +629,3 @@ components:
           type: string
           description: Error message describing what went wrong
           example: "Authentication Failed"
-
-    RequestBody:
-      oneOf:
-        - $ref: '#/components/schemas/AddClientRequest'
-        - $ref: '#/components/schemas/UpdateClientRequest'
-        - $ref: '#/components/schemas/AddOrderRequest'
-      discriminator:
-        propertyName: action
-        mapping:
-          AddClient: '#/components/schemas/AddClientRequest'
-          UpdateClient: '#/components/schemas/UpdateClientRequest'
-          AddOrder: '#/components/schemas/AddOrderRequest'
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "whmcs_client"
-version = "1.0.3"
+version = "1.0.4"
 description = "WHMCS API"
 authors = ["OpenAPI Generator Community <team@openapitools.org>"]
 license = "NoLicense"
diff --git a/setup.py b/setup.py
@@ -21,7 +21,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "whmcs-api-client"
-VERSION = "1.0.3"
+VERSION = "1.0.4"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",
diff --git a/test/test_add_client_response.py b/test/test_add_client_response.py
@@ -36,7 +36,7 @@ def make_instance(self, include_optional) -> AddClientResponse:
         if include_optional:
             return AddClientResponse(
                 result = 'success',
-                action = 'AddClient',
+                action = '',
                 warnings = [
                     ''
                     ],
@@ -46,7 +46,7 @@ def make_instance(self, include_optional) -> AddClientResponse:
         else:
             return AddClientResponse(
                 result = 'success',
-                action = 'AddClient',
+                action = '',
         )
         """
 
diff --git a/test/test_add_order_response.py b/test/test_add_order_response.py
@@ -36,7 +36,7 @@ def make_instance(self, include_optional) -> AddOrderResponse:
         if include_optional:
             return AddOrderResponse(
                 result = 'success',
-                action = 'AddOrder',
+                action = '',
                 warnings = [
                     ''
                     ],
@@ -50,7 +50,7 @@ def make_instance(self, include_optional) -> AddOrderResponse:
         else:
             return AddOrderResponse(
                 result = 'success',
-                action = 'AddOrder',
+                action = '',
         )
         """
 
diff --git a/test/test_update_client_response.py b/test/test_update_client_response.py
@@ -36,7 +36,7 @@ def make_instance(self, include_optional) -> UpdateClientResponse:
         if include_optional:
             return UpdateClientResponse(
                 result = 'success',
-                action = 'UpdateClient',
+                action = '',
                 warnings = [
                     ''
                     ],
@@ -46,7 +46,7 @@ def make_instance(self, include_optional) -> UpdateClientResponse:
         else:
             return UpdateClientResponse(
                 result = 'success',
-                action = 'UpdateClient',
+                action = '',
         )
         """
 
diff --git a/test/test_whmcs_success_response.py b/test/test_whmcs_success_response.py
@@ -36,7 +36,7 @@ def make_instance(self, include_optional) -> WHMCSSuccessResponse:
         if include_optional:
             return WHMCSSuccessResponse(
                 result = 'success',
-                action = 'AddOrder',
+                action = '',
                 warnings = [
                     ''
                     ],
@@ -51,7 +51,7 @@ def make_instance(self, include_optional) -> WHMCSSuccessResponse:
         else:
             return WHMCSSuccessResponse(
                 result = 'success',
-                action = 'AddOrder',
+                action = '',
         )
         """
 
diff --git a/whmcs_client/__init__.py b/whmcs_client/__init__.py
@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "1.0.3"
+__version__ = "1.0.4"
 
 # import apis into sdk package
 from whmcs_client.api.default_api import DefaultApi
diff --git a/whmcs_client/api/default_api.py b/whmcs_client/api/default_api.py
@@ -146,7 +146,7 @@ def api_post(
     ) -> WHMCSSuccessResponse:
         """Execute WHMCS API action
 
-        Executes a WHMCS API action. The specific action is determined by the 'action' field in the request body. Different actions have different required and optional parameters.  Authentication credentials (username/password or API key) must be included in every request. 
+        Executes a WHMCS API action. The specific action is determined by the 'action' field in the request body. Different actions have different required and optional parameters. 
 
         :param username: Admin username/API identifier
         :type username: str
@@ -571,7 +571,7 @@ def api_post_with_http_info(
     ) -> ApiResponse[WHMCSSuccessResponse]:
         """Execute WHMCS API action
 
-        Executes a WHMCS API action. The specific action is determined by the 'action' field in the request body. Different actions have different required and optional parameters.  Authentication credentials (username/password or API key) must be included in every request. 
+        Executes a WHMCS API action. The specific action is determined by the 'action' field in the request body. Different actions have different required and optional parameters. 
 
         :param username: Admin username/API identifier
         :type username: str
@@ -996,7 +996,7 @@ def api_post_without_preload_content(
     ) -> RESTResponseType:
         """Execute WHMCS API action
 
-        Executes a WHMCS API action. The specific action is determined by the 'action' field in the request body. Different actions have different required and optional parameters.  Authentication credentials (username/password or API key) must be included in every request. 
+        Executes a WHMCS API action. The specific action is determined by the 'action' field in the request body. Different actions have different required and optional parameters. 
 
         :param username: Admin username/API identifier
         :type username: str
diff --git a/whmcs_client/api_client.py b/whmcs_client/api_client.py
@@ -90,7 +90,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/1.0.3/python'
+        self.user_agent = 'OpenAPI-Generator/1.0.4/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):
diff --git a/whmcs_client/configuration.py b/whmcs_client/configuration.py
@@ -501,7 +501,7 @@ def to_debug_report(self) -> str:
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.0.0\n"\
-               "SDK Package Version: 1.0.3".\
+               "SDK Package Version: 1.0.4".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:
diff --git a/whmcs_client/models/add_client_response.py b/whmcs_client/models/add_client_response.py
@@ -27,7 +27,7 @@ class AddClientResponse(BaseModel):
     AddClientResponse
     """ # noqa: E501
     result: StrictStr = Field(description="The result of the operation")
-    action: StrictStr = Field(description="Always 'AddClient' for AddClient responses")
+    action: StrictStr = Field(description="The action that was performed")
     warnings: Optional[List[StrictStr]] = Field(default=None, description="Any warning messages")
     message: Optional[StrictStr] = Field(default=None, description="Success or error message")
     clientid: Optional[StrictStr] = Field(default=None, description="The ID of the newly created client")
@@ -40,13 +40,6 @@ def result_validate_enum(cls, value):
             raise ValueError("must be one of enum values ('success', 'error')")
         return value
 
-    @field_validator('action')
-    def action_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['AddClient']):
-            raise ValueError("must be one of enum values ('AddClient')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
diff --git a/whmcs_client/models/add_order_response.py b/whmcs_client/models/add_order_response.py
@@ -27,7 +27,7 @@ class AddOrderResponse(BaseModel):
     AddOrderResponse
     """ # noqa: E501
     result: StrictStr = Field(description="The result of the operation")
-    action: StrictStr = Field(description="Always 'AddOrder' for AddOrder responses")
+    action: StrictStr = Field(description="The action that was performed")
     warnings: Optional[List[StrictStr]] = Field(default=None, description="Any warning messages")
     message: Optional[StrictStr] = Field(default=None, description="Success or error message")
     orderid: Optional[StrictStr] = Field(default=None, description="The Order ID for the created order")
@@ -44,13 +44,6 @@ def result_validate_enum(cls, value):
             raise ValueError("must be one of enum values ('success', 'error')")
         return value
 
-    @field_validator('action')
-    def action_validate_enum(cls, value):
-        """Validates the enum"""
-        if value not in set(['AddOrder']):
-            raise ValueError("must be one of enum values ('AddOrder')")
-        return value
-
     model_config = ConfigDict(
         populate_by_name=True,
         validate_assignment=True,
diff --git a/whmcs_client/models/update_client_response.py b/whmcs_client/models/update_client_response.py
diff --git a/whmcs_client/models/whmcs_success_response.py b/whmcs_client/models/whmcs_success_response.py

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"packageName": "whmcs_client",`
`3`	`3`	`"projectName": "whmcs-api-client",`
`4`		`- "packageVersion": "1.0.3",`
	`4`	`+ "packageVersion": "1.0.4",`
`5`	`5`	`"packageUrl": "https://github.com/truehostcloud/whmcs-python-client",`
`6`	`6`	`"packageCompany": "Truehost",`
`7`	`7`	`"packageAuthor": "William Mwai",`