Skip to content

Commit 28d5777

Browse files
author
Api (Codebuild)
committed
Look for details in API documentation's changelog
1 parent eec0d01 commit 28d5777

17 files changed

Lines changed: 907 additions & 0 deletions

‎.openapi-generator/FILES‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -789,6 +789,9 @@ docs/GlobalEzmaxclientVersionV1Response.md
789789
docs/GlobalEzmaxcustomerApi.md
790790
docs/GlobalEzmaxcustomerGetConfigurationV1Response.md
791791
docs/HeaderAcceptLanguage.md
792+
docs/LanguageAutocompleteElementResponse.md
793+
docs/LanguageGetAutocompleteV2Response.md
794+
docs/LanguageGetAutocompleteV2ResponseMPayload.md
792795
docs/ModuleEzsignApi.md
793796
docs/ModuleReportApi.md
794797
docs/ModuleResponse.md
@@ -859,6 +862,7 @@ docs/ObjectFontApi.md
859862
docs/ObjectFranchisebrokerApi.md
860863
docs/ObjectFranchiseofficeApi.md
861864
docs/ObjectFranchisereferalincomeApi.md
865+
docs/ObjectLanguageApi.md
862866
docs/ObjectModulegroupApi.md
863867
docs/ObjectNotificationsectionApi.md
864868
docs/ObjectNotificationtestApi.md
@@ -1186,6 +1190,7 @@ eZmaxApi/api/object_font_api.py
11861190
eZmaxApi/api/object_franchisebroker_api.py
11871191
eZmaxApi/api/object_franchiseoffice_api.py
11881192
eZmaxApi/api/object_franchisereferalincome_api.py
1193+
eZmaxApi/api/object_language_api.py
11891194
eZmaxApi/api/object_modulegroup_api.py
11901195
eZmaxApi/api/object_notificationsection_api.py
11911196
eZmaxApi/api/object_notificationtest_api.py
@@ -1998,6 +2003,9 @@ eZmaxApi/models/global_customer_get_endpoint_v1_response.py
19982003
eZmaxApi/models/global_ezmaxclient_version_v1_response.py
19992004
eZmaxApi/models/global_ezmaxcustomer_get_configuration_v1_response.py
20002005
eZmaxApi/models/header_accept_language.py
2006+
eZmaxApi/models/language_autocomplete_element_response.py
2007+
eZmaxApi/models/language_get_autocomplete_v2_response.py
2008+
eZmaxApi/models/language_get_autocomplete_v2_response_m_payload.py
20012009
eZmaxApi/models/module_response.py
20022010
eZmaxApi/models/module_response_compound.py
20032011
eZmaxApi/models/modulegroup_get_all_v1_response.py
@@ -3073,6 +3081,9 @@ test/test_global_ezmaxclient_version_v1_response.py
30733081
test/test_global_ezmaxcustomer_api.py
30743082
test/test_global_ezmaxcustomer_get_configuration_v1_response.py
30753083
test/test_header_accept_language.py
3084+
test/test_language_autocomplete_element_response.py
3085+
test/test_language_get_autocomplete_v2_response.py
3086+
test/test_language_get_autocomplete_v2_response_m_payload.py
30763087
test/test_module_ezsign_api.py
30773088
test/test_module_report_api.py
30783089
test/test_module_response.py
@@ -3143,6 +3154,7 @@ test/test_object_font_api.py
31433154
test/test_object_franchisebroker_api.py
31443155
test/test_object_franchiseoffice_api.py
31453156
test/test_object_franchisereferalincome_api.py
3157+
test/test_object_language_api.py
31463158
test/test_object_modulegroup_api.py
31473159
test/test_object_notificationsection_api.py
31483160
test/test_object_notificationtest_api.py

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,7 @@ Class | Method | HTTP request | Description
294294
*ObjectFranchiseofficeApi* | [**franchiseoffice_get_autocomplete_v2**](docs/ObjectFranchiseofficeApi.md#franchiseoffice_get_autocomplete_v2) | **GET** /2/object/franchiseoffice/getAutocomplete/{sSelector} | Retrieve Franchiseoffices and IDs
295295
*ObjectFranchisereferalincomeApi* | [**franchisereferalincome_create_object_v1**](docs/ObjectFranchisereferalincomeApi.md#franchisereferalincome_create_object_v1) | **POST** /1/object/franchisereferalincome | Create a new Franchisereferalincome
296296
*ObjectFranchisereferalincomeApi* | [**franchisereferalincome_create_object_v2**](docs/ObjectFranchisereferalincomeApi.md#franchisereferalincome_create_object_v2) | **POST** /2/object/franchisereferalincome | Create a new Franchisereferalincome
297+
*ObjectLanguageApi* | [**language_get_autocomplete_v2**](docs/ObjectLanguageApi.md#language_get_autocomplete_v2) | **GET** /2/object/language/getAutocomplete/{sSelector} | Retrieve Languages and IDs
297298
*ObjectModulegroupApi* | [**modulegroup_get_all_v1**](docs/ObjectModulegroupApi.md#modulegroup_get_all_v1) | **GET** /1/object/modulegroup/getAll/{eContext} | Retrieve all Modulegroups
298299
*ObjectNotificationsectionApi* | [**notificationsection_get_notificationtests_v1**](docs/ObjectNotificationsectionApi.md#notificationsection_get_notificationtests_v1) | **GET** /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests | Retrieve an existing Notificationsection's Notificationtests
299300
*ObjectNotificationtestApi* | [**notificationtest_get_elements_v1**](docs/ObjectNotificationtestApi.md#notificationtest_get_elements_v1) | **GET** /1/object/notificationtest/{pkiNotificationtestID}/getElements | Retrieve an existing Notificationtest's Elements
@@ -1168,6 +1169,9 @@ Class | Method | HTTP request | Description
11681169
- [GlobalEzmaxclientVersionV1Response](docs/GlobalEzmaxclientVersionV1Response.md)
11691170
- [GlobalEzmaxcustomerGetConfigurationV1Response](docs/GlobalEzmaxcustomerGetConfigurationV1Response.md)
11701171
- [HeaderAcceptLanguage](docs/HeaderAcceptLanguage.md)
1172+
- [LanguageAutocompleteElementResponse](docs/LanguageAutocompleteElementResponse.md)
1173+
- [LanguageGetAutocompleteV2Response](docs/LanguageGetAutocompleteV2Response.md)
1174+
- [LanguageGetAutocompleteV2ResponseMPayload](docs/LanguageGetAutocompleteV2ResponseMPayload.md)
11711175
- [ModuleResponse](docs/ModuleResponse.md)
11721176
- [ModuleResponseCompound](docs/ModuleResponseCompound.md)
11731177
- [ModulegroupGetAllV1Response](docs/ModulegroupGetAllV1Response.md)

‎docs/LanguageAutocompleteElementResponse.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# LanguageAutocompleteElementResponse
2+
3+
A Language AutocompleteElement Response
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**pki_language_id** | **int** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| |
9+
**s_language_name_x** | **str** | The Name of the Language in the language of the requester |
10+
**b_language_isactive** | **bool** | Whether the Language is active or not |
11+
12+
## Example
13+
14+
```python
15+
from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of LanguageAutocompleteElementResponse from a JSON string
20+
language_autocomplete_element_response_instance = LanguageAutocompleteElementResponse.from_json(json)
21+
# print the JSON string representation of the object
22+
print LanguageAutocompleteElementResponse.to_json()
23+
24+
# convert the object into a dict
25+
language_autocomplete_element_response_dict = language_autocomplete_element_response_instance.to_dict()
26+
# create an instance of LanguageAutocompleteElementResponse from a dict
27+
language_autocomplete_element_response_form_dict = language_autocomplete_element_response.from_dict(language_autocomplete_element_response_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎docs/LanguageGetAutocompleteV2Response.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# LanguageGetAutocompleteV2Response
2+
3+
Response for GET /2/object/language/getAutocomplete
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
9+
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
10+
**m_payload** | [**LanguageGetAutocompleteV2ResponseMPayload**](LanguageGetAutocompleteV2ResponseMPayload.md) | |
11+
12+
## Example
13+
14+
```python
15+
from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of LanguageGetAutocompleteV2Response from a JSON string
20+
language_get_autocomplete_v2_response_instance = LanguageGetAutocompleteV2Response.from_json(json)
21+
# print the JSON string representation of the object
22+
print LanguageGetAutocompleteV2Response.to_json()
23+
24+
# convert the object into a dict
25+
language_get_autocomplete_v2_response_dict = language_get_autocomplete_v2_response_instance.to_dict()
26+
# create an instance of LanguageGetAutocompleteV2Response from a dict
27+
language_get_autocomplete_v2_response_form_dict = language_get_autocomplete_v2_response.from_dict(language_get_autocomplete_v2_response_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎docs/LanguageGetAutocompleteV2ResponseMPayload.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# LanguageGetAutocompleteV2ResponseMPayload
2+
3+
Payload for POST /2/object/language/getAutocomplete
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**a_obj_language** | [**List[LanguageAutocompleteElementResponse]**](LanguageAutocompleteElementResponse.md) | An array of Language autocomplete element response. |
9+
10+
## Example
11+
12+
```python
13+
from eZmaxApi.models.language_get_autocomplete_v2_response_m_payload import LanguageGetAutocompleteV2ResponseMPayload
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of LanguageGetAutocompleteV2ResponseMPayload from a JSON string
18+
language_get_autocomplete_v2_response_m_payload_instance = LanguageGetAutocompleteV2ResponseMPayload.from_json(json)
19+
# print the JSON string representation of the object
20+
print LanguageGetAutocompleteV2ResponseMPayload.to_json()
21+
22+
# convert the object into a dict
23+
language_get_autocomplete_v2_response_m_payload_dict = language_get_autocomplete_v2_response_m_payload_instance.to_dict()
24+
# create an instance of LanguageGetAutocompleteV2ResponseMPayload from a dict
25+
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)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

‎docs/ObjectLanguageApi.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# eZmaxApi.ObjectLanguageApi
2+
3+
All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**language_get_autocomplete_v2**](ObjectLanguageApi.md#language_get_autocomplete_v2) | **GET** /2/object/language/getAutocomplete/{sSelector} | Retrieve Languages and IDs
8+
9+
10+
# **language_get_autocomplete_v2**
11+
> LanguageGetAutocompleteV2Response language_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
12+
13+
Retrieve Languages and IDs
14+
15+
Get the list of Language to be used in a dropdown or autocomplete control.
16+
17+
### Example
18+
19+
* Api Key Authentication (Authorization):
20+
```python
21+
import time
22+
import os
23+
import eZmaxApi
24+
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
25+
from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response
26+
from eZmaxApi.rest import ApiException
27+
from pprint import pprint
28+
29+
# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
30+
# See configuration.py for a list of all supported configuration parameters.
31+
configuration = eZmaxApi.Configuration(
32+
host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
33+
)
34+
35+
# The client must configure the authentication and authorization parameters
36+
# in accordance with the API server security policy.
37+
# Examples for each auth method are provided below, use the example that
38+
# satisfies your auth use case.
39+
40+
# Configure API key authorization: Authorization
41+
configuration.api_key['Authorization'] = os.environ["API_KEY"]
42+
43+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
44+
# configuration.api_key_prefix['Authorization'] = 'Bearer'
45+
46+
# Enter a context with an instance of the API client
47+
with eZmaxApi.ApiClient(configuration) as api_client:
48+
# Create an instance of the API class
49+
api_instance = eZmaxApi.ObjectLanguageApi(api_client)
50+
s_selector = 's_selector_example' # str | The type of Languages to return
51+
e_filter_active = 'Active' # str | Specify which results we want to display. (optional) (default to 'Active')
52+
s_query = 's_query_example' # str | Allow to filter the returned results (optional)
53+
accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage | (optional)
54+
55+
try:
56+
# Retrieve Languages and IDs
57+
api_response = api_instance.language_get_autocomplete_v2(s_selector, e_filter_active=e_filter_active, s_query=s_query, accept_language=accept_language)
58+
print("The response of ObjectLanguageApi->language_get_autocomplete_v2:\n")
59+
pprint(api_response)
60+
except Exception as e:
61+
print("Exception when calling ObjectLanguageApi->language_get_autocomplete_v2: %s\n" % e)
62+
```
63+
64+
65+
66+
### Parameters
67+
68+
Name | Type | Description | Notes
69+
------------- | ------------- | ------------- | -------------
70+
**s_selector** | **str**| The type of Languages to return |
71+
**e_filter_active** | **str**| Specify which results we want to display. | [optional] [default to 'Active']
72+
**s_query** | **str**| Allow to filter the returned results | [optional]
73+
**accept_language** | [**HeaderAcceptLanguage**](.md)| | [optional]
74+
75+
### Return type
76+
77+
[**LanguageGetAutocompleteV2Response**](LanguageGetAutocompleteV2Response.md)
78+
79+
### Authorization
80+
81+
[Authorization](../README.md#Authorization)
82+
83+
### HTTP request headers
84+
85+
- **Content-Type**: Not defined
86+
- **Accept**: application/json
87+
88+
### HTTP response details
89+
| Status code | Description | Response headers |
90+
|-------------|-------------|------------------|
91+
**200** | Successful response | - |
92+
93+
[[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)
94+

‎eZmaxApi/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@
6464
from eZmaxApi.api.object_franchisebroker_api import ObjectFranchisebrokerApi
6565
from eZmaxApi.api.object_franchiseoffice_api import ObjectFranchiseofficeApi
6666
from eZmaxApi.api.object_franchisereferalincome_api import ObjectFranchisereferalincomeApi
67+
from eZmaxApi.api.object_language_api import ObjectLanguageApi
6768
from eZmaxApi.api.object_modulegroup_api import ObjectModulegroupApi
6869
from eZmaxApi.api.object_notificationsection_api import ObjectNotificationsectionApi
6970
from eZmaxApi.api.object_notificationtest_api import ObjectNotificationtestApi
@@ -884,6 +885,9 @@
884885
from eZmaxApi.models.global_ezmaxclient_version_v1_response import GlobalEzmaxclientVersionV1Response
885886
from eZmaxApi.models.global_ezmaxcustomer_get_configuration_v1_response import GlobalEzmaxcustomerGetConfigurationV1Response
886887
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
888+
from eZmaxApi.models.language_autocomplete_element_response import LanguageAutocompleteElementResponse
889+
from eZmaxApi.models.language_get_autocomplete_v2_response import LanguageGetAutocompleteV2Response
890+
from eZmaxApi.models.language_get_autocomplete_v2_response_m_payload import LanguageGetAutocompleteV2ResponseMPayload
887891
from eZmaxApi.models.module_response import ModuleResponse
888892
from eZmaxApi.models.module_response_compound import ModuleResponseCompound
889893
from eZmaxApi.models.modulegroup_get_all_v1_response import ModulegroupGetAllV1Response

‎eZmaxApi/api/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
from eZmaxApi.api.object_franchisebroker_api import ObjectFranchisebrokerApi
4848
from eZmaxApi.api.object_franchiseoffice_api import ObjectFranchiseofficeApi
4949
from eZmaxApi.api.object_franchisereferalincome_api import ObjectFranchisereferalincomeApi
50+
from eZmaxApi.api.object_language_api import ObjectLanguageApi
5051
from eZmaxApi.api.object_modulegroup_api import ObjectModulegroupApi
5152
from eZmaxApi.api.object_notificationsection_api import ObjectNotificationsectionApi
5253
from eZmaxApi.api.object_notificationtest_api import ObjectNotificationtestApi

0 commit comments

Comments
 (0)