truehost-workplace-api-client

API for managing email and workplace service subscriptions.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.0.26
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

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

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import workplace_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import workplace_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import workplace_client
from workplace_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://workplace-console.truehost.cloud/api
# See configuration.py for a list of all supported configuration parameters.
configuration = workplace_client.Configuration(
    host = "https://workplace-console.truehost.cloud/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 Bearer authorization (JWT): BearerAuth
configuration = workplace_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# 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 ApiException as e:
        print("Exception when calling AvailablePackagesApi->available_packages_list: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://workplace-console.truehost.cloud/api

Class	Method	HTTP request	Description
AvailablePackagesApi	available_packages_list	GET /available-packages/	Get available subscriptions
CreateAliasApi	create_email_alias	POST /create-alias/	Create email alias
DeleteAliasApi	delete_email_alias	POST /delete-alias/	Delete alias
DeleteEmailApi	delete_email	POST /delete-email/	Delete email
DnsInfoApi	dns_info_create	POST /dns-info/	Get DNS information
DomainApi	domain_create	POST /domain/	Update domain subscription status
DomainAliasApi	domain_alias_create	POST /domain-alias/	Get domain alias list
DomainInfoApi	domain_info_create	POST /domain-info/	Get domain subscription details
GetTokenApi	get_token_create	POST /get-token/	Obtain authentication token
ImportApi	import_create	POST /import/	Bulk create emails
RefreshTokenApi	refresh_token_create	POST /refresh-token/	Refresh authentication token
ResetPasswordApi	reset_email_password	POST /reset-password/	Reset subscription email password
SubscriptionInfoApi	subscription_info_create	POST /subscription-info/	Get subscription usage info
SubscriptionsApi	emails_create	POST /subscriptions/	Create a new emails
SubscriptionsApi	subscriptions_list	GET /subscriptions/	List subscriptions
SubscriptionsApi	subscriptions_read	GET /subscriptions/{context_id}/	Get subscription details
SubscriptionsApi	update_subscription_status	POST /subscriptions/{context_id}/	Update subscription status
UpdateEmailQuotaApi	update_email_quota	POST /change-quota/	Update email quota
UpgradeApi	upgrade_create	POST /upgrade/	Upgrade subscription

Documentation For Models

• AliasDisplay
• DeleteAlias
• DeleteEmail
• DnsInfoRequest
• DnsInfoResponse
• DnsRecord
• Domain
• DomainAction
• EmailAlias
• EmailDisplay
• FoundDnsRecords
• OrderDisplay
• ResetEmailPassword
• ServiceAction
• StandardResponse
• SubScriptionInfo
• SubscriptionDetails
• SubscriptionInfoResponse
• SubscriptionUsageResponse
• SubscriptionsReadResponse
• TokenObtainPair
• TokenRefresh
• UpdateEmailQuota
• WorkplaceCreateEmails

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication (JWT)

Author

support@truehost.cloud