feat: release version 2.0.1 with custom fields API support

qase-api-v2-client/README.md

@@ -106,10 +106,17 @@ All URIs are relative to *<https://api.qase.io/v2>*
 --------------|---------------------------------------------------------------|-----------------------------------------------|------------------------------------
  *ResultsApi* | [**create_result_v2**](docs/ResultsApi.md#create_result_v2)   | **POST** /{project_code}/run/{run_id}/result  | (Beta) Create test run result
  *ResultsApi* | [**create_results_v2**](docs/ResultsApi.md#create_results_v2) | **POST** /{project_code}/run/{run_id}/results | (Beta) Bulk create test run result
+ *CustomFieldsApi* | [**get_custom_field_v2**](docs/CustomFieldsApi.md#get_custom_field_v2) | **GET** /custom-fields/{id} | Get custom field
+ *CustomFieldsApi* | [**get_custom_fields_v2**](docs/CustomFieldsApi.md#get_custom_fields_v2) | **GET** /custom-fields | Get custom fields
 
 ## Documentation For Models
 
 - [CreateResultsRequestV2](docs/CreateResultsRequestV2.md)
+- [CustomField](docs/CustomField.md)
+- [CustomFieldListResponse](docs/CustomFieldListResponse.md)
+- [CustomFieldListResponseAllOfResult](docs/CustomFieldListResponseAllOfResult.md)
+- [CustomFieldOption](docs/CustomFieldOption.md)
+- [CustomFieldResponse](docs/CustomFieldResponse.md)
 - [RelationSuite](docs/RelationSuite.md)
 - [RelationSuiteItem](docs/RelationSuiteItem.md)
 - [ResultCreate](docs/ResultCreate.md)

qase-api-v2-client/docs/CustomField.md

@@ -0,0 +1,42 @@
+# CustomField
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | [optional] 
+**title** | **str** |  | [optional] 
+**entity** | **str** |  | [optional] 
+**type** | **str** |  | [optional] 
+**placeholder** | **str** |  | [optional] 
+**default_value** | **str** |  | [optional] 
+**value** | [**List[CustomFieldOption]**](CustomFieldOption.md) |  | [optional] 
+**is_required** | **bool** |  | [optional] 
+**is_visible** | **bool** |  | [optional] 
+**is_filterable** | **bool** |  | [optional] 
+**is_enabled_for_all_projects** | **bool** |  | [optional] 
+**created_at** | **datetime** |  | [optional] 
+**updated_at** | **datetime** |  | [optional] 
+**projects_codes** | **List[str]** |  | [optional] 
+
+## Example
+
+```python
+from qase.api_client_v2.models.custom_field import CustomField
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomField from a JSON string
+custom_field_instance = CustomField.from_json(json)
+# print the JSON string representation of the object
+print(CustomField.to_json())
+
+# convert the object into a dict
+custom_field_dict = custom_field_instance.to_dict()
+# create an instance of CustomField from a dict
+custom_field_from_dict = CustomField.from_dict(custom_field_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)
+
+

qase-api-v2-client/docs/CustomFieldListResponse.md

@@ -0,0 +1,30 @@
+# CustomFieldListResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **bool** |  | [optional] 
+**result** | [**CustomFieldListResponseAllOfResult**](CustomFieldListResponseAllOfResult.md) |  | [optional] 
+
+## Example
+
+```python
+from qase.api_client_v2.models.custom_field_list_response import CustomFieldListResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomFieldListResponse from a JSON string
+custom_field_list_response_instance = CustomFieldListResponse.from_json(json)
+# print the JSON string representation of the object
+print(CustomFieldListResponse.to_json())
+
+# convert the object into a dict
+custom_field_list_response_dict = custom_field_list_response_instance.to_dict()
+# create an instance of CustomFieldListResponse from a dict
+custom_field_list_response_from_dict = CustomFieldListResponse.from_dict(custom_field_list_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)
+
+

qase-api-v2-client/docs/CustomFieldListResponseAllOfResult.md

@@ -0,0 +1,32 @@
+# CustomFieldListResponseAllOfResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **int** |  | [optional] 
+**filtered** | **int** |  | [optional] 
+**count** | **int** |  | [optional] 
+**entities** | [**List[CustomField]**](CustomField.md) |  | [optional] 
+
+## Example
+
+```python
+from qase.api_client_v2.models.custom_field_list_response_all_of_result import CustomFieldListResponseAllOfResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomFieldListResponseAllOfResult from a JSON string
+custom_field_list_response_all_of_result_instance = CustomFieldListResponseAllOfResult.from_json(json)
+# print the JSON string representation of the object
+print(CustomFieldListResponseAllOfResult.to_json())
+
+# convert the object into a dict
+custom_field_list_response_all_of_result_dict = custom_field_list_response_all_of_result_instance.to_dict()
+# create an instance of CustomFieldListResponseAllOfResult from a dict
+custom_field_list_response_all_of_result_from_dict = CustomFieldListResponseAllOfResult.from_dict(custom_field_list_response_all_of_result_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)
+
+

qase-api-v2-client/docs/CustomFieldOption.md

@@ -0,0 +1,30 @@
+# CustomFieldOption
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | [optional] 
+**title** | **str** |  | [optional] 
+
+## Example
+
+```python
+from qase.api_client_v2.models.custom_field_option import CustomFieldOption
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomFieldOption from a JSON string
+custom_field_option_instance = CustomFieldOption.from_json(json)
+# print the JSON string representation of the object
+print(CustomFieldOption.to_json())
+
+# convert the object into a dict
+custom_field_option_dict = custom_field_option_instance.to_dict()
+# create an instance of CustomFieldOption from a dict
+custom_field_option_from_dict = CustomFieldOption.from_dict(custom_field_option_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)
+
+

qase-api-v2-client/docs/CustomFieldResponse.md

@@ -0,0 +1,30 @@
+# CustomFieldResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **bool** |  | [optional] 
+**result** | [**CustomField**](CustomField.md) |  | [optional] 
+
+## Example
+
+```python
+from qase.api_client_v2.models.custom_field_response import CustomFieldResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomFieldResponse from a JSON string
+custom_field_response_instance = CustomFieldResponse.from_json(json)
+# print the JSON string representation of the object
+print(CustomFieldResponse.to_json())
+
+# convert the object into a dict
+custom_field_response_dict = custom_field_response_instance.to_dict()
+# create an instance of CustomFieldResponse from a dict
+custom_field_response_from_dict = CustomFieldResponse.from_dict(custom_field_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)
+
+

qase-api-v2-client/docs/CustomFieldsApi.md

@@ -0,0 +1,185 @@
+# qase.api_client_v2.CustomFieldsApi
+
+All URIs are relative to *https://api.qase.io/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_custom_field_v2**](CustomFieldsApi.md#get_custom_field_v2) | **GET** /custom_field/{id} | Get Custom Field
+[**get_custom_fields_v2**](CustomFieldsApi.md#get_custom_fields_v2) | **GET** /custom_field | Get all Custom Fields
+
+
+# **get_custom_field_v2**
+> CustomFieldResponse get_custom_field_v2(id)
+
+Get Custom Field
+
+This method allows to retrieve custom field.
+
+
+### Example
+
+* Api Key Authentication (TokenAuth):
+
+```python
+import qase.api_client_v2
+from qase.api_client_v2.models.custom_field_response import CustomFieldResponse
+from qase.api_client_v2.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.qase.io/v2
+# See configuration.py for a list of all supported configuration parameters.
+configuration = qase.api_client_v2.Configuration(
+    host = "https://api.qase.io/v2"
+)
+
+# 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: TokenAuth
+configuration.api_key['TokenAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['TokenAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with qase.api_client_v2.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = qase.api_client_v2.CustomFieldsApi(api_client)
+    id = 56 # int | Identifier.
+
+    try:
+        # Get Custom Field
+        api_response = api_instance.get_custom_field_v2(id)
+        print("The response of CustomFieldsApi->get_custom_field_v2:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CustomFieldsApi->get_custom_field_v2: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **int**| Identifier. | 
+
+### Return type
+
+[**CustomFieldResponse**](CustomFieldResponse.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | A Custom Field. |  -  |
+**400** | Bad Request. |  -  |
+**401** | Unauthorized. |  -  |
+**403** | Forbidden. |  -  |
+**404** | Not Found. |  -  |
+**429** | Too Many Requests. |  -  |
+
+[[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_custom_fields_v2**
+> CustomFieldListResponse get_custom_fields_v2(entity=entity, type=type, limit=limit, offset=offset)
+
+Get all Custom Fields
+
+This method allows to retrieve and filter custom fields.
+
+
+### Example
+
+* Api Key Authentication (TokenAuth):
+
+```python
+import qase.api_client_v2
+from qase.api_client_v2.models.custom_field_list_response import CustomFieldListResponse
+from qase.api_client_v2.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.qase.io/v2
+# See configuration.py for a list of all supported configuration parameters.
+configuration = qase.api_client_v2.Configuration(
+    host = "https://api.qase.io/v2"
+)
+
+# 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: TokenAuth
+configuration.api_key['TokenAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['TokenAuth'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with qase.api_client_v2.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = qase.api_client_v2.CustomFieldsApi(api_client)
+    entity = 'entity_example' # str |  (optional)
+    type = 'type_example' # str |  (optional)
+    limit = 10 # int | A number of entities in result set. (optional) (default to 10)
+    offset = 0 # int | How many entities should be skipped. (optional) (default to 0)
+
+    try:
+        # Get all Custom Fields
+        api_response = api_instance.get_custom_fields_v2(entity=entity, type=type, limit=limit, offset=offset)
+        print("The response of CustomFieldsApi->get_custom_fields_v2:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CustomFieldsApi->get_custom_fields_v2: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity** | **str**|  | [optional] 
+ **type** | **str**|  | [optional] 
+ **limit** | **int**| A number of entities in result set. | [optional] [default to 10]
+ **offset** | **int**| How many entities should be skipped. | [optional] [default to 0]
+
+### Return type
+
+[**CustomFieldListResponse**](CustomFieldListResponse.md)
+
+### Authorization
+
+[TokenAuth](../README.md#TokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Custom Field list. |  -  |
+**400** | Bad Request. |  -  |
+**401** | Unauthorized. |  -  |
+**403** | Forbidden. |  -  |
+**429** | Too Many Requests. |  -  |
+
+[[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)
+

qase-api-v2-client/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qase-api-v2-client"
-version = "2.0.0"
+version = "2.0.1"
 description = "Qase TestOps API V2 client for Python"
 readme = "README.md"
 authors = [{name = "Qase Team", email = "support@qase.io"}]