Feat: release SDK version 2.0 to allow users to perform emails services management operations.

.openapi-generator/FILES

@@ -1,25 +1,42 @@
 .github/workflows/python.yml
 .gitignore
 .gitlab-ci.yml
-.openapi-generator-ignore
 .travis.yml
 README.md
+docs/AliasDisplay.md
+docs/ChangeEmailQuota.md
 docs/ChangeQuotaApi.md
+docs/ChangeQuotaCreate200Response.md
 docs/CreateAliasApi.md
+docs/DeleteAlias.md
 docs/DeleteAliasApi.md
+docs/DeleteEmail.md
 docs/DeleteEmailApi.md
 docs/DnsInfoApi.md
 docs/DnsInfoCreate200Response.md
 docs/DnsInfoCreateRequest.md
+docs/Domain.md
+docs/DomainAction.md
 docs/DomainAliasApi.md
 docs/DomainApi.md
 docs/DomainInfoApi.md
+docs/EmailAlias.md
+docs/EmailDisplay.md
 docs/GetTokenApi.md
 docs/ImportApi.md
+docs/ImportCreateRequest.md
+docs/OpenExchangeCreateAccount.md
+docs/OrderDisplay.md
+docs/PasswordReset.md
 docs/RefreshTokenApi.md
 docs/ResetPasswordApi.md
+docs/ServiceAction.md
+docs/SubScriptionInfo.md
 docs/SubscriptionInfoApi.md
+docs/SubscriptionInfoCreate200Response.md
+docs/SubscriptionInfoResponse.md
 docs/SubscriptionsApi.md
+docs/SubscriptionsRead200Response.md
 docs/TokenObtainPair.md
 docs/TokenRefresh.md
 docs/UpgradeApi.md
@@ -30,25 +47,24 @@ setup.cfg
 setup.py
 test-requirements.txt
 test/__init__.py
-test/test_change_quota_api.py
-test/test_create_alias_api.py
-test/test_delete_alias_api.py
-test/test_delete_email_api.py
-test/test_dns_info_api.py
-test/test_dns_info_create200_response.py
-test/test_dns_info_create_request.py
-test/test_domain_alias_api.py
-test/test_domain_api.py
-test/test_domain_info_api.py
-test/test_get_token_api.py
-test/test_import_api.py
-test/test_refresh_token_api.py
-test/test_reset_password_api.py
-test/test_subscription_info_api.py
-test/test_subscriptions_api.py
-test/test_token_obtain_pair.py
-test/test_token_refresh.py
-test/test_upgrade_api.py
+test/test_alias_display.py
+test/test_change_email_quota.py
+test/test_change_quota_create200_response.py
+test/test_delete_alias.py
+test/test_delete_email.py
+test/test_domain.py
+test/test_domain_action.py
+test/test_email_alias.py
+test/test_email_display.py
+test/test_import_create_request.py
+test/test_open_exchange_create_account.py
+test/test_order_display.py
+test/test_password_reset.py
+test/test_service_action.py
+test/test_sub_scription_info.py
+test/test_subscription_info_create200_response.py
+test/test_subscription_info_response.py
+test/test_subscriptions_read200_response.py
 tox.ini
 workplace_console_client/__init__.py
 workplace_console_client/api/__init__.py
@@ -72,8 +88,26 @@ workplace_console_client/api_response.py
 workplace_console_client/configuration.py
 workplace_console_client/exceptions.py
 workplace_console_client/models/__init__.py
+workplace_console_client/models/alias_display.py
+workplace_console_client/models/change_email_quota.py
+workplace_console_client/models/change_quota_create200_response.py
+workplace_console_client/models/delete_alias.py
+workplace_console_client/models/delete_email.py
 workplace_console_client/models/dns_info_create200_response.py
 workplace_console_client/models/dns_info_create_request.py
+workplace_console_client/models/domain.py
+workplace_console_client/models/domain_action.py
+workplace_console_client/models/email_alias.py
+workplace_console_client/models/email_display.py
+workplace_console_client/models/import_create_request.py
+workplace_console_client/models/open_exchange_create_account.py
+workplace_console_client/models/order_display.py
+workplace_console_client/models/password_reset.py
+workplace_console_client/models/service_action.py
+workplace_console_client/models/sub_scription_info.py
+workplace_console_client/models/subscription_info_create200_response.py
+workplace_console_client/models/subscription_info_response.py
+workplace_console_client/models/subscriptions_read200_response.py
 workplace_console_client/models/token_obtain_pair.py
 workplace_console_client/models/token_refresh.py
 workplace_console_client/py.typed

README.md

@@ -1,9 +1,10 @@
-# Workplace Console Client
-
+# workplace-console-client
 This is the Truehost's pip package for using the workplace console API from other python applications.
 
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
 - API version: v1
-- Package version: 1.0.1
+- Package version: 1.0.0
 - Generator version: 7.13.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
@@ -17,9 +18,9 @@ Python 3.9+
 If the python package is hosted on a repository, you can install directly using:
 
 ```sh
-pip install git+https://github.com/truehost/workplace-console-client.git
+pip install git+https://github.com/truehostcloud/workplace-console-client.git
 ```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/truehost/workplace-console-client.git`)
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/truehostcloud/workplace-console-client.git`)
 
 Then import the package:
 ```python
@@ -76,9 +77,13 @@ configuration = workplace_console_client.Configuration(
 with workplace_console_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = workplace_console_client.ChangeQuotaApi(api_client)
+    data = workplace_console_client.ChangeEmailQuota() # ChangeEmailQuota | 
 
     try:
-        api_instance.change_quota_create()
+        # Change email quota.
+        api_response = api_instance.change_quota_create(data)
+        print("The response of ChangeQuotaApi->change_quota_create:\n")
+        pprint(api_response)
     except ApiException as e:
         print("Exception when calling ChangeQuotaApi->change_quota_create: %s\n" % e)
 
@@ -90,30 +95,48 @@ All URIs are relative to *http://127.0.0.1:8000/api*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*ChangeQuotaApi* | [**change_quota_create**](docs/ChangeQuotaApi.md#change_quota_create) | **POST** /change-quota/ | 
-*CreateAliasApi* | [**create_alias_create**](docs/CreateAliasApi.md#create_alias_create) | **POST** /create-alias/ | 
-*DeleteAliasApi* | [**delete_alias_create**](docs/DeleteAliasApi.md#delete_alias_create) | **POST** /delete-alias/ | 
-*DeleteEmailApi* | [**delete_email_create**](docs/DeleteEmailApi.md#delete_email_create) | **POST** /delete-email/ | 
+*ChangeQuotaApi* | [**change_quota_create**](docs/ChangeQuotaApi.md#change_quota_create) | **POST** /change-quota/ | Change email quota.
+*CreateAliasApi* | [**create_alias_create**](docs/CreateAliasApi.md#create_alias_create) | **POST** /create-alias/ | Create email alias.
+*DeleteAliasApi* | [**delete_alias_create**](docs/DeleteAliasApi.md#delete_alias_create) | **POST** /delete-alias/ | Delete alias.
+*DeleteEmailApi* | [**delete_email_create**](docs/DeleteEmailApi.md#delete_email_create) | **POST** /delete-email/ | Delete email.
 *DnsInfoApi* | [**dns_info_create**](docs/DnsInfoApi.md#dns_info_create) | **POST** /dns-info/ | 
-*DomainApi* | [**domain_create**](docs/DomainApi.md#domain_create) | **POST** /domain/ | 
-*DomainAliasApi* | [**domain_alias_create**](docs/DomainAliasApi.md#domain_alias_create) | **POST** /domain-alias/ | 
-*DomainInfoApi* | [**domain_info_create**](docs/DomainInfoApi.md#domain_info_create) | **POST** /domain-info/ | 
+*DomainApi* | [**domain_create**](docs/DomainApi.md#domain_create) | **POST** /domain/ | Update domain subscription status, delete, suspend, unsuspend, etc...
+*DomainAliasApi* | [**domain_alias_create**](docs/DomainAliasApi.md#domain_alias_create) | **POST** /domain-alias/ | Get domain alias list.
+*DomainInfoApi* | [**domain_info_create**](docs/DomainInfoApi.md#domain_info_create) | **POST** /domain-info/ | Get domain subscription details.
 *GetTokenApi* | [**get_token_create**](docs/GetTokenApi.md#get_token_create) | **POST** /get-token/ | 
-*ImportApi* | [**import_create**](docs/ImportApi.md#import_create) | **POST** /import/ | 
+*ImportApi* | [**import_create**](docs/ImportApi.md#import_create) | **POST** /import/ | Bulk create emails.
 *RefreshTokenApi* | [**refresh_token_create**](docs/RefreshTokenApi.md#refresh_token_create) | **POST** /refresh-token/ | 
-*ResetPasswordApi* | [**reset_password_create**](docs/ResetPasswordApi.md#reset_password_create) | **POST** /reset-password/ | 
-*SubscriptionInfoApi* | [**subscription_info_create**](docs/SubscriptionInfoApi.md#subscription_info_create) | **POST** /subscription-info/ | 
-*SubscriptionsApi* | [**subscriptions_create**](docs/SubscriptionsApi.md#subscriptions_create) | **POST** /subscriptions/ | 
-*SubscriptionsApi* | [**subscriptions_create_0**](docs/SubscriptionsApi.md#subscriptions_create_0) | **POST** /subscriptions/{context_id}/ | 
+*ResetPasswordApi* | [**reset_password_create**](docs/ResetPasswordApi.md#reset_password_create) | **POST** /reset-password/ | Reset subscription email password.
+*SubscriptionInfoApi* | [**subscription_info_create**](docs/SubscriptionInfoApi.md#subscription_info_create) | **POST** /subscription-info/ | Get subscription usage info.
+*SubscriptionsApi* | [**subscriptions_create**](docs/SubscriptionsApi.md#subscriptions_create) | **POST** /subscriptions/ | Create a new email subscription, it will create a new subscription for the domain if emails list is not empty
 *SubscriptionsApi* | [**subscriptions_list**](docs/SubscriptionsApi.md#subscriptions_list) | **GET** /subscriptions/ | 
-*SubscriptionsApi* | [**subscriptions_read**](docs/SubscriptionsApi.md#subscriptions_read) | **GET** /subscriptions/{context_id}/ | 
-*UpgradeApi* | [**upgrade_create**](docs/UpgradeApi.md#upgrade_create) | **POST** /upgrade/ | 
+*SubscriptionsApi* | [**subscriptions_read**](docs/SubscriptionsApi.md#subscriptions_read) | **GET** /subscriptions/{context_id}/ | Get subscription details
+*SubscriptionsApi* | [**update_subscription_status**](docs/SubscriptionsApi.md#update_subscription_status) | **POST** /subscriptions/{context_id}/ | Update subscription status, delete, suspend, unsuspend, etc...
+*UpgradeApi* | [**upgrade_create**](docs/UpgradeApi.md#upgrade_create) | **POST** /upgrade/ | Upgrade subscription.
 
 
 ## Documentation For Models
 
+ - [AliasDisplay](docs/AliasDisplay.md)
+ - [ChangeEmailQuota](docs/ChangeEmailQuota.md)
+ - [ChangeQuotaCreate200Response](docs/ChangeQuotaCreate200Response.md)
+ - [DeleteAlias](docs/DeleteAlias.md)
+ - [DeleteEmail](docs/DeleteEmail.md)
  - [DnsInfoCreate200Response](docs/DnsInfoCreate200Response.md)
  - [DnsInfoCreateRequest](docs/DnsInfoCreateRequest.md)
+ - [Domain](docs/Domain.md)
+ - [DomainAction](docs/DomainAction.md)
+ - [EmailAlias](docs/EmailAlias.md)
+ - [EmailDisplay](docs/EmailDisplay.md)
+ - [ImportCreateRequest](docs/ImportCreateRequest.md)
+ - [OpenExchangeCreateAccount](docs/OpenExchangeCreateAccount.md)
+ - [OrderDisplay](docs/OrderDisplay.md)
+ - [PasswordReset](docs/PasswordReset.md)
+ - [ServiceAction](docs/ServiceAction.md)
+ - [SubScriptionInfo](docs/SubScriptionInfo.md)
+ - [SubscriptionInfoCreate200Response](docs/SubscriptionInfoCreate200Response.md)
+ - [SubscriptionInfoResponse](docs/SubscriptionInfoResponse.md)
+ - [SubscriptionsRead200Response](docs/SubscriptionsRead200Response.md)
  - [TokenObtainPair](docs/TokenObtainPair.md)
  - [TokenRefresh](docs/TokenRefresh.md)
 

docs/AliasDisplay.md

@@ -0,0 +1,31 @@
+# AliasDisplay
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | [optional] [readonly] 
+**primary_email** | **str** |  | [optional] [readonly] 
+**name** | **str** |  | 
+
+## Example
+
+```python
+from workplace_console_client.models.alias_display import AliasDisplay
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AliasDisplay from a JSON string
+alias_display_instance = AliasDisplay.from_json(json)
+# print the JSON string representation of the object
+print(AliasDisplay.to_json())
+
+# convert the object into a dict
+alias_display_dict = alias_display_instance.to_dict()
+# create an instance of AliasDisplay from a dict
+alias_display_from_dict = AliasDisplay.from_dict(alias_display_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/ChangeEmailQuota.md

@@ -0,0 +1,30 @@
+# ChangeEmailQuota
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **str** |  | 
+**quota** | **int** |  | 
+
+## Example
+
+```python
+from workplace_console_client.models.change_email_quota import ChangeEmailQuota
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ChangeEmailQuota from a JSON string
+change_email_quota_instance = ChangeEmailQuota.from_json(json)
+# print the JSON string representation of the object
+print(ChangeEmailQuota.to_json())
+
+# convert the object into a dict
+change_email_quota_dict = change_email_quota_instance.to_dict()
+# create an instance of ChangeEmailQuota from a dict
+change_email_quota_from_dict = ChangeEmailQuota.from_dict(change_email_quota_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/ChangeQuotaApi.md

@@ -4,18 +4,24 @@ All URIs are relative to *http://127.0.0.1:8000/api*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**change_quota_create**](ChangeQuotaApi.md#change_quota_create) | **POST** /change-quota/ | 
+[**change_quota_create**](ChangeQuotaApi.md#change_quota_create) | **POST** /change-quota/ | Change email quota.
 
 
 # **change_quota_create**
-> change_quota_create()
+> ChangeQuotaCreate200Response change_quota_create(data)
+
+Change email quota.
+
+Change email quota.
 
 ### Example
 
 * Basic Authentication (Basic):
 
 ```python
 import workplace_console_client
+from workplace_console_client.models.change_email_quota import ChangeEmailQuota
+from workplace_console_client.models.change_quota_create200_response import ChangeQuotaCreate200Response
 from workplace_console_client.rest import ApiException
 from pprint import pprint
 
@@ -40,9 +46,13 @@ configuration = workplace_console_client.Configuration(
 with workplace_console_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = workplace_console_client.ChangeQuotaApi(api_client)
+    data = workplace_console_client.ChangeEmailQuota() # ChangeEmailQuota | 
 
     try:
-        api_instance.change_quota_create()
+        # Change email quota.
+        api_response = api_instance.change_quota_create(data)
+        print("The response of ChangeQuotaApi->change_quota_create:\n")
+        pprint(api_response)
     except Exception as e:
         print("Exception when calling ChangeQuotaApi->change_quota_create: %s\n" % e)
 ```
@@ -51,26 +61,29 @@ with workplace_console_client.ApiClient(configuration) as api_client:
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**ChangeEmailQuota**](ChangeEmailQuota.md)|  | 
 
 ### Return type
 
-void (empty response body)
+[**ChangeQuotaCreate200Response**](ChangeQuotaCreate200Response.md)
 
 ### Authorization
 
 [Basic](../README.md#Basic)
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: Not defined
+ - **Content-Type**: application/json
+ - **Accept**: application/json
 
 ### HTTP response details
 
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-**201** |  |  -  |
+**200** | Success |  -  |
 
 [[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)
 

docs/ChangeQuotaCreate200Response.md

@@ -0,0 +1,30 @@
+# ChangeQuotaCreate200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **str** |  | [optional] 
+**error** | **str** |  | [optional] 
+
+## Example
+
+```python
+from workplace_console_client.models.change_quota_create200_response import ChangeQuotaCreate200Response
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ChangeQuotaCreate200Response from a JSON string
+change_quota_create200_response_instance = ChangeQuotaCreate200Response.from_json(json)
+# print the JSON string representation of the object
+print(ChangeQuotaCreate200Response.to_json())
+
+# convert the object into a dict
+change_quota_create200_response_dict = change_quota_create200_response_instance.to_dict()
+# create an instance of ChangeQuotaCreate200Response from a dict
+change_quota_create200_response_from_dict = ChangeQuotaCreate200Response.from_dict(change_quota_create200_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)
+
+