diff --git a/.gitignore b/.gitignore index 6707ad3..53b0a00 100644 --- a/.gitignore +++ b/.gitignore @@ -20,7 +20,6 @@ build.sbt # swagger .swagger-codegen/ -docs/ generated/ python-client/ diff --git a/PYPI-README.md b/PYPI-README.md new file mode 100644 index 0000000..2a8fbfa --- /dev/null +++ b/PYPI-README.md @@ -0,0 +1,12 @@ +# cachethq-client +A Python package with client-side methods for the Cachet Status Page https://cachethq.io/ + +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: 1.0.0 +- Package version: 1.0.0 +- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen + +## Requirements. + +Python 3.7+ \ No newline at end of file diff --git a/api-doc/README.md b/api-doc/README.md new file mode 100644 index 0000000..15b80c8 --- /dev/null +++ b/api-doc/README.md @@ -0,0 +1,178 @@ +# cachethq-client +A java-friendly swagger documentation file based on the documentation for the Cachet Status Page https://cachethq.io/ + +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: 1.0.0 +- Package version: 1.0.0 +- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen + +## Requirements. + +Python 3.7+ + +## Installation & Usage +### pip install + +If the python package is hosted on a repository, you can install directly using: + +```sh +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: +```python +import cachethq_client +``` + +### Setuptools + +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). + +```sh +python setup.py install --user +``` +(or `sudo python setup.py install` to install the package for all users) + +Then import the package: +```python +import cachethq_client +``` + +### Tests + +Execute `pytest` to run the tests. + +## Getting Started + +Please follow the [installation procedure](#installation--usage) and then run the following: + +```python + +import time +import cachethq_client +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentGroupsApi(api_client) + body = cachethq_client.ComponentGroup() # ComponentGroup | Component Group to be created. + + try: + # Create a new Component Group. + api_response = api_instance.create_component_group(body) + print("The response of ComponentGroupsApi->create_component_group:\n") + pprint(api_response) + except ApiException as e: + print("Exception when calling ComponentGroupsApi->create_component_group: %s\n" % e) + +``` + +## Documentation for API Endpoints + +All URIs are relative to */api/v1* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*ComponentGroupsApi* | [**create_component_group**](docs/ComponentGroupsApi.md#create_component_group) | **POST** /components/groups | Create a new Component Group. +*ComponentGroupsApi* | [**delete_component_group_by_id**](docs/ComponentGroupsApi.md#delete_component_group_by_id) | **DELETE** /components/groups/{group} | Delete a Component Group. +*ComponentGroupsApi* | [**get_component_group_by_id**](docs/ComponentGroupsApi.md#get_component_group_by_id) | **GET** /components/groups/{group} | Get a Component Group. +*ComponentGroupsApi* | [**get_component_groups**](docs/ComponentGroupsApi.md#get_component_groups) | **GET** /components/groups | Get all Component Groups. +*ComponentGroupsApi* | [**update_component_group_by_id**](docs/ComponentGroupsApi.md#update_component_group_by_id) | **PUT** /components/groups/{group} | Update a Component Group. +*ComponentsApi* | [**create_component**](docs/ComponentsApi.md#create_component) | **POST** /components | Create a new component. +*ComponentsApi* | [**delete_component_by_id**](docs/ComponentsApi.md#delete_component_by_id) | **DELETE** /components/{component} | Delete a component. +*ComponentsApi* | [**get_component_by_id**](docs/ComponentsApi.md#get_component_by_id) | **GET** /components/{component} | Get a component. +*ComponentsApi* | [**get_components**](docs/ComponentsApi.md#get_components) | **GET** /components | Get all components. +*ComponentsApi* | [**update_component_by_id**](docs/ComponentsApi.md#update_component_by_id) | **PUT** /components/{component} | Update a component. +*GeneralApi* | [**ping**](docs/GeneralApi.md#ping) | **GET** /ping | Test that the API is responding to your requests. +*GeneralApi* | [**version**](docs/GeneralApi.md#version) | **GET** /version | Get the Cachet version. +*IncidentsApi* | [**create_incident**](docs/IncidentsApi.md#create_incident) | **POST** /incidents | Create a new incident. +*IncidentsApi* | [**delete_incident_by_id**](docs/IncidentsApi.md#delete_incident_by_id) | **DELETE** /incidents/{incident} | Delete an incident +*IncidentsApi* | [**get_incident_by_id**](docs/IncidentsApi.md#get_incident_by_id) | **GET** /incidents/{incident} | Get an incident +*IncidentsApi* | [**get_incident_updates_by_id**](docs/IncidentsApi.md#get_incident_updates_by_id) | **GET** /incidents/{incident}/updates | Get incident updates +*IncidentsApi* | [**get_incidents**](docs/IncidentsApi.md#get_incidents) | **GET** /incidents | Get all incidents. +*IncidentsApi* | [**update_incident_by_id**](docs/IncidentsApi.md#update_incident_by_id) | **PUT** /incidents/{incident} | Update an incident +*MetricsApi* | [**create_metric**](docs/MetricsApi.md#create_metric) | **POST** /metrics | Create a metric +*MetricsApi* | [**create_metric_point_by_id**](docs/MetricsApi.md#create_metric_point_by_id) | **POST** /metrics/{metric}/points | Create point for a metric +*MetricsApi* | [**delete_metric_by_id**](docs/MetricsApi.md#delete_metric_by_id) | **DELETE** /metrics/{metric} | Delete a metric +*MetricsApi* | [**delete_metric_point_by_id**](docs/MetricsApi.md#delete_metric_point_by_id) | **DELETE** /metrics/{metric}/points/{point} | Delete a metric point +*MetricsApi* | [**get_metric_by_id**](docs/MetricsApi.md#get_metric_by_id) | **GET** /metrics/{metric} | Get a metric +*MetricsApi* | [**get_metric_points_by_id**](docs/MetricsApi.md#get_metric_points_by_id) | **GET** /metrics/{metric}/points | Get points for a metric +*MetricsApi* | [**get_metrics**](docs/MetricsApi.md#get_metrics) | **GET** /metrics | Get all metrics +*DefaultApi* | [**get_incident_update_by_id**](docs/DefaultApi.md#get_incident_update_by_id) | **GET** /incidents/{incident}/updates/{update} | Get an incident update + + +## Documentation For Models + + - [Component](docs/Component.md) + - [ComponentGroup](docs/ComponentGroup.md) + - [ComponentGroupResponse](docs/ComponentGroupResponse.md) + - [ComponentResponse](docs/ComponentResponse.md) + - [Error](docs/Error.md) + - [Incident](docs/Incident.md) + - [IncidentResponse](docs/IncidentResponse.md) + - [IncidentUpdateResponse](docs/IncidentUpdateResponse.md) + - [ListComponentGroupsResponse](docs/ListComponentGroupsResponse.md) + - [ListComponentsResponse](docs/ListComponentsResponse.md) + - [ListIncidentUpdatesResponse](docs/ListIncidentUpdatesResponse.md) + - [ListIncidentsResponse](docs/ListIncidentsResponse.md) + - [ListMetricPointsResponse](docs/ListMetricPointsResponse.md) + - [ListMetricsResponse](docs/ListMetricsResponse.md) + - [MetaData](docs/MetaData.md) + - [Metric](docs/Metric.md) + - [MetricPoint](docs/MetricPoint.md) + - [MetricPointsResponse](docs/MetricPointsResponse.md) + - [MetricsResponse](docs/MetricsResponse.md) + - [Pagination](docs/Pagination.md) + - [PaginationLinks](docs/PaginationLinks.md) + - [Ping](docs/Ping.md) + - [SingleComponentGroupResponse](docs/SingleComponentGroupResponse.md) + - [SingleComponentResponse](docs/SingleComponentResponse.md) + - [SingleIncidentResponse](docs/SingleIncidentResponse.md) + - [SingleIncidentUpdateResponse](docs/SingleIncidentUpdateResponse.md) + - [SingleMetricPointResponse](docs/SingleMetricPointResponse.md) + - [SingleMetricResponse](docs/SingleMetricResponse.md) + - [Version](docs/Version.md) + - [VersionMeta](docs/VersionMeta.md) + - [VersionMetaLatest](docs/VersionMetaLatest.md) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### apiKey + +- **Type**: API key +- **API key parameter name**: X-Cachet-Token +- **Location**: HTTP header + + +## Author + + + + diff --git a/api-doc/docs/Component.md b/api-doc/docs/Component.md new file mode 100644 index 0000000..90cdf39 --- /dev/null +++ b/api-doc/docs/Component.md @@ -0,0 +1,34 @@ +# Component + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**link** | **str** | | [optional] +**status** | **int** | | [optional] +**order** | **int** | | [optional] +**group_id** | **int** | | [optional] +**enabled** | **bool** | | [optional] + +## Example + +```python +from cachethq_client.models.component import Component + +# TODO update the JSON string below +json = "{}" +# create an instance of Component from a JSON string +component_instance = Component.from_json(json) +# print the JSON string representation of the object +print Component.to_json() + +# convert the object into a dict +component_dict = component_instance.to_dict() +# create an instance of Component from a dict +component_form_dict = component.from_dict(component_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ComponentGroup.md b/api-doc/docs/ComponentGroup.md new file mode 100644 index 0000000..ec233fb --- /dev/null +++ b/api-doc/docs/ComponentGroup.md @@ -0,0 +1,30 @@ +# ComponentGroup + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**order** | **int** | | [optional] +**collapsed** | **int** | | [optional] + +## Example + +```python +from cachethq_client.models.component_group import ComponentGroup + +# TODO update the JSON string below +json = "{}" +# create an instance of ComponentGroup from a JSON string +component_group_instance = ComponentGroup.from_json(json) +# print the JSON string representation of the object +print ComponentGroup.to_json() + +# convert the object into a dict +component_group_dict = component_group_instance.to_dict() +# create an instance of ComponentGroup from a dict +component_group_form_dict = component_group.from_dict(component_group_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ComponentGroupResponse.md b/api-doc/docs/ComponentGroupResponse.md new file mode 100644 index 0000000..baf7e19 --- /dev/null +++ b/api-doc/docs/ComponentGroupResponse.md @@ -0,0 +1,36 @@ +# ComponentGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**name** | **str** | | [optional] +**created_at** | **str** | | [optional] +**updated_at** | **str** | | [optional] +**order** | **int** | | [optional] +**collapsed** | **float** | | [optional] +**visible** | **float** | | [optional] +**enabled_components** | [**List[ComponentResponse]**](ComponentResponse.md) | | [optional] +**enabled_components_lowest** | [**List[ComponentResponse]**](ComponentResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.component_group_response import ComponentGroupResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ComponentGroupResponse from a JSON string +component_group_response_instance = ComponentGroupResponse.from_json(json) +# print the JSON string representation of the object +print ComponentGroupResponse.to_json() + +# convert the object into a dict +component_group_response_dict = component_group_response_instance.to_dict() +# create an instance of ComponentGroupResponse from a dict +component_group_response_form_dict = component_group_response.from_dict(component_group_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ComponentGroupsApi.md b/api-doc/docs/ComponentGroupsApi.md new file mode 100644 index 0000000..104dd23 --- /dev/null +++ b/api-doc/docs/ComponentGroupsApi.md @@ -0,0 +1,408 @@ +# cachethq_client.ComponentGroupsApi + +All URIs are relative to */api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_component_group**](ComponentGroupsApi.md#create_component_group) | **POST** /components/groups | Create a new Component Group. +[**delete_component_group_by_id**](ComponentGroupsApi.md#delete_component_group_by_id) | **DELETE** /components/groups/{group} | Delete a Component Group. +[**get_component_group_by_id**](ComponentGroupsApi.md#get_component_group_by_id) | **GET** /components/groups/{group} | Get a Component Group. +[**get_component_groups**](ComponentGroupsApi.md#get_component_groups) | **GET** /components/groups | Get all Component Groups. +[**update_component_group_by_id**](ComponentGroupsApi.md#update_component_group_by_id) | **PUT** /components/groups/{group} | Update a Component Group. + + +# **create_component_group** +> SingleComponentGroupResponse create_component_group(body) + +Create a new Component Group. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.component_group import ComponentGroup +from cachethq_client.models.single_component_group_response import SingleComponentGroupResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentGroupsApi(api_client) + body = cachethq_client.ComponentGroup() # ComponentGroup | Component Group to be created. + + try: + # Create a new Component Group. + api_response = api_instance.create_component_group(body) + print("The response of ComponentGroupsApi->create_component_group:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentGroupsApi->create_component_group: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**ComponentGroup**](ComponentGroup.md)| Component Group to be created. | + +### Return type + +[**SingleComponentGroupResponse**](SingleComponentGroupResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Create component group response | - | + +[[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) + +# **delete_component_group_by_id** +> str delete_component_group_by_id(group) + +Delete a Component Group. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentGroupsApi(api_client) + group = 56 # int | Unique component group id + + try: + # Delete a Component Group. + api_response = api_instance.delete_component_group_by_id(group) + print("The response of ComponentGroupsApi->delete_component_group_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentGroupsApi->delete_component_group_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | **int**| Unique component group id | + +### Return type + +**str** + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Delete component group response | - | + +[[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) + +# **get_component_group_by_id** +> SingleComponentGroupResponse get_component_group_by_id(group) + +Get a Component Group. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.single_component_group_response import SingleComponentGroupResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentGroupsApi(api_client) + group = 56 # int | Unique component group id + + try: + # Get a Component Group. + api_response = api_instance.get_component_group_by_id(group) + print("The response of ComponentGroupsApi->get_component_group_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentGroupsApi->get_component_group_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | **int**| Unique component group id | + +### Return type + +[**SingleComponentGroupResponse**](SingleComponentGroupResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get a component group | - | + +[[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) + +# **get_component_groups** +> ListComponentGroupsResponse get_component_groups(id=id, name=name, collapsed=collapsed, sort=sort, order=order, per_page=per_page, page=page) + +Get all Component Groups. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.list_component_groups_response import ListComponentGroupsResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentGroupsApi(api_client) + id = 56 # int | Unique component group id (optional) + name = 'name_example' # str | Full or partial component group name (optional) + collapsed = 3.4 # float | Group collapsed or not. (optional) + sort = 'id' # str | Object property to filter on. (optional) (default to 'id') + order = 'asc' # str | Ordering parameter with options of asc or desc. (optional) (default to 'asc') + per_page = 56 # int | Results per page. (optional) + page = 56 # int | (optional) + + try: + # Get all Component Groups. + api_response = api_instance.get_component_groups(id=id, name=name, collapsed=collapsed, sort=sort, order=order, per_page=per_page, page=page) + print("The response of ComponentGroupsApi->get_component_groups:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentGroupsApi->get_component_groups: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **int**| Unique component group id | [optional] + **name** | **str**| Full or partial component group name | [optional] + **collapsed** | **float**| Group collapsed or not. | [optional] + **sort** | **str**| Object property to filter on. | [optional] [default to 'id'] + **order** | **str**| Ordering parameter with options of asc or desc. | [optional] [default to 'asc'] + **per_page** | **int**| Results per page. | [optional] + **page** | **int**| | [optional] + +### Return type + +[**ListComponentGroupsResponse**](ListComponentGroupsResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get component groups response | - | + +[[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) + +# **update_component_group_by_id** +> SingleComponentGroupResponse update_component_group_by_id(group, body) + +Update a Component Group. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.component_group import ComponentGroup +from cachethq_client.models.single_component_group_response import SingleComponentGroupResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentGroupsApi(api_client) + group = 56 # int | Unique component group id + body = cachethq_client.ComponentGroup() # ComponentGroup | Component Group data to be updated + + try: + # Update a Component Group. + api_response = api_instance.update_component_group_by_id(group, body) + print("The response of ComponentGroupsApi->update_component_group_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentGroupsApi->update_component_group_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **group** | **int**| Unique component group id | + **body** | [**ComponentGroup**](ComponentGroup.md)| Component Group data to be updated | + +### Return type + +[**SingleComponentGroupResponse**](SingleComponentGroupResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Update component group response | - | + +[[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) + diff --git a/api-doc/docs/ComponentResponse.md b/api-doc/docs/ComponentResponse.md new file mode 100644 index 0000000..90de340 --- /dev/null +++ b/api-doc/docs/ComponentResponse.md @@ -0,0 +1,39 @@ +# ComponentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**name** | **str** | | [optional] +**description** | **str** | | [optional] +**link** | **str** | | [optional] +**status** | **int** | | [optional] +**order** | **int** | | [optional] +**group_id** | **int** | | [optional] +**created_at** | **str** | | [optional] +**updated_at** | **str** | | [optional] +**deleted_at** | **str** | | [optional] +**status_name** | **str** | | [optional] +**tags** | **Dict[str, object]** | Key-value pairs of tags where the key is the slug and the value is the name. | [optional] + +## Example + +```python +from cachethq_client.models.component_response import ComponentResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ComponentResponse from a JSON string +component_response_instance = ComponentResponse.from_json(json) +# print the JSON string representation of the object +print ComponentResponse.to_json() + +# convert the object into a dict +component_response_dict = component_response_instance.to_dict() +# create an instance of ComponentResponse from a dict +component_response_form_dict = component_response.from_dict(component_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ComponentsApi.md b/api-doc/docs/ComponentsApi.md new file mode 100644 index 0000000..0ffe233 --- /dev/null +++ b/api-doc/docs/ComponentsApi.md @@ -0,0 +1,413 @@ +# cachethq_client.ComponentsApi + +All URIs are relative to */api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_component**](ComponentsApi.md#create_component) | **POST** /components | Create a new component. +[**delete_component_by_id**](ComponentsApi.md#delete_component_by_id) | **DELETE** /components/{component} | Delete a component. +[**get_component_by_id**](ComponentsApi.md#get_component_by_id) | **GET** /components/{component} | Get a component. +[**get_components**](ComponentsApi.md#get_components) | **GET** /components | Get all components. +[**update_component_by_id**](ComponentsApi.md#update_component_by_id) | **PUT** /components/{component} | Update a component. + + +# **create_component** +> SingleComponentResponse create_component(body) + +Create a new component. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.component import Component +from cachethq_client.models.single_component_response import SingleComponentResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentsApi(api_client) + body = cachethq_client.Component() # Component | Component to be created. + + try: + # Create a new component. + api_response = api_instance.create_component(body) + print("The response of ComponentsApi->create_component:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentsApi->create_component: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Component**](Component.md)| Component to be created. | + +### Return type + +[**SingleComponentResponse**](SingleComponentResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Create component response | - | + +[[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) + +# **delete_component_by_id** +> str delete_component_by_id(component) + +Delete a component. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentsApi(api_client) + component = 56 # int | Unique component identifier. + + try: + # Delete a component. + api_response = api_instance.delete_component_by_id(component) + print("The response of ComponentsApi->delete_component_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentsApi->delete_component_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **component** | **int**| Unique component identifier. | + +### Return type + +**str** + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Delete component response | - | + +[[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) + +# **get_component_by_id** +> SingleComponentResponse get_component_by_id(component) + +Get a component. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.single_component_response import SingleComponentResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentsApi(api_client) + component = 56 # int | Unique component identifier. + + try: + # Get a component. + api_response = api_instance.get_component_by_id(component) + print("The response of ComponentsApi->get_component_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentsApi->get_component_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **component** | **int**| Unique component identifier. | + +### Return type + +[**SingleComponentResponse**](SingleComponentResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Component response | - | + +[[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) + +# **get_components** +> ListComponentsResponse get_components(sort=sort, order=order, per_page=per_page, page=page, id=id, name=name, status=status, group_id=group_id, enabled=enabled) + +Get all components. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.list_components_response import ListComponentsResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentsApi(api_client) + sort = 'id' # str | Object property to filter on. (optional) (default to 'id') + order = 'asc' # str | Ordering parameter with options of asc or desc. (optional) (default to 'asc') + per_page = 56 # int | Results per page. (optional) + page = 56 # int | (optional) + id = 56 # int | Unique identifier representing a specific component. (optional) + name = 'name_example' # str | Full name or partial name to search for a component. (optional) + status = 56 # int | Unique status identifier representing a specific component status. (optional) + group_id = 56 # int | Unique group identifier representing a specific component group. (optional) + enabled = True # bool | (optional) + + try: + # Get all components. + api_response = api_instance.get_components(sort=sort, order=order, per_page=per_page, page=page, id=id, name=name, status=status, group_id=group_id, enabled=enabled) + print("The response of ComponentsApi->get_components:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentsApi->get_components: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sort** | **str**| Object property to filter on. | [optional] [default to 'id'] + **order** | **str**| Ordering parameter with options of asc or desc. | [optional] [default to 'asc'] + **per_page** | **int**| Results per page. | [optional] + **page** | **int**| | [optional] + **id** | **int**| Unique identifier representing a specific component. | [optional] + **name** | **str**| Full name or partial name to search for a component. | [optional] + **status** | **int**| Unique status identifier representing a specific component status. | [optional] + **group_id** | **int**| Unique group identifier representing a specific component group. | [optional] + **enabled** | **bool**| | [optional] + +### Return type + +[**ListComponentsResponse**](ListComponentsResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Components response | - | +**0** | Unexpected error | - | + +[[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) + +# **update_component_by_id** +> SingleComponentResponse update_component_by_id(component, body) + +Update a component. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.component import Component +from cachethq_client.models.single_component_response import SingleComponentResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.ComponentsApi(api_client) + component = 56 # int | Unique component identifier. + body = cachethq_client.Component() # Component | Component data to be updated + + try: + # Update a component. + api_response = api_instance.update_component_by_id(component, body) + print("The response of ComponentsApi->update_component_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ComponentsApi->update_component_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **component** | **int**| Unique component identifier. | + **body** | [**Component**](Component.md)| Component data to be updated | + +### Return type + +[**SingleComponentResponse**](SingleComponentResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Update component response | - | + +[[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) + diff --git a/api-doc/docs/DefaultApi.md b/api-doc/docs/DefaultApi.md new file mode 100644 index 0000000..03da65c --- /dev/null +++ b/api-doc/docs/DefaultApi.md @@ -0,0 +1,87 @@ +# cachethq_client.DefaultApi + +All URIs are relative to */api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_incident_update_by_id**](DefaultApi.md#get_incident_update_by_id) | **GET** /incidents/{incident}/updates/{update} | Get an incident update + + +# **get_incident_update_by_id** +> SingleIncidentUpdateResponse get_incident_update_by_id(incident, update) + +Get an incident update + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.single_incident_update_response import SingleIncidentUpdateResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.DefaultApi(api_client) + incident = 56 # int | Unique incident id + update = 56 # int | Unique incident update id + + try: + # Get an incident update + api_response = api_instance.get_incident_update_by_id(incident, update) + print("The response of DefaultApi->get_incident_update_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling DefaultApi->get_incident_update_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **incident** | **int**| Unique incident id | + **update** | **int**| Unique incident update id | + +### Return type + +[**SingleIncidentUpdateResponse**](SingleIncidentUpdateResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get incident update response | - | + +[[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) + diff --git a/api-doc/docs/Error.md b/api-doc/docs/Error.md new file mode 100644 index 0000000..1d224b6 --- /dev/null +++ b/api-doc/docs/Error.md @@ -0,0 +1,30 @@ +# Error + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | | [optional] +**message** | **str** | | [optional] +**fields** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.error import Error + +# TODO update the JSON string below +json = "{}" +# create an instance of Error from a JSON string +error_instance = Error.from_json(json) +# print the JSON string representation of the object +print Error.to_json() + +# convert the object into a dict +error_dict = error_instance.to_dict() +# create an instance of Error from a dict +error_form_dict = error.from_dict(error_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/GeneralApi.md b/api-doc/docs/GeneralApi.md new file mode 100644 index 0000000..d67522c --- /dev/null +++ b/api-doc/docs/GeneralApi.md @@ -0,0 +1,156 @@ +# cachethq_client.GeneralApi + +All URIs are relative to */api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**ping**](GeneralApi.md#ping) | **GET** /ping | Test that the API is responding to your requests. +[**version**](GeneralApi.md#version) | **GET** /version | Get the Cachet version. + + +# **ping** +> Ping ping() + +Test that the API is responding to your requests. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.ping import Ping +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.GeneralApi(api_client) + + try: + # Test that the API is responding to your requests. + api_response = api_instance.ping() + print("The response of GeneralApi->ping:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GeneralApi->ping: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**Ping**](Ping.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Ping response | - | +**0** | Unexpected error | - | + +[[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) + +# **version** +> Version version() + +Get the Cachet version. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.version import Version +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.GeneralApi(api_client) + + try: + # Get the Cachet version. + api_response = api_instance.version() + print("The response of GeneralApi->version:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling GeneralApi->version: %s\n" % e) +``` + + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**Version**](Version.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Version response | - | +**0** | Unexpected error | - | + +[[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) + diff --git a/api-doc/docs/Incident.md b/api-doc/docs/Incident.md new file mode 100644 index 0000000..f2945b9 --- /dev/null +++ b/api-doc/docs/Incident.md @@ -0,0 +1,37 @@ +# Incident + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**message** | **str** | | [optional] +**status** | **int** | | [optional] +**visible** | **int** | | [optional] +**component_id** | **int** | | [optional] +**component_status** | **int** | | [optional] +**notify** | **float** | | [optional] +**created_at** | **str** | | [optional] +**template** | **str** | | [optional] +**vars** | **object** | | [optional] + +## Example + +```python +from cachethq_client.models.incident import Incident + +# TODO update the JSON string below +json = "{}" +# create an instance of Incident from a JSON string +incident_instance = Incident.from_json(json) +# print the JSON string representation of the object +print Incident.to_json() + +# convert the object into a dict +incident_dict = incident_instance.to_dict() +# create an instance of Incident from a dict +incident_form_dict = incident.from_dict(incident_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/IncidentResponse.md b/api-doc/docs/IncidentResponse.md new file mode 100644 index 0000000..577f080 --- /dev/null +++ b/api-doc/docs/IncidentResponse.md @@ -0,0 +1,38 @@ +# IncidentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**component_id** | **int** | | [optional] +**name** | **str** | | [optional] +**status** | **int** | | [optional] +**visible** | **int** | | [optional] +**message** | **str** | | [optional] +**scheduled_at** | **str** | | [optional] +**created_at** | **str** | | [optional] +**updated_at** | **str** | | [optional] +**deleted_at** | **str** | | [optional] +**human_status** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.incident_response import IncidentResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of IncidentResponse from a JSON string +incident_response_instance = IncidentResponse.from_json(json) +# print the JSON string representation of the object +print IncidentResponse.to_json() + +# convert the object into a dict +incident_response_dict = incident_response_instance.to_dict() +# create an instance of IncidentResponse from a dict +incident_response_form_dict = incident_response.from_dict(incident_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/IncidentUpdateResponse.md b/api-doc/docs/IncidentUpdateResponse.md new file mode 100644 index 0000000..8a8d58b --- /dev/null +++ b/api-doc/docs/IncidentUpdateResponse.md @@ -0,0 +1,36 @@ +# IncidentUpdateResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**incident_id** | **int** | | [optional] +**status** | **int** | | [optional] +**message** | **str** | | [optional] +**user_id** | **int** | | [optional] +**created_at** | **str** | | [optional] +**updated_at** | **str** | | [optional] +**human_status** | **str** | | [optional] +**permalink** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.incident_update_response import IncidentUpdateResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of IncidentUpdateResponse from a JSON string +incident_update_response_instance = IncidentUpdateResponse.from_json(json) +# print the JSON string representation of the object +print IncidentUpdateResponse.to_json() + +# convert the object into a dict +incident_update_response_dict = incident_update_response_instance.to_dict() +# create an instance of IncidentUpdateResponse from a dict +incident_update_response_form_dict = incident_update_response.from_dict(incident_update_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/IncidentsApi.md b/api-doc/docs/IncidentsApi.md new file mode 100644 index 0000000..cb53652 --- /dev/null +++ b/api-doc/docs/IncidentsApi.md @@ -0,0 +1,497 @@ +# cachethq_client.IncidentsApi + +All URIs are relative to */api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_incident**](IncidentsApi.md#create_incident) | **POST** /incidents | Create a new incident. +[**delete_incident_by_id**](IncidentsApi.md#delete_incident_by_id) | **DELETE** /incidents/{incident} | Delete an incident +[**get_incident_by_id**](IncidentsApi.md#get_incident_by_id) | **GET** /incidents/{incident} | Get an incident +[**get_incident_updates_by_id**](IncidentsApi.md#get_incident_updates_by_id) | **GET** /incidents/{incident}/updates | Get incident updates +[**get_incidents**](IncidentsApi.md#get_incidents) | **GET** /incidents | Get all incidents. +[**update_incident_by_id**](IncidentsApi.md#update_incident_by_id) | **PUT** /incidents/{incident} | Update an incident + + +# **create_incident** +> SingleIncidentResponse create_incident(body) + +Create a new incident. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.incident import Incident +from cachethq_client.models.single_incident_response import SingleIncidentResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.IncidentsApi(api_client) + body = cachethq_client.Incident() # Incident | Incident to be created + + try: + # Create a new incident. + api_response = api_instance.create_incident(body) + print("The response of IncidentsApi->create_incident:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IncidentsApi->create_incident: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Incident**](Incident.md)| Incident to be created | + +### Return type + +[**SingleIncidentResponse**](SingleIncidentResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Incident created response | - | + +[[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) + +# **delete_incident_by_id** +> str delete_incident_by_id(incident) + +Delete an incident + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.IncidentsApi(api_client) + incident = 56 # int | Unique incident id + + try: + # Delete an incident + api_response = api_instance.delete_incident_by_id(incident) + print("The response of IncidentsApi->delete_incident_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IncidentsApi->delete_incident_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **incident** | **int**| Unique incident id | + +### Return type + +**str** + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Delete incident response | - | + +[[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) + +# **get_incident_by_id** +> SingleIncidentResponse get_incident_by_id(incident) + +Get an incident + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.single_incident_response import SingleIncidentResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.IncidentsApi(api_client) + incident = 56 # int | Unique incident id + + try: + # Get an incident + api_response = api_instance.get_incident_by_id(incident) + print("The response of IncidentsApi->get_incident_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IncidentsApi->get_incident_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **incident** | **int**| Unique incident id | + +### Return type + +[**SingleIncidentResponse**](SingleIncidentResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get incident response | - | + +[[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) + +# **get_incident_updates_by_id** +> ListIncidentUpdatesResponse get_incident_updates_by_id(incident, sort=sort, order=order, per_page=per_page, page=page) + +Get incident updates + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.list_incident_updates_response import ListIncidentUpdatesResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.IncidentsApi(api_client) + incident = 56 # int | Unique incident id + sort = 'id' # str | Object property to filter on. (optional) (default to 'id') + order = 'asc' # str | Ordering parameter with options of asc or desc. (optional) (default to 'asc') + per_page = 56 # int | Results per page. (optional) + page = 56 # int | (optional) + + try: + # Get incident updates + api_response = api_instance.get_incident_updates_by_id(incident, sort=sort, order=order, per_page=per_page, page=page) + print("The response of IncidentsApi->get_incident_updates_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IncidentsApi->get_incident_updates_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **incident** | **int**| Unique incident id | + **sort** | **str**| Object property to filter on. | [optional] [default to 'id'] + **order** | **str**| Ordering parameter with options of asc or desc. | [optional] [default to 'asc'] + **per_page** | **int**| Results per page. | [optional] + **page** | **int**| | [optional] + +### Return type + +[**ListIncidentUpdatesResponse**](ListIncidentUpdatesResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get incident updates response | - | + +[[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) + +# **get_incidents** +> ListIncidentsResponse get_incidents(id=id, component_id=component_id, name=name, status=status, visible=visible, sort=sort, order=order, per_page=per_page, page=page) + +Get all incidents. + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.list_incidents_response import ListIncidentsResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.IncidentsApi(api_client) + id = 56 # int | Unique incident id (optional) + component_id = 56 # int | Unique component group id (optional) + name = 'name_example' # str | Full or partial component group name (optional) + status = 56 # int | (optional) + visible = 3.4 # float | (optional) + sort = 'id' # str | Object property to filter on. (optional) (default to 'id') + order = 'asc' # str | Ordering parameter with options of asc or desc. (optional) (default to 'asc') + per_page = 56 # int | Results per page. (optional) + page = 56 # int | (optional) + + try: + # Get all incidents. + api_response = api_instance.get_incidents(id=id, component_id=component_id, name=name, status=status, visible=visible, sort=sort, order=order, per_page=per_page, page=page) + print("The response of IncidentsApi->get_incidents:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IncidentsApi->get_incidents: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **int**| Unique incident id | [optional] + **component_id** | **int**| Unique component group id | [optional] + **name** | **str**| Full or partial component group name | [optional] + **status** | **int**| | [optional] + **visible** | **float**| | [optional] + **sort** | **str**| Object property to filter on. | [optional] [default to 'id'] + **order** | **str**| Ordering parameter with options of asc or desc. | [optional] [default to 'asc'] + **per_page** | **int**| Results per page. | [optional] + **page** | **int**| | [optional] + +### Return type + +[**ListIncidentsResponse**](ListIncidentsResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get incidents response | - | + +[[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) + +# **update_incident_by_id** +> SingleIncidentResponse update_incident_by_id(incident, body) + +Update an incident + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.incident import Incident +from cachethq_client.models.single_incident_response import SingleIncidentResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.IncidentsApi(api_client) + incident = 56 # int | Unique incident id + body = cachethq_client.Incident() # Incident | Incident data to be updated + + try: + # Update an incident + api_response = api_instance.update_incident_by_id(incident, body) + print("The response of IncidentsApi->update_incident_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling IncidentsApi->update_incident_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **incident** | **int**| Unique incident id | + **body** | [**Incident**](Incident.md)| Incident data to be updated | + +### Return type + +[**SingleIncidentResponse**](SingleIncidentResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Update incident response | - | + +[[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) + diff --git a/api-doc/docs/ListComponentGroupsResponse.md b/api-doc/docs/ListComponentGroupsResponse.md new file mode 100644 index 0000000..1934785 --- /dev/null +++ b/api-doc/docs/ListComponentGroupsResponse.md @@ -0,0 +1,29 @@ +# ListComponentGroupsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**MetaData**](MetaData.md) | | [optional] +**data** | [**List[ComponentGroupResponse]**](ComponentGroupResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.list_component_groups_response import ListComponentGroupsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListComponentGroupsResponse from a JSON string +list_component_groups_response_instance = ListComponentGroupsResponse.from_json(json) +# print the JSON string representation of the object +print ListComponentGroupsResponse.to_json() + +# convert the object into a dict +list_component_groups_response_dict = list_component_groups_response_instance.to_dict() +# create an instance of ListComponentGroupsResponse from a dict +list_component_groups_response_form_dict = list_component_groups_response.from_dict(list_component_groups_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ListComponentsResponse.md b/api-doc/docs/ListComponentsResponse.md new file mode 100644 index 0000000..d6efcf6 --- /dev/null +++ b/api-doc/docs/ListComponentsResponse.md @@ -0,0 +1,29 @@ +# ListComponentsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**MetaData**](MetaData.md) | | [optional] +**data** | [**List[ComponentResponse]**](ComponentResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.list_components_response import ListComponentsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListComponentsResponse from a JSON string +list_components_response_instance = ListComponentsResponse.from_json(json) +# print the JSON string representation of the object +print ListComponentsResponse.to_json() + +# convert the object into a dict +list_components_response_dict = list_components_response_instance.to_dict() +# create an instance of ListComponentsResponse from a dict +list_components_response_form_dict = list_components_response.from_dict(list_components_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ListIncidentUpdatesResponse.md b/api-doc/docs/ListIncidentUpdatesResponse.md new file mode 100644 index 0000000..9dcdb9d --- /dev/null +++ b/api-doc/docs/ListIncidentUpdatesResponse.md @@ -0,0 +1,29 @@ +# ListIncidentUpdatesResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**MetaData**](MetaData.md) | | [optional] +**data** | [**List[IncidentUpdateResponse]**](IncidentUpdateResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.list_incident_updates_response import ListIncidentUpdatesResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListIncidentUpdatesResponse from a JSON string +list_incident_updates_response_instance = ListIncidentUpdatesResponse.from_json(json) +# print the JSON string representation of the object +print ListIncidentUpdatesResponse.to_json() + +# convert the object into a dict +list_incident_updates_response_dict = list_incident_updates_response_instance.to_dict() +# create an instance of ListIncidentUpdatesResponse from a dict +list_incident_updates_response_form_dict = list_incident_updates_response.from_dict(list_incident_updates_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ListIncidentsResponse.md b/api-doc/docs/ListIncidentsResponse.md new file mode 100644 index 0000000..c02d460 --- /dev/null +++ b/api-doc/docs/ListIncidentsResponse.md @@ -0,0 +1,29 @@ +# ListIncidentsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**MetaData**](MetaData.md) | | [optional] +**data** | [**List[IncidentResponse]**](IncidentResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.list_incidents_response import ListIncidentsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListIncidentsResponse from a JSON string +list_incidents_response_instance = ListIncidentsResponse.from_json(json) +# print the JSON string representation of the object +print ListIncidentsResponse.to_json() + +# convert the object into a dict +list_incidents_response_dict = list_incidents_response_instance.to_dict() +# create an instance of ListIncidentsResponse from a dict +list_incidents_response_form_dict = list_incidents_response.from_dict(list_incidents_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ListMetricPointsResponse.md b/api-doc/docs/ListMetricPointsResponse.md new file mode 100644 index 0000000..28964c4 --- /dev/null +++ b/api-doc/docs/ListMetricPointsResponse.md @@ -0,0 +1,29 @@ +# ListMetricPointsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**MetaData**](MetaData.md) | | [optional] +**data** | [**List[MetricPointsResponse]**](MetricPointsResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.list_metric_points_response import ListMetricPointsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListMetricPointsResponse from a JSON string +list_metric_points_response_instance = ListMetricPointsResponse.from_json(json) +# print the JSON string representation of the object +print ListMetricPointsResponse.to_json() + +# convert the object into a dict +list_metric_points_response_dict = list_metric_points_response_instance.to_dict() +# create an instance of ListMetricPointsResponse from a dict +list_metric_points_response_form_dict = list_metric_points_response.from_dict(list_metric_points_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/ListMetricsResponse.md b/api-doc/docs/ListMetricsResponse.md new file mode 100644 index 0000000..1ea5b8d --- /dev/null +++ b/api-doc/docs/ListMetricsResponse.md @@ -0,0 +1,29 @@ +# ListMetricsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**MetaData**](MetaData.md) | | [optional] +**data** | [**List[MetricsResponse]**](MetricsResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.list_metrics_response import ListMetricsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListMetricsResponse from a JSON string +list_metrics_response_instance = ListMetricsResponse.from_json(json) +# print the JSON string representation of the object +print ListMetricsResponse.to_json() + +# convert the object into a dict +list_metrics_response_dict = list_metrics_response_instance.to_dict() +# create an instance of ListMetricsResponse from a dict +list_metrics_response_form_dict = list_metrics_response.from_dict(list_metrics_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/MetaData.md b/api-doc/docs/MetaData.md new file mode 100644 index 0000000..e512271 --- /dev/null +++ b/api-doc/docs/MetaData.md @@ -0,0 +1,28 @@ +# MetaData + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pagination** | [**Pagination**](Pagination.md) | | [optional] + +## Example + +```python +from cachethq_client.models.meta_data import MetaData + +# TODO update the JSON string below +json = "{}" +# create an instance of MetaData from a JSON string +meta_data_instance = MetaData.from_json(json) +# print the JSON string representation of the object +print MetaData.to_json() + +# convert the object into a dict +meta_data_dict = meta_data_instance.to_dict() +# create an instance of MetaData from a dict +meta_data_form_dict = meta_data.from_dict(meta_data_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/Metric.md b/api-doc/docs/Metric.md new file mode 100644 index 0000000..a255872 --- /dev/null +++ b/api-doc/docs/Metric.md @@ -0,0 +1,32 @@ +# Metric + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | | [optional] +**suffix** | **str** | | [optional] +**description** | **str** | | [optional] +**default_value** | **int** | | [optional] +**display_chart** | **int** | | [optional] + +## Example + +```python +from cachethq_client.models.metric import Metric + +# TODO update the JSON string below +json = "{}" +# create an instance of Metric from a JSON string +metric_instance = Metric.from_json(json) +# print the JSON string representation of the object +print Metric.to_json() + +# convert the object into a dict +metric_dict = metric_instance.to_dict() +# create an instance of Metric from a dict +metric_form_dict = metric.from_dict(metric_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/MetricPoint.md b/api-doc/docs/MetricPoint.md new file mode 100644 index 0000000..234d2ff --- /dev/null +++ b/api-doc/docs/MetricPoint.md @@ -0,0 +1,29 @@ +# MetricPoint + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | **float** | | [optional] +**timestamp** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.metric_point import MetricPoint + +# TODO update the JSON string below +json = "{}" +# create an instance of MetricPoint from a JSON string +metric_point_instance = MetricPoint.from_json(json) +# print the JSON string representation of the object +print MetricPoint.to_json() + +# convert the object into a dict +metric_point_dict = metric_point_instance.to_dict() +# create an instance of MetricPoint from a dict +metric_point_form_dict = metric_point.from_dict(metric_point_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/MetricPointsResponse.md b/api-doc/docs/MetricPointsResponse.md new file mode 100644 index 0000000..822e164 --- /dev/null +++ b/api-doc/docs/MetricPointsResponse.md @@ -0,0 +1,34 @@ +# MetricPointsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**metric_id** | **int** | | [optional] +**value** | **float** | | [optional] +**counter** | **int** | | [optional] +**calculated_value** | **float** | | [optional] +**created_at** | **str** | | [optional] +**updated_at** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.metric_points_response import MetricPointsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of MetricPointsResponse from a JSON string +metric_points_response_instance = MetricPointsResponse.from_json(json) +# print the JSON string representation of the object +print MetricPointsResponse.to_json() + +# convert the object into a dict +metric_points_response_dict = metric_points_response_instance.to_dict() +# create an instance of MetricPointsResponse from a dict +metric_points_response_form_dict = metric_points_response.from_dict(metric_points_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/MetricsApi.md b/api-doc/docs/MetricsApi.md new file mode 100644 index 0000000..67e9ccf --- /dev/null +++ b/api-doc/docs/MetricsApi.md @@ -0,0 +1,565 @@ +# cachethq_client.MetricsApi + +All URIs are relative to */api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_metric**](MetricsApi.md#create_metric) | **POST** /metrics | Create a metric +[**create_metric_point_by_id**](MetricsApi.md#create_metric_point_by_id) | **POST** /metrics/{metric}/points | Create point for a metric +[**delete_metric_by_id**](MetricsApi.md#delete_metric_by_id) | **DELETE** /metrics/{metric} | Delete a metric +[**delete_metric_point_by_id**](MetricsApi.md#delete_metric_point_by_id) | **DELETE** /metrics/{metric}/points/{point} | Delete a metric point +[**get_metric_by_id**](MetricsApi.md#get_metric_by_id) | **GET** /metrics/{metric} | Get a metric +[**get_metric_points_by_id**](MetricsApi.md#get_metric_points_by_id) | **GET** /metrics/{metric}/points | Get points for a metric +[**get_metrics**](MetricsApi.md#get_metrics) | **GET** /metrics | Get all metrics + + +# **create_metric** +> SingleMetricResponse create_metric(body) + +Create a metric + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.metric import Metric +from cachethq_client.models.single_metric_response import SingleMetricResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.MetricsApi(api_client) + body = cachethq_client.Metric() # Metric | Create metric data + + try: + # Create a metric + api_response = api_instance.create_metric(body) + print("The response of MetricsApi->create_metric:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MetricsApi->create_metric: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Metric**](Metric.md)| Create metric data | + +### Return type + +[**SingleMetricResponse**](SingleMetricResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Create metric response | - | + +[[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) + +# **create_metric_point_by_id** +> SingleMetricPointResponse create_metric_point_by_id(metric, body) + +Create point for a metric + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.metric_point import MetricPoint +from cachethq_client.models.single_metric_point_response import SingleMetricPointResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.MetricsApi(api_client) + metric = 56 # int | Unique metric id + body = cachethq_client.MetricPoint() # MetricPoint | Metric data + + try: + # Create point for a metric + api_response = api_instance.create_metric_point_by_id(metric, body) + print("The response of MetricsApi->create_metric_point_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MetricsApi->create_metric_point_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **metric** | **int**| Unique metric id | + **body** | [**MetricPoint**](MetricPoint.md)| Metric data | + +### Return type + +[**SingleMetricPointResponse**](SingleMetricPointResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Create metric point response | - | + +[[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) + +# **delete_metric_by_id** +> str delete_metric_by_id(metric) + +Delete a metric + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.MetricsApi(api_client) + metric = 56 # int | Unique metric id + + try: + # Delete a metric + api_response = api_instance.delete_metric_by_id(metric) + print("The response of MetricsApi->delete_metric_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MetricsApi->delete_metric_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **metric** | **int**| Unique metric id | + +### Return type + +**str** + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Delete metric response | - | + +[[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) + +# **delete_metric_point_by_id** +> str delete_metric_point_by_id(metric, point) + +Delete a metric point + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.MetricsApi(api_client) + metric = 56 # int | Unique metric id + point = 56 # int | Unique metric point id + + try: + # Delete a metric point + api_response = api_instance.delete_metric_point_by_id(metric, point) + print("The response of MetricsApi->delete_metric_point_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MetricsApi->delete_metric_point_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **metric** | **int**| Unique metric id | + **point** | **int**| Unique metric point id | + +### Return type + +**str** + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Delete metric point response | - | + +[[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) + +# **get_metric_by_id** +> SingleMetricResponse get_metric_by_id(metric) + +Get a metric + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.single_metric_response import SingleMetricResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.MetricsApi(api_client) + metric = 56 # int | Unique metric id + + try: + # Get a metric + api_response = api_instance.get_metric_by_id(metric) + print("The response of MetricsApi->get_metric_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MetricsApi->get_metric_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **metric** | **int**| Unique metric id | + +### Return type + +[**SingleMetricResponse**](SingleMetricResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get metric response | - | + +[[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) + +# **get_metric_points_by_id** +> ListMetricPointsResponse get_metric_points_by_id(metric, sort=sort, order=order, per_page=per_page, page=page) + +Get points for a metric + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.list_metric_points_response import ListMetricPointsResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.MetricsApi(api_client) + metric = 56 # int | Unique metric id + sort = 'id' # str | Object property to filter on. (optional) (default to 'id') + order = 'asc' # str | Ordering parameter with options of asc or desc. (optional) (default to 'asc') + per_page = 56 # int | Results per page. (optional) + page = 56 # int | (optional) + + try: + # Get points for a metric + api_response = api_instance.get_metric_points_by_id(metric, sort=sort, order=order, per_page=per_page, page=page) + print("The response of MetricsApi->get_metric_points_by_id:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MetricsApi->get_metric_points_by_id: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **metric** | **int**| Unique metric id | + **sort** | **str**| Object property to filter on. | [optional] [default to 'id'] + **order** | **str**| Ordering parameter with options of asc or desc. | [optional] [default to 'asc'] + **per_page** | **int**| Results per page. | [optional] + **page** | **int**| | [optional] + +### Return type + +[**ListMetricPointsResponse**](ListMetricPointsResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get metric points response | - | + +[[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) + +# **get_metrics** +> ListMetricsResponse get_metrics(sort=sort, order=order, per_page=per_page, page=page) + +Get all metrics + +### Example + +* Api Key Authentication (apiKey): +```python +import time +import os +import cachethq_client +from cachethq_client.models.list_metrics_response import ListMetricsResponse +from cachethq_client.rest import ApiException +from pprint import pprint + +# Defining the host is optional and defaults to /api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = cachethq_client.Configuration( + host = "/api/v1" +) + +# 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 API key authorization: apiKey +configuration.api_key['apiKey'] = os.environ["API_KEY"] + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['apiKey'] = 'Bearer' + +# Enter a context with an instance of the API client +with cachethq_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = cachethq_client.MetricsApi(api_client) + sort = 'id' # str | Object property to filter on. (optional) (default to 'id') + order = 'asc' # str | Ordering parameter with options of asc or desc. (optional) (default to 'asc') + per_page = 56 # int | Results per page. (optional) + page = 56 # int | (optional) + + try: + # Get all metrics + api_response = api_instance.get_metrics(sort=sort, order=order, per_page=per_page, page=page) + print("The response of MetricsApi->get_metrics:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling MetricsApi->get_metrics: %s\n" % e) +``` + + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **sort** | **str**| Object property to filter on. | [optional] [default to 'id'] + **order** | **str**| Ordering parameter with options of asc or desc. | [optional] [default to 'asc'] + **per_page** | **int**| Results per page. | [optional] + **page** | **int**| | [optional] + +### Return type + +[**ListMetricsResponse**](ListMetricsResponse.md) + +### Authorization + +[apiKey](../README.md#apiKey) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Get metrics response | - | + +[[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) + diff --git a/api-doc/docs/MetricsResponse.md b/api-doc/docs/MetricsResponse.md new file mode 100644 index 0000000..84ee0d2 --- /dev/null +++ b/api-doc/docs/MetricsResponse.md @@ -0,0 +1,42 @@ +# MetricsResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **int** | | [optional] +**name** | **str** | | [optional] +**suffix** | **str** | | [optional] +**description** | **str** | | [optional] +**default_value** | **float** | | [optional] +**calc_type** | **int** | | [optional] +**display_chart** | **bool** | | [optional] +**created_at** | **str** | | [optional] +**updated_at** | **str** | | [optional] +**places** | **int** | | [optional] +**default_view** | **int** | | [optional] +**threshold** | **int** | | [optional] +**order** | **int** | | [optional] +**visible** | **int** | | [optional] +**default_view_name** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.metrics_response import MetricsResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of MetricsResponse from a JSON string +metrics_response_instance = MetricsResponse.from_json(json) +# print the JSON string representation of the object +print MetricsResponse.to_json() + +# convert the object into a dict +metrics_response_dict = metrics_response_instance.to_dict() +# create an instance of MetricsResponse from a dict +metrics_response_form_dict = metrics_response.from_dict(metrics_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/Pagination.md b/api-doc/docs/Pagination.md new file mode 100644 index 0000000..ac27974 --- /dev/null +++ b/api-doc/docs/Pagination.md @@ -0,0 +1,33 @@ +# Pagination + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**total** | **int** | | [optional] +**count** | **int** | | [optional] +**per_page** | **int** | | [optional] +**current_page** | **int** | | [optional] +**total_pages** | **int** | | [optional] +**links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] + +## Example + +```python +from cachethq_client.models.pagination import Pagination + +# TODO update the JSON string below +json = "{}" +# create an instance of Pagination from a JSON string +pagination_instance = Pagination.from_json(json) +# print the JSON string representation of the object +print Pagination.to_json() + +# convert the object into a dict +pagination_dict = pagination_instance.to_dict() +# create an instance of Pagination from a dict +pagination_form_dict = pagination.from_dict(pagination_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/PaginationLinks.md b/api-doc/docs/PaginationLinks.md new file mode 100644 index 0000000..0912911 --- /dev/null +++ b/api-doc/docs/PaginationLinks.md @@ -0,0 +1,29 @@ +# PaginationLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**next_page** | **str** | | [optional] +**previous_page** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.pagination_links import PaginationLinks + +# TODO update the JSON string below +json = "{}" +# create an instance of PaginationLinks from a JSON string +pagination_links_instance = PaginationLinks.from_json(json) +# print the JSON string representation of the object +print PaginationLinks.to_json() + +# convert the object into a dict +pagination_links_dict = pagination_links_instance.to_dict() +# create an instance of PaginationLinks from a dict +pagination_links_form_dict = pagination_links.from_dict(pagination_links_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/Ping.md b/api-doc/docs/Ping.md new file mode 100644 index 0000000..e41eccc --- /dev/null +++ b/api-doc/docs/Ping.md @@ -0,0 +1,28 @@ +# Ping + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.ping import Ping + +# TODO update the JSON string below +json = "{}" +# create an instance of Ping from a JSON string +ping_instance = Ping.from_json(json) +# print the JSON string representation of the object +print Ping.to_json() + +# convert the object into a dict +ping_dict = ping_instance.to_dict() +# create an instance of Ping from a dict +ping_form_dict = ping.from_dict(ping_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/SingleComponentGroupResponse.md b/api-doc/docs/SingleComponentGroupResponse.md new file mode 100644 index 0000000..c3e4330 --- /dev/null +++ b/api-doc/docs/SingleComponentGroupResponse.md @@ -0,0 +1,28 @@ +# SingleComponentGroupResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ComponentGroupResponse**](ComponentGroupResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.single_component_group_response import SingleComponentGroupResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of SingleComponentGroupResponse from a JSON string +single_component_group_response_instance = SingleComponentGroupResponse.from_json(json) +# print the JSON string representation of the object +print SingleComponentGroupResponse.to_json() + +# convert the object into a dict +single_component_group_response_dict = single_component_group_response_instance.to_dict() +# create an instance of SingleComponentGroupResponse from a dict +single_component_group_response_form_dict = single_component_group_response.from_dict(single_component_group_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/SingleComponentResponse.md b/api-doc/docs/SingleComponentResponse.md new file mode 100644 index 0000000..6373122 --- /dev/null +++ b/api-doc/docs/SingleComponentResponse.md @@ -0,0 +1,28 @@ +# SingleComponentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**ComponentResponse**](ComponentResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.single_component_response import SingleComponentResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of SingleComponentResponse from a JSON string +single_component_response_instance = SingleComponentResponse.from_json(json) +# print the JSON string representation of the object +print SingleComponentResponse.to_json() + +# convert the object into a dict +single_component_response_dict = single_component_response_instance.to_dict() +# create an instance of SingleComponentResponse from a dict +single_component_response_form_dict = single_component_response.from_dict(single_component_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/SingleIncidentResponse.md b/api-doc/docs/SingleIncidentResponse.md new file mode 100644 index 0000000..3916401 --- /dev/null +++ b/api-doc/docs/SingleIncidentResponse.md @@ -0,0 +1,28 @@ +# SingleIncidentResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**IncidentResponse**](IncidentResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.single_incident_response import SingleIncidentResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of SingleIncidentResponse from a JSON string +single_incident_response_instance = SingleIncidentResponse.from_json(json) +# print the JSON string representation of the object +print SingleIncidentResponse.to_json() + +# convert the object into a dict +single_incident_response_dict = single_incident_response_instance.to_dict() +# create an instance of SingleIncidentResponse from a dict +single_incident_response_form_dict = single_incident_response.from_dict(single_incident_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/SingleIncidentUpdateResponse.md b/api-doc/docs/SingleIncidentUpdateResponse.md new file mode 100644 index 0000000..f13c178 --- /dev/null +++ b/api-doc/docs/SingleIncidentUpdateResponse.md @@ -0,0 +1,28 @@ +# SingleIncidentUpdateResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**IncidentUpdateResponse**](IncidentUpdateResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.single_incident_update_response import SingleIncidentUpdateResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of SingleIncidentUpdateResponse from a JSON string +single_incident_update_response_instance = SingleIncidentUpdateResponse.from_json(json) +# print the JSON string representation of the object +print SingleIncidentUpdateResponse.to_json() + +# convert the object into a dict +single_incident_update_response_dict = single_incident_update_response_instance.to_dict() +# create an instance of SingleIncidentUpdateResponse from a dict +single_incident_update_response_form_dict = single_incident_update_response.from_dict(single_incident_update_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/SingleMetricPointResponse.md b/api-doc/docs/SingleMetricPointResponse.md new file mode 100644 index 0000000..66db7ce --- /dev/null +++ b/api-doc/docs/SingleMetricPointResponse.md @@ -0,0 +1,28 @@ +# SingleMetricPointResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**MetricPointsResponse**](MetricPointsResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.single_metric_point_response import SingleMetricPointResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of SingleMetricPointResponse from a JSON string +single_metric_point_response_instance = SingleMetricPointResponse.from_json(json) +# print the JSON string representation of the object +print SingleMetricPointResponse.to_json() + +# convert the object into a dict +single_metric_point_response_dict = single_metric_point_response_instance.to_dict() +# create an instance of SingleMetricPointResponse from a dict +single_metric_point_response_form_dict = single_metric_point_response.from_dict(single_metric_point_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/SingleMetricResponse.md b/api-doc/docs/SingleMetricResponse.md new file mode 100644 index 0000000..b7f2552 --- /dev/null +++ b/api-doc/docs/SingleMetricResponse.md @@ -0,0 +1,28 @@ +# SingleMetricResponse + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**MetricsResponse**](MetricsResponse.md) | | [optional] + +## Example + +```python +from cachethq_client.models.single_metric_response import SingleMetricResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of SingleMetricResponse from a JSON string +single_metric_response_instance = SingleMetricResponse.from_json(json) +# print the JSON string representation of the object +print SingleMetricResponse.to_json() + +# convert the object into a dict +single_metric_response_dict = single_metric_response_instance.to_dict() +# create an instance of SingleMetricResponse from a dict +single_metric_response_form_dict = single_metric_response.from_dict(single_metric_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/Version.md b/api-doc/docs/Version.md new file mode 100644 index 0000000..96fea1d --- /dev/null +++ b/api-doc/docs/Version.md @@ -0,0 +1,29 @@ +# Version + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**meta** | [**VersionMeta**](VersionMeta.md) | | [optional] +**data** | **str** | | [optional] + +## Example + +```python +from cachethq_client.models.version import Version + +# TODO update the JSON string below +json = "{}" +# create an instance of Version from a JSON string +version_instance = Version.from_json(json) +# print the JSON string representation of the object +print Version.to_json() + +# convert the object into a dict +version_dict = version_instance.to_dict() +# create an instance of Version from a dict +version_form_dict = version.from_dict(version_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/VersionMeta.md b/api-doc/docs/VersionMeta.md new file mode 100644 index 0000000..fa38ad1 --- /dev/null +++ b/api-doc/docs/VersionMeta.md @@ -0,0 +1,29 @@ +# VersionMeta + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**on_latest** | **bool** | | [optional] +**latest** | [**VersionMetaLatest**](VersionMetaLatest.md) | | [optional] + +## Example + +```python +from cachethq_client.models.version_meta import VersionMeta + +# TODO update the JSON string below +json = "{}" +# create an instance of VersionMeta from a JSON string +version_meta_instance = VersionMeta.from_json(json) +# print the JSON string representation of the object +print VersionMeta.to_json() + +# convert the object into a dict +version_meta_dict = version_meta_instance.to_dict() +# create an instance of VersionMeta from a dict +version_meta_form_dict = version_meta.from_dict(version_meta_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/api-doc/docs/VersionMetaLatest.md b/api-doc/docs/VersionMetaLatest.md new file mode 100644 index 0000000..26cda27 --- /dev/null +++ b/api-doc/docs/VersionMetaLatest.md @@ -0,0 +1,30 @@ +# VersionMetaLatest + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**tag_name** | **str** | | [optional] +**prelease** | **bool** | | [optional] +**draft** | **bool** | | [optional] + +## Example + +```python +from cachethq_client.models.version_meta_latest import VersionMetaLatest + +# TODO update the JSON string below +json = "{}" +# create an instance of VersionMetaLatest from a JSON string +version_meta_latest_instance = VersionMetaLatest.from_json(json) +# print the JSON string representation of the object +print VersionMetaLatest.to_json() + +# convert the object into a dict +version_meta_latest_dict = version_meta_latest_instance.to_dict() +# create an instance of VersionMetaLatest from a dict +version_meta_latest_form_dict = version_meta_latest.from_dict(version_meta_latest_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/pyproject.toml b/pyproject.toml index c22771b..2f6543c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,9 +1,11 @@ [tool.poetry] name = "cachethq_client" -version = "0.1.6" +version = "0.1.7" description = "" authors = ["cbrand "] -readme = "README.md" +readme = "PYPI-README.md" +repository = "https://github.com/ElyxorCorp/cachethq-swagger" +documentation = "https://github.com/ElyxorCorp/cachethq-swagger/tree/master/api-doc/README.md" license = "BSD-3-Clause" include = [ { path = "test", format = "sdist" },