Skip to content

Commit db00918

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

13 files changed

+860
-0
lines changed

‎.openapi-generator/FILES‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,9 @@ docs/CreditcardmerchantResponseCompound.md
265265
docs/CreditcardtypeAutocompleteElementResponse.md
266266
docs/CreditcardtypeGetAutocompleteV2Response.md
267267
docs/CreditcardtypeGetAutocompleteV2ResponseMPayload.md
268+
docs/CurrencyAutocompleteElementResponse.md
269+
docs/CurrencyGetAutocompleteV2Response.md
270+
docs/CurrencyGetAutocompleteV2ResponseMPayload.md
268271
docs/CustomApikey.md
269272
docs/CustomApikeyfederation.md
270273
docs/CustomAttachmentResponse.md
@@ -1319,6 +1322,7 @@ docs/ObjectCountryApi.md
13191322
docs/ObjectCreditcardclientApi.md
13201323
docs/ObjectCreditcardmerchantApi.md
13211324
docs/ObjectCreditcardtypeApi.md
1325+
docs/ObjectCurrencyApi.md
13221326
docs/ObjectCustomerApi.md
13231327
docs/ObjectDepartmentApi.md
13241328
docs/ObjectDiscussionApi.md
@@ -1799,6 +1803,7 @@ eZmaxApi/api/object_country_api.py
17991803
eZmaxApi/api/object_creditcardclient_api.py
18001804
eZmaxApi/api/object_creditcardmerchant_api.py
18011805
eZmaxApi/api/object_creditcardtype_api.py
1806+
eZmaxApi/api/object_currency_api.py
18021807
eZmaxApi/api/object_customer_api.py
18031808
eZmaxApi/api/object_department_api.py
18041809
eZmaxApi/api/object_discussion_api.py
@@ -2153,6 +2158,9 @@ eZmaxApi/models/creditcardmerchant_response_compound.py
21532158
eZmaxApi/models/creditcardtype_autocomplete_element_response.py
21542159
eZmaxApi/models/creditcardtype_get_autocomplete_v2_response.py
21552160
eZmaxApi/models/creditcardtype_get_autocomplete_v2_response_m_payload.py
2161+
eZmaxApi/models/currency_autocomplete_element_response.py
2162+
eZmaxApi/models/currency_get_autocomplete_v2_response.py
2163+
eZmaxApi/models/currency_get_autocomplete_v2_response_m_payload.py
21562164
eZmaxApi/models/custom_apikey.py
21572165
eZmaxApi/models/custom_apikeyfederation.py
21582166
eZmaxApi/models/custom_attachment_response.py

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ Class | Method | HTTP request | Description
156156
*ObjectCreditcardmerchantApi* | [**creditcardmerchant_get_list_v1**](docs/ObjectCreditcardmerchantApi.md#creditcardmerchant_get_list_v1) | **GET** /1/object/creditcardmerchant/getList | Retrieve Creditcardmerchant list
157157
*ObjectCreditcardmerchantApi* | [**creditcardmerchant_get_object_v2**](docs/ObjectCreditcardmerchantApi.md#creditcardmerchant_get_object_v2) | **GET** /2/object/creditcardmerchant/{pkiCreditcardmerchantID} | Retrieve an existing Creditcardmerchant
158158
*ObjectCreditcardtypeApi* | [**creditcardtype_get_autocomplete_v2**](docs/ObjectCreditcardtypeApi.md#creditcardtype_get_autocomplete_v2) | **GET** /2/object/creditcardtype/getAutocomplete/{sSelector} | Retrieve Creditcardtypes and IDs
159+
*ObjectCurrencyApi* | [**currency_get_autocomplete_v2**](docs/ObjectCurrencyApi.md#currency_get_autocomplete_v2) | **GET** /2/object/currency/getAutocomplete/{sSelector} | Retrieve Currencies and IDs
159160
*ObjectCustomerApi* | [**customer_create_object_v1**](docs/ObjectCustomerApi.md#customer_create_object_v1) | **POST** /1/object/customer | Create a new Customer
160161
*ObjectCustomerApi* | [**customer_get_object_v2**](docs/ObjectCustomerApi.md#customer_get_object_v2) | **GET** /2/object/customer/{pkiCustomerID} | Retrieve an existing Customer
161162
*ObjectDepartmentApi* | [**department_get_autocomplete_v2**](docs/ObjectDepartmentApi.md#department_get_autocomplete_v2) | **GET** /2/object/department/getAutocomplete/{sSelector} | Retrieve Departments and IDs
@@ -816,6 +817,9 @@ Class | Method | HTTP request | Description
816817
- [CreditcardtypeAutocompleteElementResponse](docs/CreditcardtypeAutocompleteElementResponse.md)
817818
- [CreditcardtypeGetAutocompleteV2Response](docs/CreditcardtypeGetAutocompleteV2Response.md)
818819
- [CreditcardtypeGetAutocompleteV2ResponseMPayload](docs/CreditcardtypeGetAutocompleteV2ResponseMPayload.md)
820+
- [CurrencyAutocompleteElementResponse](docs/CurrencyAutocompleteElementResponse.md)
821+
- [CurrencyGetAutocompleteV2Response](docs/CurrencyGetAutocompleteV2Response.md)
822+
- [CurrencyGetAutocompleteV2ResponseMPayload](docs/CurrencyGetAutocompleteV2ResponseMPayload.md)
819823
- [CustomApikey](docs/CustomApikey.md)
820824
- [CustomApikeyfederation](docs/CustomApikeyfederation.md)
821825
- [CustomAttachmentResponse](docs/CustomAttachmentResponse.md)

‎docs/CurrencyAutocompleteElementResponse.md‎

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

‎docs/CurrencyGetAutocompleteV2Response.md‎

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

‎docs/CurrencyGetAutocompleteV2ResponseMPayload.md‎

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

‎docs/ObjectCurrencyApi.md‎

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

‎eZmaxApi/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
from eZmaxApi.api.object_creditcardclient_api import ObjectCreditcardclientApi
4242
from eZmaxApi.api.object_creditcardmerchant_api import ObjectCreditcardmerchantApi
4343
from eZmaxApi.api.object_creditcardtype_api import ObjectCreditcardtypeApi
44+
from eZmaxApi.api.object_currency_api import ObjectCurrencyApi
4445
from eZmaxApi.api.object_customer_api import ObjectCustomerApi
4546
from eZmaxApi.api.object_department_api import ObjectDepartmentApi
4647
from eZmaxApi.api.object_discussion_api import ObjectDiscussionApi
@@ -403,6 +404,9 @@
403404
from eZmaxApi.models.creditcardtype_autocomplete_element_response import CreditcardtypeAutocompleteElementResponse
404405
from eZmaxApi.models.creditcardtype_get_autocomplete_v2_response import CreditcardtypeGetAutocompleteV2Response
405406
from eZmaxApi.models.creditcardtype_get_autocomplete_v2_response_m_payload import CreditcardtypeGetAutocompleteV2ResponseMPayload
407+
from eZmaxApi.models.currency_autocomplete_element_response import CurrencyAutocompleteElementResponse
408+
from eZmaxApi.models.currency_get_autocomplete_v2_response import CurrencyGetAutocompleteV2Response
409+
from eZmaxApi.models.currency_get_autocomplete_v2_response_m_payload import CurrencyGetAutocompleteV2ResponseMPayload
406410
from eZmaxApi.models.custom_apikey import CustomApikey
407411
from eZmaxApi.models.custom_apikeyfederation import CustomApikeyfederation
408412
from eZmaxApi.models.custom_attachment_response import CustomAttachmentResponse

‎eZmaxApi/api/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
from eZmaxApi.api.object_creditcardclient_api import ObjectCreditcardclientApi
2525
from eZmaxApi.api.object_creditcardmerchant_api import ObjectCreditcardmerchantApi
2626
from eZmaxApi.api.object_creditcardtype_api import ObjectCreditcardtypeApi
27+
from eZmaxApi.api.object_currency_api import ObjectCurrencyApi
2728
from eZmaxApi.api.object_customer_api import ObjectCustomerApi
2829
from eZmaxApi.api.object_department_api import ObjectDepartmentApi
2930
from eZmaxApi.api.object_discussion_api import ObjectDiscussionApi

0 commit comments

Comments
 (0)