Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: workplace_console_client Python package
name: workplace_client Python package

on: [push, pull_request]

Expand All @@ -28,4 +28,4 @@ jobs:
pip install -r test-requirements.txt
- name: Test with pytest
run: |
pytest --cov=workplace_console_client
pytest --cov=workplace_client
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ stages:
script:
- pip install -r requirements.txt
- pip install -r test-requirements.txt
- pytest --cov=workplace_console_client
- pytest --cov=workplace_client

pytest-3.9:
extends: .pytest
Expand Down
100 changes: 49 additions & 51 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
.travis.yml
README.md
docs/AliasDisplay.md
docs/AvailableSubscriptionsApi.md
docs/AvailablePackagesApi.md
docs/ChangeEmailQuota.md
docs/ChangeQuotaApi.md
docs/ChangeQuotaCreate200Response.md
Expand Down Expand Up @@ -49,54 +49,52 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_available_subscriptions_api.py
test/test_subscription_details.py
tox.ini
workplace_console_client/__init__.py
workplace_console_client/api/__init__.py
workplace_console_client/api/available_subscriptions_api.py
workplace_console_client/api/change_quota_api.py
workplace_console_client/api/create_alias_api.py
workplace_console_client/api/delete_alias_api.py
workplace_console_client/api/delete_email_api.py
workplace_console_client/api/dns_info_api.py
workplace_console_client/api/domain_alias_api.py
workplace_console_client/api/domain_api.py
workplace_console_client/api/domain_info_api.py
workplace_console_client/api/get_token_api.py
workplace_console_client/api/import_api.py
workplace_console_client/api/refresh_token_api.py
workplace_console_client/api/reset_password_api.py
workplace_console_client/api/subscription_info_api.py
workplace_console_client/api/subscriptions_api.py
workplace_console_client/api/upgrade_api.py
workplace_console_client/api_client.py
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_details.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
workplace_console_client/rest.py
workplace_client/__init__.py
workplace_client/api/__init__.py
workplace_client/api/available_packages_api.py
workplace_client/api/change_quota_api.py
workplace_client/api/create_alias_api.py
workplace_client/api/delete_alias_api.py
workplace_client/api/delete_email_api.py
workplace_client/api/dns_info_api.py
workplace_client/api/domain_alias_api.py
workplace_client/api/domain_api.py
workplace_client/api/domain_info_api.py
workplace_client/api/get_token_api.py
workplace_client/api/import_api.py
workplace_client/api/refresh_token_api.py
workplace_client/api/reset_password_api.py
workplace_client/api/subscription_info_api.py
workplace_client/api/subscriptions_api.py
workplace_client/api/upgrade_api.py
workplace_client/api_client.py
workplace_client/api_response.py
workplace_client/configuration.py
workplace_client/exceptions.py
workplace_client/models/__init__.py
workplace_client/models/alias_display.py
workplace_client/models/change_email_quota.py
workplace_client/models/change_quota_create200_response.py
workplace_client/models/delete_alias.py
workplace_client/models/delete_email.py
workplace_client/models/dns_info_create200_response.py
workplace_client/models/dns_info_create_request.py
workplace_client/models/domain.py
workplace_client/models/domain_action.py
workplace_client/models/email_alias.py
workplace_client/models/email_display.py
workplace_client/models/import_create_request.py
workplace_client/models/open_exchange_create_account.py
workplace_client/models/order_display.py
workplace_client/models/password_reset.py
workplace_client/models/service_action.py
workplace_client/models/sub_scription_info.py
workplace_client/models/subscription_details.py
workplace_client/models/subscription_info_create200_response.py
workplace_client/models/subscription_info_response.py
workplace_client/models/subscriptions_read200_response.py
workplace_client/models/token_obtain_pair.py
workplace_client/models/token_refresh.py
workplace_client/py.typed
workplace_client/rest.py
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ install:
- "pip install -r requirements.txt"
- "pip install -r test-requirements.txt"
# command to run tests
script: pytest --cov=workplace_console_client
script: pytest --cov=workplace_client
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# workplace-console-client
This is the Truehost's pip package for using the workplace console API from other python applications.
# truehost-workplace-api-client
API for managing email and workplace service subscriptions.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 1.0.0
- Package version: 1.0.8
- Generator version: 7.13.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

Expand All @@ -15,7 +15,7 @@ Python 3.9+
## Installation & Usage
### pip install

If the Python package is hosted on a repository, you can install it directly using:
If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/truehostcloud/workplace-python-client.git
Expand Down Expand Up @@ -55,10 +55,10 @@ import workplace_client
from workplace_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://127.0.0.1:8001/api
# Defining the host is optional and defaults to http://https://your-workplace-console.com//api
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_client.Configuration(
host = "http://127.0.0.1:8001/api"
host = "http://https://your-workplace-console.com//api"
)

# The client must configure the authentication and authorization parameters
Expand All @@ -74,27 +74,27 @@ configuration = workplace_client.Configuration(


# Enter a context with an instance of the API client
with workplace_client.api_client.ApiClient(configuration) as api_client:
with workplace_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = workplace_client.api_change_quota_api.ChangeQuotaApi(api_client)
data = workplace_client.models.change_email_quota.ChangeEmailQuota() # ChangeEmailQuota |
api_instance = workplace_client.AvailablePackagesApi(api_client)

try:
# Change email quota.
api_response = api_instance.change_quota_create(data)
print("The response of ChangeQuotaApi->change_quota_create:\n")
# Get available subscriptions.
api_response = api_instance.available_packages_list()
print("The response of AvailablePackagesApi->available_packages_list:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ChangeQuotaApi->change_quota_create: %s\n" % e)
print("Exception when calling AvailablePackagesApi->available_packages_list: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://127.0.0.1:8001/api*
All URIs are relative to *http://https://your-workplace-console.com//api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AvailablePackagesApi* | [**available_packages_list**](docs/AvailablePackagesApi.md#available_packages_list) | **GET** /available-packages/ | Get available subscriptions.
*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.
Expand Down Expand Up @@ -134,6 +134,7 @@ Class | Method | HTTP request | Description
- [PasswordReset](docs/PasswordReset.md)
- [ServiceAction](docs/ServiceAction.md)
- [SubScriptionInfo](docs/SubScriptionInfo.md)
- [SubscriptionDetails](docs/SubscriptionDetails.md)
- [SubscriptionInfoCreate200Response](docs/SubscriptionInfoCreate200Response.md)
- [SubscriptionInfoResponse](docs/SubscriptionInfoResponse.md)
- [SubscriptionsRead200Response](docs/SubscriptionsRead200Response.md)
Expand All @@ -155,3 +156,5 @@ Authentication schemes defined for the API:
## Author

support@truehost.cloud


2 changes: 1 addition & 1 deletion docs/AliasDisplay.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
## Example

```python
from workplace_console_client.models.alias_display import AliasDisplay
from workplace_client.models.alias_display import AliasDisplay

# TODO update the JSON string below
json = "{}"
Expand Down
6 changes: 3 additions & 3 deletions docs/AvailablePackagesApi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# workplace_client.AvailablePackagesApi

All URIs are relative to *http://127.0.0.1:8001/api*
All URIs are relative to *http://https://your-workplace-console.com//api*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -24,10 +24,10 @@ from workplace_client.models.subscription_details import SubscriptionDetails
from workplace_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://127.0.0.1:8001/api
# Defining the host is optional and defaults to http://https://your-workplace-console.com//api
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_client.Configuration(
host = "http://127.0.0.1:8001/api"
host = "http://https://your-workplace-console.com//api"
)

# The client must configure the authentication and authorization parameters
Expand Down
2 changes: 1 addition & 1 deletion docs/ChangeEmailQuota.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example

```python
from workplace_console_client.models.change_email_quota import ChangeEmailQuota
from workplace_client.models.change_email_quota import ChangeEmailQuota

# TODO update the JSON string below
json = "{}"
Expand Down
26 changes: 13 additions & 13 deletions docs/ChangeQuotaApi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# workplace_console_client.ChangeQuotaApi
# workplace_client.ChangeQuotaApi

All URIs are relative to *http://127.0.0.1:8001/api*
All URIs are relative to *http://https://your-workplace-console.com//api*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -19,16 +19,16 @@ Change email quota.
* 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
import workplace_client
from workplace_client.models.change_email_quota import ChangeEmailQuota
from workplace_client.models.change_quota_create200_response import ChangeQuotaCreate200Response
from workplace_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://127.0.0.1:8001/api
# Defining the host is optional and defaults to http://https://your-workplace-console.com//api
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_console_client.Configuration(
host = "http://127.0.0.1:8001/api"
configuration = workplace_client.Configuration(
host = "http://https://your-workplace-console.com//api"
)

# The client must configure the authentication and authorization parameters
Expand All @@ -37,16 +37,16 @@ configuration = workplace_console_client.Configuration(
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = workplace_console_client.Configuration(
configuration = workplace_client.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with workplace_console_client.ApiClient(configuration) as api_client:
with workplace_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 |
api_instance = workplace_client.ChangeQuotaApi(api_client)
data = workplace_client.ChangeEmailQuota() # ChangeEmailQuota |

try:
# Change email quota.
Expand Down
2 changes: 1 addition & 1 deletion docs/ChangeQuotaCreate200Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example

```python
from workplace_console_client.models.change_quota_create200_response import ChangeQuotaCreate200Response
from workplace_client.models.change_quota_create200_response import ChangeQuotaCreate200Response

# TODO update the JSON string below
json = "{}"
Expand Down
26 changes: 13 additions & 13 deletions docs/CreateAliasApi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# workplace_console_client.CreateAliasApi
# workplace_client.CreateAliasApi

All URIs are relative to *http://127.0.0.1:8001/api*
All URIs are relative to *http://https://your-workplace-console.com//api*

Method | HTTP request | Description
------------- | ------------- | -------------
Expand All @@ -19,16 +19,16 @@ Create email alias.
* Basic Authentication (Basic):

```python
import workplace_console_client
from workplace_console_client.models.change_quota_create200_response import ChangeQuotaCreate200Response
from workplace_console_client.models.email_alias import EmailAlias
from workplace_console_client.rest import ApiException
import workplace_client
from workplace_client.models.change_quota_create200_response import ChangeQuotaCreate200Response
from workplace_client.models.email_alias import EmailAlias
from workplace_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://127.0.0.1:8001/api
# Defining the host is optional and defaults to http://https://your-workplace-console.com//api
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_console_client.Configuration(
host = "http://127.0.0.1:8001/api"
configuration = workplace_client.Configuration(
host = "http://https://your-workplace-console.com//api"
)

# The client must configure the authentication and authorization parameters
Expand All @@ -37,16 +37,16 @@ configuration = workplace_console_client.Configuration(
# satisfies your auth use case.

# Configure HTTP basic authorization: Basic
configuration = workplace_console_client.Configuration(
configuration = workplace_client.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with workplace_console_client.ApiClient(configuration) as api_client:
with workplace_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = workplace_console_client.CreateAliasApi(api_client)
data = workplace_console_client.EmailAlias() # EmailAlias |
api_instance = workplace_client.CreateAliasApi(api_client)
data = workplace_client.EmailAlias() # EmailAlias |

try:
# Create email alias.
Expand Down
2 changes: 1 addition & 1 deletion docs/DeleteAlias.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Name | Type | Description | Notes
## Example

```python
from workplace_console_client.models.delete_alias import DeleteAlias
from workplace_client.models.delete_alias import DeleteAlias

# TODO update the JSON string below
json = "{}"
Expand Down
Loading
Loading