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
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Python 3.9+
If the Python package is hosted on a repository, you can install it directly using:

```sh
pip install git+https://github.com/truehostcloud/workplace-console-client.git
pip install git+https://github.com/truehostcloud/workplace-python-client.git
```
(you may need to run `pip` with root permission: `sudo 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/truehostcloud/workplace-python-client.git`)

Then import the package:
```python
import workplace_console_client
import workplace_client
```

### Setuptools
Expand All @@ -38,7 +38,7 @@ python setup.py install --user

Then import the package:
```python
import workplace_console_client
import workplace_client
```

### Tests
Expand All @@ -51,13 +51,13 @@ Please follow the [installation procedure](#installation--usage) and then run th

```python

import workplace_console_client
from workplace_console_client.rest import ApiException
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
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_console_client.Configuration(
configuration = workplace_client.Configuration(
host = "http://127.0.0.1:8001/api"
)

Expand All @@ -67,17 +67,17 @@ 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.api_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.api_change_quota_api.ChangeQuotaApi(api_client)
data = workplace_client.models.change_email_quota.ChangeEmailQuota() # ChangeEmailQuota |

try:
# Change email quota.
Expand Down
4 changes: 2 additions & 2 deletions config.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"packageName": "workplace_console_client",
"projectName": "workplace-console-client",
"packageName": "workplace_client",
"projectName": "truehost-workplace-api-client",
"packageVersion": "1.0.8",
"packageUrl": "https://github.com/truehostcloud/workplace-python-client",
"packageCompany": "Truehost",
Expand Down
84 changes: 84 additions & 0 deletions docs/AvailablePackagesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# workplace_client.AvailablePackagesApi

All URIs are relative to *http://127.0.0.1:8001/api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**available_packages_list**](AvailablePackagesApi.md#available_packages_list) | **GET** /available-packages/ | Get available subscriptions.


# **available_packages_list**
> List[SubscriptionDetails] available_packages_list()

Get available subscriptions.

Get available subscriptions.

### Example

* Basic Authentication (Basic):

```python
import workplace_client
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
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_client.Configuration(
host = "http://127.0.0.1:8001/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

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

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

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



### Parameters

This endpoint does not need any parameter.

### Return type

[**List[SubscriptionDetails]**](SubscriptionDetails.md)

### Authorization

[Basic](../README.md#Basic)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | | - |

[[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)

39 changes: 39 additions & 0 deletions test/test_available_packages_api.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# coding: utf-8

"""
Truehost Workpace API

Truehost Workpace API

The version of the OpenAPI document: v1
Contact: support@truehost.cloud
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
""" # noqa: E501


import unittest

from workplace_client.api.available_packages_api import AvailablePackagesApi


class TestAvailablePackagesApi(unittest.TestCase):
"""AvailablePackagesApi unit test stubs"""

def setUp(self) -> None:
self.api = AvailablePackagesApi()

def tearDown(self) -> None:
pass

def test_available_packages_list(self) -> None:
"""Test case for available_packages_list

Get available subscriptions.
"""
pass


if __name__ == '__main__':
unittest.main()
72 changes: 72 additions & 0 deletions workplace_client/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# coding: utf-8

# flake8: noqa

"""
Truehost Workpace API

Truehost Workpace API

The version of the OpenAPI document: v1
Contact: support@truehost.cloud
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
""" # noqa: E501


__version__ = "1.0.0"

# import apis into sdk package
from workplace_client.api.available_packages_api import AvailablePackagesApi
from workplace_client.api.change_quota_api import ChangeQuotaApi
from workplace_client.api.create_alias_api import CreateAliasApi
from workplace_client.api.delete_alias_api import DeleteAliasApi
from workplace_client.api.delete_email_api import DeleteEmailApi
from workplace_client.api.dns_info_api import DnsInfoApi
from workplace_client.api.domain_api import DomainApi
from workplace_client.api.domain_alias_api import DomainAliasApi
from workplace_client.api.domain_info_api import DomainInfoApi
from workplace_client.api.get_token_api import GetTokenApi
from workplace_client.api.import_api import ImportApi
from workplace_client.api.refresh_token_api import RefreshTokenApi
from workplace_client.api.reset_password_api import ResetPasswordApi
from workplace_client.api.subscription_info_api import SubscriptionInfoApi
from workplace_client.api.subscriptions_api import SubscriptionsApi
from workplace_client.api.upgrade_api import UpgradeApi

# import ApiClient
from workplace_client.api_response import ApiResponse
from workplace_client.api_client import ApiClient
from workplace_client.configuration import Configuration
from workplace_client.exceptions import OpenApiException
from workplace_client.exceptions import ApiTypeError
from workplace_client.exceptions import ApiValueError
from workplace_client.exceptions import ApiKeyError
from workplace_client.exceptions import ApiAttributeError
from workplace_client.exceptions import ApiException

# import models into sdk package
from workplace_client.models.alias_display import AliasDisplay
from workplace_client.models.change_email_quota import ChangeEmailQuota
from workplace_client.models.change_quota_create200_response import ChangeQuotaCreate200Response
from workplace_client.models.delete_alias import DeleteAlias
from workplace_client.models.delete_email import DeleteEmail
from workplace_client.models.dns_info_create200_response import DnsInfoCreate200Response
from workplace_client.models.dns_info_create_request import DnsInfoCreateRequest
from workplace_client.models.domain import Domain
from workplace_client.models.domain_action import DomainAction
from workplace_client.models.email_alias import EmailAlias
from workplace_client.models.email_display import EmailDisplay
from workplace_client.models.import_create_request import ImportCreateRequest
from workplace_client.models.open_exchange_create_account import OpenExchangeCreateAccount
from workplace_client.models.order_display import OrderDisplay
from workplace_client.models.password_reset import PasswordReset
from workplace_client.models.service_action import ServiceAction
from workplace_client.models.sub_scription_info import SubScriptionInfo
from workplace_client.models.subscription_details import SubscriptionDetails
from workplace_client.models.subscription_info_create200_response import SubscriptionInfoCreate200Response
from workplace_client.models.subscription_info_response import SubscriptionInfoResponse
from workplace_client.models.subscriptions_read200_response import SubscriptionsRead200Response
from workplace_client.models.token_obtain_pair import TokenObtainPair
from workplace_client.models.token_refresh import TokenRefresh
20 changes: 20 additions & 0 deletions workplace_client/api/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# flake8: noqa

# import apis into api package
from workplace_client.api.available_packages_api import AvailablePackagesApi
from workplace_client.api.change_quota_api import ChangeQuotaApi
from workplace_client.api.create_alias_api import CreateAliasApi
from workplace_client.api.delete_alias_api import DeleteAliasApi
from workplace_client.api.delete_email_api import DeleteEmailApi
from workplace_client.api.dns_info_api import DnsInfoApi
from workplace_client.api.domain_api import DomainApi
from workplace_client.api.domain_alias_api import DomainAliasApi
from workplace_client.api.domain_info_api import DomainInfoApi
from workplace_client.api.get_token_api import GetTokenApi
from workplace_client.api.import_api import ImportApi
from workplace_client.api.refresh_token_api import RefreshTokenApi
from workplace_client.api.reset_password_api import ResetPasswordApi
from workplace_client.api.subscription_info_api import SubscriptionInfoApi
from workplace_client.api.subscriptions_api import SubscriptionsApi
from workplace_client.api.upgrade_api import UpgradeApi

Loading