Skip to content

Commit 208d8fd

Browse files
committed
refactor: Remove deprecated client ID models and update related documentation
1 parent 3e1fb45 commit 208d8fd

File tree

11 files changed

+45
-73
lines changed

11 files changed

+45
-73
lines changed

.openapi-generator/FILES

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
.travis.yml
55
README.md
66
docs/AddClientResponse.md
7-
docs/AddClientResponseAllOfClientid.md
8-
docs/AddOrderRequestClientid.md
97
docs/AddOrderResponse.md
108
docs/ClientInfo.md
119
docs/CurrencyInfo.md
@@ -14,9 +12,7 @@ docs/GetClientsResponse.md
1412
docs/GetClientsResponseAllOfClients.md
1513
docs/GetCurrenciesResponse.md
1614
docs/GetCurrenciesResponseAllOfCurrencies.md
17-
docs/UpdateClientRequestClientid.md
1815
docs/UpdateClientResponse.md
19-
docs/UpdateClientResponseAllOfClientid.md
2016
docs/WHMCSBaseResponse.md
2117
docs/WHMCSErrorResponse.md
2218
docs/WHMCSSuccessResponse.md
@@ -37,18 +33,14 @@ whmcs_client/configuration.py
3733
whmcs_client/exceptions.py
3834
whmcs_client/models/__init__.py
3935
whmcs_client/models/add_client_response.py
40-
whmcs_client/models/add_client_response_all_of_clientid.py
41-
whmcs_client/models/add_order_request_clientid.py
4236
whmcs_client/models/add_order_response.py
4337
whmcs_client/models/client_info.py
4438
whmcs_client/models/currency_info.py
4539
whmcs_client/models/get_clients_response.py
4640
whmcs_client/models/get_clients_response_all_of_clients.py
4741
whmcs_client/models/get_currencies_response.py
4842
whmcs_client/models/get_currencies_response_all_of_currencies.py
49-
whmcs_client/models/update_client_request_clientid.py
5043
whmcs_client/models/update_client_response.py
51-
whmcs_client/models/update_client_response_all_of_clientid.py
5244
whmcs_client/models/whmcs_base_response.py
5345
whmcs_client/models/whmcs_error_response.py
5446
whmcs_client/models/whmcs_success_response.py

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,18 +128,14 @@ Class | Method | HTTP request | Description
128128
## Documentation For Models
129129

130130
- [AddClientResponse](docs/AddClientResponse.md)
131-
- [AddClientResponseAllOfClientid](docs/AddClientResponseAllOfClientid.md)
132-
- [AddOrderRequestClientid](docs/AddOrderRequestClientid.md)
133131
- [AddOrderResponse](docs/AddOrderResponse.md)
134132
- [ClientInfo](docs/ClientInfo.md)
135133
- [CurrencyInfo](docs/CurrencyInfo.md)
136134
- [GetClientsResponse](docs/GetClientsResponse.md)
137135
- [GetClientsResponseAllOfClients](docs/GetClientsResponseAllOfClients.md)
138136
- [GetCurrenciesResponse](docs/GetCurrenciesResponse.md)
139137
- [GetCurrenciesResponseAllOfCurrencies](docs/GetCurrenciesResponseAllOfCurrencies.md)
140-
- [UpdateClientRequestClientid](docs/UpdateClientRequestClientid.md)
141138
- [UpdateClientResponse](docs/UpdateClientResponse.md)
142-
- [UpdateClientResponseAllOfClientid](docs/UpdateClientResponseAllOfClientid.md)
143139
- [WHMCSBaseResponse](docs/WHMCSBaseResponse.md)
144140
- [WHMCSErrorResponse](docs/WHMCSErrorResponse.md)
145141
- [WHMCSSuccessResponse](docs/WHMCSSuccessResponse.md)

docs/AddClientResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**result** | **str** | | [optional]
99
**message** | **str** | Response message | [optional]
10-
**clientid** | [**AddClientResponseAllOfClientid**](AddClientResponseAllOfClientid.md) | | [optional]
10+
**clientid** | **object** | The ID of the newly created client | [optional]
1111
**owner_user_id** | **int** | The ID of the user that owns the client | [optional]
1212

1313
## Example

docs/DefaultApi.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@ Places a new order for products/services
148148

149149
```python
150150
import whmcs_client
151-
from whmcs_client.models.add_order_request_clientid import AddOrderRequestClientid
152151
from whmcs_client.models.add_order_response import AddOrderResponse
153152
from whmcs_client.rest import ApiException
154153
from pprint import pprint
@@ -166,7 +165,7 @@ with whmcs_client.ApiClient(configuration) as api_client:
166165
api_instance = whmcs_client.DefaultApi(api_client)
167166
username = 'username_example' # str | Admin username/API identifier
168167
password = 'password_example' # str | Admin password/API secret
169-
clientid = whmcs_client.AddOrderRequestClientid() # AddOrderRequestClientid |
168+
clientid = None # object | The ID of the client to add the order for
170169
paymentmethod = 'paymentmethod_example' # str | The payment method for the order in the system format (e.g., paypal, mailin)
171170
accesskey = 'accesskey_example' # str | Optional API access key (optional)
172171
responsetype = json # str | Response format (optional) (default to json)
@@ -232,7 +231,7 @@ Name | Type | Description | Notes
232231
------------- | ------------- | ------------- | -------------
233232
**username** | **str**| Admin username/API identifier |
234233
**password** | **str**| Admin password/API secret |
235-
**clientid** | [**AddOrderRequestClientid**](AddOrderRequestClientid.md)| |
234+
**clientid** | [**object**](object.md)| The ID of the client to add the order for |
236235
**paymentmethod** | **str**| The payment method for the order in the system format (e.g., paypal, mailin) |
237236
**accesskey** | **str**| Optional API access key | [optional]
238237
**responsetype** | **str**| Response format | [optional] [default to json]
@@ -476,7 +475,6 @@ Modifies an existing client's information
476475

477476
```python
478477
import whmcs_client
479-
from whmcs_client.models.update_client_request_clientid import UpdateClientRequestClientid
480478
from whmcs_client.models.update_client_response import UpdateClientResponse
481479
from whmcs_client.rest import ApiException
482480
from pprint import pprint
@@ -494,7 +492,7 @@ with whmcs_client.ApiClient(configuration) as api_client:
494492
api_instance = whmcs_client.DefaultApi(api_client)
495493
username = 'username_example' # str | Admin username/API identifier
496494
password = 'password_example' # str | Admin password/API secret
497-
clientid = whmcs_client.UpdateClientRequestClientid() # UpdateClientRequestClientid |
495+
clientid = None # object | The ID of the client to update
498496
accesskey = 'accesskey_example' # str | Optional API access key (optional)
499497
responsetype = json # str | Response format (optional) (default to json)
500498
clientemail = 'clientemail_example' # str | The email address of the client to update (optional)
@@ -553,7 +551,7 @@ Name | Type | Description | Notes
553551
------------- | ------------- | ------------- | -------------
554552
**username** | **str**| Admin username/API identifier |
555553
**password** | **str**| Admin password/API secret |
556-
**clientid** | [**UpdateClientRequestClientid**](UpdateClientRequestClientid.md)| |
554+
**clientid** | [**object**](object.md)| The ID of the client to update |
557555
**accesskey** | **str**| Optional API access key | [optional]
558556
**responsetype** | **str**| Response format | [optional] [default to json]
559557
**clientemail** | **str**| The email address of the client to update | [optional]

docs/UpdateClientResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**result** | **str** | | [optional]
99
**message** | **str** | Response message | [optional]
10-
**clientid** | [**UpdateClientResponseAllOfClientid**](UpdateClientResponseAllOfClientid.md) | | [optional]
10+
**clientid** | **object** | The ID of the updated client | [optional]
1111

1212
## Example
1313

openapi.yaml

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -245,9 +245,6 @@ components:
245245
- clientid
246246
properties:
247247
clientid:
248-
anyOf:
249-
- type: integer
250-
- type: string
251248
description: The ID of the client to update
252249
clientemail:
253250
type: string
@@ -368,9 +365,6 @@ components:
368365
- paymentmethod
369366
properties:
370367
clientid:
371-
anyOf:
372-
- type: integer
373-
- type: string
374368
description: The ID of the client to add the order for
375369
clientemail:
376370
type: string
@@ -628,9 +622,9 @@ components:
628622
- type: object
629623
properties:
630624
clientid:
631-
anyOf:
632-
- type: integer
633-
- type: string
625+
type: object
626+
additionalProperties:
627+
type: [string, integer]
634628
description: The ID of the newly created client
635629
owner_user_id:
636630
type: integer
@@ -642,9 +636,9 @@ components:
642636
- type: object
643637
properties:
644638
clientid:
645-
anyOf:
646-
- type: integer
647-
- type: string
639+
type: object
640+
additionalProperties:
641+
type: [string, integer]
648642
description: The ID of the updated client
649643

650644
AddOrderResponse:

whmcs_client/__init__.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,14 @@
3232

3333
# import models into sdk package
3434
from whmcs_client.models.add_client_response import AddClientResponse
35-
from whmcs_client.models.add_client_response_all_of_clientid import AddClientResponseAllOfClientid
36-
from whmcs_client.models.add_order_request_clientid import AddOrderRequestClientid
3735
from whmcs_client.models.add_order_response import AddOrderResponse
3836
from whmcs_client.models.client_info import ClientInfo
3937
from whmcs_client.models.currency_info import CurrencyInfo
4038
from whmcs_client.models.get_clients_response import GetClientsResponse
4139
from whmcs_client.models.get_clients_response_all_of_clients import GetClientsResponseAllOfClients
4240
from whmcs_client.models.get_currencies_response import GetCurrenciesResponse
4341
from whmcs_client.models.get_currencies_response_all_of_currencies import GetCurrenciesResponseAllOfCurrencies
44-
from whmcs_client.models.update_client_request_clientid import UpdateClientRequestClientid
4542
from whmcs_client.models.update_client_response import UpdateClientResponse
46-
from whmcs_client.models.update_client_response_all_of_clientid import UpdateClientResponseAllOfClientid
4743
from whmcs_client.models.whmcs_base_response import WHMCSBaseResponse
4844
from whmcs_client.models.whmcs_error_response import WHMCSErrorResponse
4945
from whmcs_client.models.whmcs_success_response import WHMCSSuccessResponse

whmcs_client/api/default_api.py

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,12 @@
1717
from typing_extensions import Annotated
1818

1919
from pydantic import Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
20-
from typing import Dict, List, Optional, Union
20+
from typing import Any, Dict, List, Optional, Union
2121
from typing_extensions import Annotated
2222
from whmcs_client.models.add_client_response import AddClientResponse
23-
from whmcs_client.models.add_order_request_clientid import AddOrderRequestClientid
2423
from whmcs_client.models.add_order_response import AddOrderResponse
2524
from whmcs_client.models.get_clients_response import GetClientsResponse
2625
from whmcs_client.models.get_currencies_response import GetCurrenciesResponse
27-
from whmcs_client.models.update_client_request_clientid import UpdateClientRequestClientid
2826
from whmcs_client.models.update_client_response import UpdateClientResponse
2927

3028
from whmcs_client.api_client import ApiClient, RequestSerialized
@@ -743,7 +741,7 @@ def add_order(
743741
self,
744742
username: Annotated[StrictStr, Field(description="Admin username/API identifier")],
745743
password: Annotated[StrictStr, Field(description="Admin password/API secret")],
746-
clientid: AddOrderRequestClientid,
744+
clientid: Annotated[Optional[Any], Field(description="The ID of the client to add the order for")],
747745
paymentmethod: Annotated[StrictStr, Field(description="The payment method for the order in the system format (e.g., paypal, mailin)")],
748746
accesskey: Annotated[Optional[StrictStr], Field(description="Optional API access key")] = None,
749747
responsetype: Annotated[Optional[StrictStr], Field(description="Response format")] = None,
@@ -811,8 +809,8 @@ def add_order(
811809
:type username: str
812810
:param password: Admin password/API secret (required)
813811
:type password: str
814-
:param clientid: (required)
815-
:type clientid: AddOrderRequestClientid
812+
:param clientid: The ID of the client to add the order for (required)
813+
:type clientid: object
816814
:param paymentmethod: The payment method for the order in the system format (e.g., paypal, mailin) (required)
817815
:type paymentmethod: str
818816
:param accesskey: Optional API access key
@@ -1002,7 +1000,7 @@ def add_order_with_http_info(
10021000
self,
10031001
username: Annotated[StrictStr, Field(description="Admin username/API identifier")],
10041002
password: Annotated[StrictStr, Field(description="Admin password/API secret")],
1005-
clientid: AddOrderRequestClientid,
1003+
clientid: Annotated[Optional[Any], Field(description="The ID of the client to add the order for")],
10061004
paymentmethod: Annotated[StrictStr, Field(description="The payment method for the order in the system format (e.g., paypal, mailin)")],
10071005
accesskey: Annotated[Optional[StrictStr], Field(description="Optional API access key")] = None,
10081006
responsetype: Annotated[Optional[StrictStr], Field(description="Response format")] = None,
@@ -1070,8 +1068,8 @@ def add_order_with_http_info(
10701068
:type username: str
10711069
:param password: Admin password/API secret (required)
10721070
:type password: str
1073-
:param clientid: (required)
1074-
:type clientid: AddOrderRequestClientid
1071+
:param clientid: The ID of the client to add the order for (required)
1072+
:type clientid: object
10751073
:param paymentmethod: The payment method for the order in the system format (e.g., paypal, mailin) (required)
10761074
:type paymentmethod: str
10771075
:param accesskey: Optional API access key
@@ -1261,7 +1259,7 @@ def add_order_without_preload_content(
12611259
self,
12621260
username: Annotated[StrictStr, Field(description="Admin username/API identifier")],
12631261
password: Annotated[StrictStr, Field(description="Admin password/API secret")],
1264-
clientid: AddOrderRequestClientid,
1262+
clientid: Annotated[Optional[Any], Field(description="The ID of the client to add the order for")],
12651263
paymentmethod: Annotated[StrictStr, Field(description="The payment method for the order in the system format (e.g., paypal, mailin)")],
12661264
accesskey: Annotated[Optional[StrictStr], Field(description="Optional API access key")] = None,
12671265
responsetype: Annotated[Optional[StrictStr], Field(description="Response format")] = None,
@@ -1329,8 +1327,8 @@ def add_order_without_preload_content(
13291327
:type username: str
13301328
:param password: Admin password/API secret (required)
13311329
:type password: str
1332-
:param clientid: (required)
1333-
:type clientid: AddOrderRequestClientid
1330+
:param clientid: The ID of the client to add the order for (required)
1331+
:type clientid: object
13341332
:param paymentmethod: The payment method for the order in the system format (e.g., paypal, mailin) (required)
13351333
:type paymentmethod: str
13361334
:param accesskey: Optional API access key
@@ -2489,7 +2487,7 @@ def update_client(
24892487
self,
24902488
username: Annotated[StrictStr, Field(description="Admin username/API identifier")],
24912489
password: Annotated[StrictStr, Field(description="Admin password/API secret")],
2492-
clientid: UpdateClientRequestClientid,
2490+
clientid: Annotated[Optional[Any], Field(description="The ID of the client to update")],
24932491
accesskey: Annotated[Optional[StrictStr], Field(description="Optional API access key")] = None,
24942492
responsetype: Annotated[Optional[StrictStr], Field(description="Response format")] = None,
24952493
clientemail: Annotated[Optional[StrictStr], Field(description="The email address of the client to update")] = None,
@@ -2550,8 +2548,8 @@ def update_client(
25502548
:type username: str
25512549
:param password: Admin password/API secret (required)
25522550
:type password: str
2553-
:param clientid: (required)
2554-
:type clientid: UpdateClientRequestClientid
2551+
:param clientid: The ID of the client to update (required)
2552+
:type clientid: object
25552553
:param accesskey: Optional API access key
25562554
:type accesskey: str
25572555
:param responsetype: Response format
@@ -2720,7 +2718,7 @@ def update_client_with_http_info(
27202718
self,
27212719
username: Annotated[StrictStr, Field(description="Admin username/API identifier")],
27222720
password: Annotated[StrictStr, Field(description="Admin password/API secret")],
2723-
clientid: UpdateClientRequestClientid,
2721+
clientid: Annotated[Optional[Any], Field(description="The ID of the client to update")],
27242722
accesskey: Annotated[Optional[StrictStr], Field(description="Optional API access key")] = None,
27252723
responsetype: Annotated[Optional[StrictStr], Field(description="Response format")] = None,
27262724
clientemail: Annotated[Optional[StrictStr], Field(description="The email address of the client to update")] = None,
@@ -2781,8 +2779,8 @@ def update_client_with_http_info(
27812779
:type username: str
27822780
:param password: Admin password/API secret (required)
27832781
:type password: str
2784-
:param clientid: (required)
2785-
:type clientid: UpdateClientRequestClientid
2782+
:param clientid: The ID of the client to update (required)
2783+
:type clientid: object
27862784
:param accesskey: Optional API access key
27872785
:type accesskey: str
27882786
:param responsetype: Response format
@@ -2951,7 +2949,7 @@ def update_client_without_preload_content(
29512949
self,
29522950
username: Annotated[StrictStr, Field(description="Admin username/API identifier")],
29532951
password: Annotated[StrictStr, Field(description="Admin password/API secret")],
2954-
clientid: UpdateClientRequestClientid,
2952+
clientid: Annotated[Optional[Any], Field(description="The ID of the client to update")],
29552953
accesskey: Annotated[Optional[StrictStr], Field(description="Optional API access key")] = None,
29562954
responsetype: Annotated[Optional[StrictStr], Field(description="Response format")] = None,
29572955
clientemail: Annotated[Optional[StrictStr], Field(description="The email address of the client to update")] = None,
@@ -3012,8 +3010,8 @@ def update_client_without_preload_content(
30123010
:type username: str
30133011
:param password: Admin password/API secret (required)
30143012
:type password: str
3015-
:param clientid: (required)
3016-
:type clientid: UpdateClientRequestClientid
3013+
:param clientid: The ID of the client to update (required)
3014+
:type clientid: object
30173015
:param accesskey: Optional API access key
30183016
:type accesskey: str
30193017
:param responsetype: Response format

whmcs_client/models/__init__.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,14 @@
1515

1616
# import models into model package
1717
from whmcs_client.models.add_client_response import AddClientResponse
18-
from whmcs_client.models.add_client_response_all_of_clientid import AddClientResponseAllOfClientid
19-
from whmcs_client.models.add_order_request_clientid import AddOrderRequestClientid
2018
from whmcs_client.models.add_order_response import AddOrderResponse
2119
from whmcs_client.models.client_info import ClientInfo
2220
from whmcs_client.models.currency_info import CurrencyInfo
2321
from whmcs_client.models.get_clients_response import GetClientsResponse
2422
from whmcs_client.models.get_clients_response_all_of_clients import GetClientsResponseAllOfClients
2523
from whmcs_client.models.get_currencies_response import GetCurrenciesResponse
2624
from whmcs_client.models.get_currencies_response_all_of_currencies import GetCurrenciesResponseAllOfCurrencies
27-
from whmcs_client.models.update_client_request_clientid import UpdateClientRequestClientid
2825
from whmcs_client.models.update_client_response import UpdateClientResponse
29-
from whmcs_client.models.update_client_response_all_of_clientid import UpdateClientResponseAllOfClientid
3026
from whmcs_client.models.whmcs_base_response import WHMCSBaseResponse
3127
from whmcs_client.models.whmcs_error_response import WHMCSErrorResponse
3228
from whmcs_client.models.whmcs_success_response import WHMCSSuccessResponse

0 commit comments

Comments
 (0)