flywheel.api_client
ApiClient
Bases: object
Generic API client for Swagger client library builds.
Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
configuration | .Configuration object for this client | None | |
header_name | a header to pass when making calls to the API. | None | |
header_value | a header value to pass when making calls to the API. | None | |
cookie | a cookie to include in the header when making calls to the API | None |
user_agent property writable
User agent for this API client
__deserialize(data, klass)
Deserializes dict, list, str into an object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data | dict, list or str. | required | |
klass | class literal, or string of class name. | required |
Returns:
| Type | Description |
|---|---|
| object. |
__deserialize_datatime(string)
Deserializes string to datetime.
The string should be in iso8601 datetime format.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
string | str. | required |
Returns:
| Type | Description |
|---|---|
| datetime. |
__deserialize_date(string)
Deserializes string to date.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
string | str. | required |
Returns:
| Type | Description |
|---|---|
| date. |
__deserialize_enum(data, klass)
Translates a string value to its corresponding enum value
Returns:
| Type | Description |
|---|---|
| Enum member. |
__deserialize_file(response)
Deserializes body to file
Saves response body into a file in a temporary folder, using the filename from the Content-Disposition header if provided.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
response | RESTResponse. | required |
Returns:
| Type | Description |
|---|---|
| file path. |
__deserialize_model(data, klass)
Deserializes dict to model.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data | dict | required | |
klass | class literal. | required |
Returns:
| Type | Description |
|---|---|
| model object. |
__deserialize_object(value)
Return a original value.
Returns:
| Type | Description |
|---|---|
| object. |
__deserialize_primitive(data, klass)
Deserializes string to primitive type.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data | str. | required | |
klass | class literal. | required |
Returns:
| Type | Description |
|---|---|
| int, long, float, str, bool. |
call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, async_=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None, _request_out=None)
Makes the HTTP request (synchronous) and returns deserialized data.
To make an async request, set the async_ parameter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
resource_path | Path to method endpoint. | required | |
method | Method to call. | required | |
path_params | Path parameters in the url. | None | |
query_params | Query parameters in the url. | None | |
header_params | Header parameters to be placed in the request header. | None | |
body | Request body. | None | |
dict | post_params | Request post form parameters, for | required |
list | auth_settings | Auth Settings names for the request. | required |
response | Response data type. | required | |
bool | async_ | execute request asynchronously | required |
_return_http_data_only | response data without head status code and headers | None | |
collection_formats | dict of collection formats for path, query, header, and post parameters. | None | |
_preload_content | if False, the streaming response object will be returned without reading/decoding response data. Default is True. | True | |
_request_timeout | timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. | None |
Returns:
| Type | Description |
|---|---|
| If |
deserialize(response, response_type)
Deserializes response into an object.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
response | RESTResponse object to be deserialized. | required | |
response_type | class literal for deserialized object, or string of class name. | required |
Returns:
| Type | Description |
|---|---|
| deserialized object. |
parameters_to_tuples(params, collection_formats)
Get parameters as list of tuples, formatting collections.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
params | Parameters as dict or list of two-tuples | required | |
collection_formats | dict | Parameter collection formats | required |
Returns:
| Type | Description |
|---|---|
| Parameters as list of tuples, collections formatted |
prepare_post_parameters(post_params=None, files=None)
Builds form parameters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
post_params | Normal form parameters. | None | |
files | File parameters. | None |
Returns:
| Type | Description |
|---|---|
| Form parameters with files. |
request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
Makes the HTTP request using RESTClient.
sanitize_for_serialization(obj)
Builds a JSON POST object.
If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
obj | The data to serialize. | required |
Returns:
| Type | Description |
|---|---|
| The serialized form of data. |
select_header_accept(accepts)
Returns Accept based on an array of accepts provided.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
accepts | List of headers. | required |
Returns:
| Type | Description |
|---|---|
| Accept (e.g. application/json). |
select_header_content_type(content_types)
Returns Content-Type based on an array of content_types provided.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
content_types | List of content-types. | required |
Returns:
| Type | Description |
|---|---|
| Content-Type (e.g. application/json). |
update_params_for_auth(headers, querys, auth_settings)
Updates header and query params based on authentication setting.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
headers | Header parameters dict to be updated. | required | |
querys | Query parameters tuple list to be updated. | required | |
auth_settings | Authentication setting identifiers list. | required |