Look for details in API documentation's changelog

eZmaxinc · Oct 5, 2023 · 28d5777 · 28d5777
1 parent eec0d01
commit 28d5777
Show file tree

Hide file tree

Showing 17 changed files with 907 additions and 0 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -789,6 +789,9 @@ docs/GlobalEzmaxclientVersionV1Response.md
 docs/GlobalEzmaxcustomerApi.md
 docs/GlobalEzmaxcustomerGetConfigurationV1Response.md
 docs/HeaderAcceptLanguage.md
+docs/LanguageAutocompleteElementResponse.md
+docs/LanguageGetAutocompleteV2Response.md
+docs/LanguageGetAutocompleteV2ResponseMPayload.md
 docs/ModuleEzsignApi.md
 docs/ModuleReportApi.md
 docs/ModuleResponse.md
@@ -859,6 +862,7 @@ docs/ObjectFontApi.md
 docs/ObjectFranchisebrokerApi.md
 docs/ObjectFranchiseofficeApi.md
 docs/ObjectFranchisereferalincomeApi.md
+docs/ObjectLanguageApi.md
 docs/ObjectModulegroupApi.md
 docs/ObjectNotificationsectionApi.md
 docs/ObjectNotificationtestApi.md
@@ -1186,6 +1190,7 @@ eZmaxApi/api/object_font_api.py
 eZmaxApi/api/object_franchisebroker_api.py
 eZmaxApi/api/object_franchiseoffice_api.py
 eZmaxApi/api/object_franchisereferalincome_api.py
+eZmaxApi/api/object_language_api.py
 eZmaxApi/api/object_modulegroup_api.py
 eZmaxApi/api/object_notificationsection_api.py
 eZmaxApi/api/object_notificationtest_api.py
@@ -1998,6 +2003,9 @@ eZmaxApi/models/global_customer_get_endpoint_v1_response.py
 eZmaxApi/models/global_ezmaxclient_version_v1_response.py
 eZmaxApi/models/global_ezmaxcustomer_get_configuration_v1_response.py
 eZmaxApi/models/header_accept_language.py
+eZmaxApi/models/language_autocomplete_element_response.py
+eZmaxApi/models/language_get_autocomplete_v2_response.py
+eZmaxApi/models/language_get_autocomplete_v2_response_m_payload.py
 eZmaxApi/models/module_response.py
 eZmaxApi/models/module_response_compound.py
 eZmaxApi/models/modulegroup_get_all_v1_response.py
@@ -3073,6 +3081,9 @@ test/test_global_ezmaxclient_version_v1_response.py
 test/test_global_ezmaxcustomer_api.py
 test/test_global_ezmaxcustomer_get_configuration_v1_response.py
 test/test_header_accept_language.py
+test/test_language_autocomplete_element_response.py
+test/test_language_get_autocomplete_v2_response.py
+test/test_language_get_autocomplete_v2_response_m_payload.py
 test/test_module_ezsign_api.py
 test/test_module_report_api.py
 test/test_module_response.py
@@ -3143,6 +3154,7 @@ test/test_object_font_api.py
 test/test_object_franchisebroker_api.py
 test/test_object_franchiseoffice_api.py
 test/test_object_franchisereferalincome_api.py
+test/test_object_language_api.py
 test/test_object_modulegroup_api.py
 test/test_object_notificationsection_api.py
 test/test_object_notificationtest_api.py

diff --git a/README.md b/README.md
@@ -294,6 +294,7 @@ Class | Method | HTTP request | Description
 *ObjectFranchiseofficeApi* | [**franchiseoffice_get_autocomplete_v2**](docs/ObjectFranchiseofficeApi.md#franchiseoffice_get_autocomplete_v2) | **GET** /2/object/franchiseoffice/getAutocomplete/{sSelector} | Retrieve Franchiseoffices and IDs
 *ObjectFranchisereferalincomeApi* | [**franchisereferalincome_create_object_v1**](docs/ObjectFranchisereferalincomeApi.md#franchisereferalincome_create_object_v1) | **POST** /1/object/franchisereferalincome | Create a new Franchisereferalincome
 *ObjectFranchisereferalincomeApi* | [**franchisereferalincome_create_object_v2**](docs/ObjectFranchisereferalincomeApi.md#franchisereferalincome_create_object_v2) | **POST** /2/object/franchisereferalincome | Create a new Franchisereferalincome
+*ObjectLanguageApi* | [**language_get_autocomplete_v2**](docs/ObjectLanguageApi.md#language_get_autocomplete_v2) | **GET** /2/object/language/getAutocomplete/{sSelector} | Retrieve Languages and IDs
 *ObjectModulegroupApi* | [**modulegroup_get_all_v1**](docs/ObjectModulegroupApi.md#modulegroup_get_all_v1) | **GET** /1/object/modulegroup/getAll/{eContext} | Retrieve all Modulegroups
 *ObjectNotificationsectionApi* | [**notificationsection_get_notificationtests_v1**](docs/ObjectNotificationsectionApi.md#notificationsection_get_notificationtests_v1) | **GET** /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests | Retrieve an existing Notificationsection&#39;s Notificationtests
 *ObjectNotificationtestApi* | [**notificationtest_get_elements_v1**](docs/ObjectNotificationtestApi.md#notificationtest_get_elements_v1) | **GET** /1/object/notificationtest/{pkiNotificationtestID}/getElements | Retrieve an existing Notificationtest&#39;s Elements
@@ -1168,6 +1169,9 @@ Class | Method | HTTP request | Description
  - [GlobalEzmaxclientVersionV1Response](docs/GlobalEzmaxclientVersionV1Response.md)
  - [GlobalEzmaxcustomerGetConfigurationV1Response](docs/GlobalEzmaxcustomerGetConfigurationV1Response.md)
  - [HeaderAcceptLanguage](docs/HeaderAcceptLanguage.md)
+ - [LanguageAutocompleteElementResponse](docs/LanguageAutocompleteElementResponse.md)
+ - [LanguageGetAutocompleteV2Response](docs/LanguageGetAutocompleteV2Response.md)
+ - [LanguageGetAutocompleteV2ResponseMPayload](docs/LanguageGetAutocompleteV2ResponseMPayload.md)
  - [ModuleResponse](docs/ModuleResponse.md)
  - [ModuleResponseCompound](docs/ModuleResponseCompound.md)
  - [ModulegroupGetAllV1Response](docs/ModulegroupGetAllV1Response.md)

diff --git a/docs/LanguageAutocompleteElementResponse.md b/docs/LanguageAutocompleteElementResponse.md
@@ -0,0 +1,31 @@
+# LanguageAutocompleteElementResponse
+
+A Language AutocompleteElement Response
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pki_language_id** | **int** | The unique ID of the Language.  Valid values:  |Value|Description| |-|-| |1|French| |2|English| | 
+**s_language_name_x** | **str** | The Name of the Language in the language of the requester | 
+**b_language_isactive** | **bool** | Whether the Language is active or not | 
+
+## Example
+
+```python
+from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of LanguageAutocompleteElementResponse from a JSON string
+language_autocomplete_element_response_instance = LanguageAutocompleteElementResponse.from_json(json)
+# print the JSON string representation of the object
+print LanguageAutocompleteElementResponse.to_json()
+
+# convert the object into a dict
+language_autocomplete_element_response_dict = language_autocomplete_element_response_instance.to_dict()
+# create an instance of LanguageAutocompleteElementResponse from a dict
+language_autocomplete_element_response_form_dict = language_autocomplete_element_response.from_dict(language_autocomplete_element_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/docs/LanguageGetAutocompleteV2Response.md b/docs/LanguageGetAutocompleteV2Response.md
@@ -0,0 +1,31 @@
+# LanguageGetAutocompleteV2Response
+
+Response for GET /2/object/language/getAutocomplete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) |  | 
+**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) |  | [optional] 
+**m_payload** | [**LanguageGetAutocompleteV2ResponseMPayload**](LanguageGetAutocompleteV2ResponseMPayload.md) |  | 
+
+## Example
+
+```python
+from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of LanguageGetAutocompleteV2Response from a JSON string
+language_get_autocomplete_v2_response_instance = LanguageGetAutocompleteV2Response.from_json(json)
+# print the JSON string representation of the object
+print LanguageGetAutocompleteV2Response.to_json()
+
+# convert the object into a dict
+language_get_autocomplete_v2_response_dict = language_get_autocomplete_v2_response_instance.to_dict()
+# create an instance of LanguageGetAutocompleteV2Response from a dict
+language_get_autocomplete_v2_response_form_dict = language_get_autocomplete_v2_response.from_dict(language_get_autocomplete_v2_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/docs/LanguageGetAutocompleteV2ResponseMPayload.md b/docs/LanguageGetAutocompleteV2ResponseMPayload.md
@@ -0,0 +1,29 @@
+# LanguageGetAutocompleteV2ResponseMPayload
+
+Payload for POST /2/object/language/getAutocomplete
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**a_obj_language** | [**List[LanguageAutocompleteElementResponse]**](LanguageAutocompleteElementResponse.md) | An array of Language autocomplete element response. | 
+
+## Example
+
+```python
+from eZmaxApi.models.language_get_autocomplete_v2_response_m_payload import LanguageGetAutocompleteV2ResponseMPayload
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of LanguageGetAutocompleteV2ResponseMPayload from a JSON string
+language_get_autocomplete_v2_response_m_payload_instance = LanguageGetAutocompleteV2ResponseMPayload.from_json(json)
+# print the JSON string representation of the object
+print LanguageGetAutocompleteV2ResponseMPayload.to_json()
+
+# convert the object into a dict
+language_get_autocomplete_v2_response_m_payload_dict = language_get_autocomplete_v2_response_m_payload_instance.to_dict()
+# create an instance of LanguageGetAutocompleteV2ResponseMPayload from a dict
+language_get_autocomplete_v2_response_m_payload_form_dict = language_get_autocomplete_v2_response_m_payload.from_dict(language_get_autocomplete_v2_response_m_payload_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/docs/ObjectLanguageApi.md b/docs/ObjectLanguageApi.md
@@ -0,0 +1,94 @@
+# eZmaxApi.ObjectLanguageApi
+
+All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**language_get_autocomplete_v2**](ObjectLanguageApi.md#language_get_autocomplete_v2) | **GET** /2/object/language/getAutocomplete/{sSelector} | Retrieve Languages and IDs
+
+
+# **language_get_autocomplete_v2**
+> LanguageGetAutocompleteV2Response language_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
+
+Retrieve Languages and IDs
+
+Get the list of Language to be used in a dropdown or autocomplete control.
+
+### Example
+
+* Api Key Authentication (Authorization):
+```python
+import time
+import os
+import eZmaxApi
+from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
+from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response
+from eZmaxApi.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
+# See configuration.py for a list of all supported configuration parameters.
+configuration = eZmaxApi.Configuration(
+    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
+)
+
+# 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: Authorization
+configuration.api_key['Authorization'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['Authorization'] = 'Bearer'
+
+# Enter a context with an instance of the API client
+with eZmaxApi.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = eZmaxApi.ObjectLanguageApi(api_client)
+    s_selector = 's_selector_example' # str | The type of Languages to return
+    e_filter_active = 'Active' # str | Specify which results we want to display. (optional) (default to 'Active')
+    s_query = 's_query_example' # str | Allow to filter the returned results (optional)
+    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
+
+    try:
+        # Retrieve Languages and IDs
+        api_response = api_instance.language_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
+        print("The response of ObjectLanguageApi->language_get_autocomplete_v2:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling ObjectLanguageApi->language_get_autocomplete_v2: %s\n" % e)
+```
+
+
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **s_selector** | **str**| The type of Languages to return | 
+ **e_filter_active** | **str**| Specify which results we want to display. | [optional] [default to &#39;Active&#39;]
+ **s_query** | **str**| Allow to filter the returned results | [optional] 
+ **accept_language** | [**HeaderAcceptLanguage**](.md)|  | [optional] 
+
+### Return type
+
+[**LanguageGetAutocompleteV2Response**](LanguageGetAutocompleteV2Response.md)
+
+### Authorization
+
+[Authorization](../README.md#Authorization)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful 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/eZmaxApi/__init__.py b/eZmaxApi/__init__.py
@@ -64,6 +64,7 @@
 from eZmaxApi.api.object_franchisebroker_api import ObjectFranchisebrokerApi
 from eZmaxApi.api.object_franchiseoffice_api import ObjectFranchiseofficeApi
 from eZmaxApi.api.object_franchisereferalincome_api import ObjectFranchisereferalincomeApi
+from eZmaxApi.api.object_language_api import ObjectLanguageApi
 from eZmaxApi.api.object_modulegroup_api import ObjectModulegroupApi
 from eZmaxApi.api.object_notificationsection_api import ObjectNotificationsectionApi
 from eZmaxApi.api.object_notificationtest_api import ObjectNotificationtestApi
@@ -884,6 +885,9 @@
 from eZmaxApi.models.global_ezmaxclient_version_v1_response import GlobalEzmaxclientVersionV1Response
 from eZmaxApi.models.global_ezmaxcustomer_get_configuration_v1_response import GlobalEzmaxcustomerGetConfigurationV1Response
 from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
+from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse
+from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response
+from eZmaxApi.models.language_get_autocomplete_v2_response_m_payload import LanguageGetAutocompleteV2ResponseMPayload
 from eZmaxApi.models.module_response import ModuleResponse
 from eZmaxApi.models.module_response_compound import ModuleResponseCompound
 from eZmaxApi.models.modulegroup_get_all_v1_response import ModulegroupGetAllV1Response

diff --git a/eZmaxApi/api/__init__.py b/eZmaxApi/api/__init__.py
@@ -47,6 +47,7 @@
 from eZmaxApi.api.object_franchisebroker_api import ObjectFranchisebrokerApi
 from eZmaxApi.api.object_franchiseoffice_api import ObjectFranchiseofficeApi
 from eZmaxApi.api.object_franchisereferalincome_api import ObjectFranchisereferalincomeApi
+from eZmaxApi.api.object_language_api import ObjectLanguageApi
 from eZmaxApi.api.object_modulegroup_api import ObjectModulegroupApi
 from eZmaxApi.api.object_notificationsection_api import ObjectNotificationsectionApi
 from eZmaxApi.api.object_notificationtest_api import ObjectNotificationtestApi