API client
This page describes APIClient abstract class which is inherited by all client implementations.
APIClient
Bases: ABC
API client abstract class that defines abstract methods that each derived class should define.
Attributes:
| Name | Type | Description |
|---|---|---|
url |
str
|
Typhoon Test Hub url |
artifact
property
An object for interacting with Artifact API.
execution
property
An object for interacting with Execution API.
report
property
An object for interacting with Report API.
trigger
property
An object for interacting with Trigger API.
__init__(url)
Constructs API client object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url |
str
|
Typhoon Test Hub url |
required |
get_request_headers()
abstractmethod
Generates dictionary with request header parameters
test_credentials()
abstractmethod
Tests if provided credentials are valid