Skip to content

Commit 4faca57

Browse files
author
Api (Codebuild)
committed
Look for details in API documentation's changelog
1 parent 098f458 commit 4faca57

16 files changed

+775
-9
lines changed

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ docs/ActivesessionGenerateFederationTokenV1Response.md
99
docs/ActivesessionGenerateFederationTokenV1ResponseMPayload.md
1010
docs/ActivesessionGetCurrentV1Response.md
1111
docs/ActivesessionGetCurrentV1ResponseMPayload.md
12+
docs/ActivesessionGetCurrentV2Response.md
13+
docs/ActivesessionGetCurrentV2ResponseMPayload.md
1214
docs/ActivesessionGetListV1Response.md
1315
docs/ActivesessionGetListV1ResponseMPayload.md
1416
docs/ActivesessionListElement.md
@@ -1869,6 +1871,8 @@ eZmaxApi/models/activesession_generate_federation_token_v1_response.py
18691871
eZmaxApi/models/activesession_generate_federation_token_v1_response_m_payload.py
18701872
eZmaxApi/models/activesession_get_current_v1_response.py
18711873
eZmaxApi/models/activesession_get_current_v1_response_m_payload.py
1874+
eZmaxApi/models/activesession_get_current_v2_response.py
1875+
eZmaxApi/models/activesession_get_current_v2_response_m_payload.py
18721876
eZmaxApi/models/activesession_get_list_v1_response.py
18731877
eZmaxApi/models/activesession_get_list_v1_response_m_payload.py
18741878
eZmaxApi/models/activesession_list_element.py
@@ -3513,6 +3517,8 @@ test/test_activesession_generate_federation_token_v1_response.py
35133517
test/test_activesession_generate_federation_token_v1_response_m_payload.py
35143518
test/test_activesession_get_current_v1_response.py
35153519
test/test_activesession_get_current_v1_response_m_payload.py
3520+
test/test_activesession_get_current_v2_response.py
3521+
test/test_activesession_get_current_v2_response_m_payload.py
35163522
test/test_activesession_get_list_v1_response.py
35173523
test/test_activesession_get_list_v1_response_m_payload.py
35183524
test/test_activesession_list_element.py

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
9494
*ModuleUserApi* | [**user_create_ezsignuser_v1**](docs/ModuleUserApi.md#user_create_ezsignuser_v1) | **POST** /1/module/user/createezsignuser | Create a new User of type Ezsignuser
9595
*ObjectActivesessionApi* | [**activesession_generate_federation_token_v1**](docs/ObjectActivesessionApi.md#activesession_generate_federation_token_v1) | **POST** /1/object/activesession/generateFederationToken | Generate a federation token
9696
*ObjectActivesessionApi* | [**activesession_get_current_v1**](docs/ObjectActivesessionApi.md#activesession_get_current_v1) | **GET** /1/object/activesession/getCurrent | Get Current Activesession
97+
*ObjectActivesessionApi* | [**activesession_get_current_v2**](docs/ObjectActivesessionApi.md#activesession_get_current_v2) | **GET** /2/object/activesession/getCurrent | Get Current Activesession
9798
*ObjectActivesessionApi* | [**activesession_get_list_v1**](docs/ObjectActivesessionApi.md#activesession_get_list_v1) | **GET** /1/object/activesession/getList | Retrieve Activesession list
9899
*ObjectApikeyApi* | [**apikey_create_object_v2**](docs/ObjectApikeyApi.md#apikey_create_object_v2) | **POST** /2/object/apikey | Create a new Apikey
99100
*ObjectApikeyApi* | [**apikey_edit_object_v1**](docs/ObjectApikeyApi.md#apikey_edit_object_v1) | **PUT** /1/object/apikey/{pkiApikeyID} | Edit an existing Apikey
@@ -551,6 +552,8 @@ Class | Method | HTTP request | Description
551552
- [ActivesessionGenerateFederationTokenV1ResponseMPayload](docs/ActivesessionGenerateFederationTokenV1ResponseMPayload.md)
552553
- [ActivesessionGetCurrentV1Response](docs/ActivesessionGetCurrentV1Response.md)
553554
- [ActivesessionGetCurrentV1ResponseMPayload](docs/ActivesessionGetCurrentV1ResponseMPayload.md)
555+
- [ActivesessionGetCurrentV2Response](docs/ActivesessionGetCurrentV2Response.md)
556+
- [ActivesessionGetCurrentV2ResponseMPayload](docs/ActivesessionGetCurrentV2ResponseMPayload.md)
554557
- [ActivesessionGetListV1Response](docs/ActivesessionGetListV1Response.md)
555558
- [ActivesessionGetListV1ResponseMPayload](docs/ActivesessionGetListV1ResponseMPayload.md)
556559
- [ActivesessionListElement](docs/ActivesessionListElement.md)

‎docs/ActivesessionGetCurrentV2Response.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# ActivesessionGetCurrentV2Response
2+
3+
Response for GET /2/object/activesession/getCurrent
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** | [**ActivesessionGetCurrentV2ResponseMPayload**](ActivesessionGetCurrentV2ResponseMPayload.md) | |
12+
13+
## Example
14+
15+
```python
16+
from eZmaxApi.models.activesession_get_current_v2_response import ActivesessionGetCurrentV2Response
17+
18+
# TODO update the JSON string below
19+
json = "{}"
20+
# create an instance of ActivesessionGetCurrentV2Response from a JSON string
21+
activesession_get_current_v2_response_instance = ActivesessionGetCurrentV2Response.from_json(json)
22+
# print the JSON string representation of the object
23+
print(ActivesessionGetCurrentV2Response.to_json())
24+
25+
# convert the object into a dict
26+
activesession_get_current_v2_response_dict = activesession_get_current_v2_response_instance.to_dict()
27+
# create an instance of ActivesessionGetCurrentV2Response from a dict
28+
activesession_get_current_v2_response_from_dict = ActivesessionGetCurrentV2Response.from_dict(activesession_get_current_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/ActivesessionGetCurrentV2ResponseMPayload.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# ActivesessionGetCurrentV2ResponseMPayload
2+
3+
Payload for GET /1/object/activesession/getCurrent
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**obj_activesession** | [**ActivesessionResponseCompound**](ActivesessionResponseCompound.md) | |
10+
11+
## Example
12+
13+
```python
14+
from eZmaxApi.models.activesession_get_current_v2_response_m_payload import ActivesessionGetCurrentV2ResponseMPayload
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of ActivesessionGetCurrentV2ResponseMPayload from a JSON string
19+
activesession_get_current_v2_response_m_payload_instance = ActivesessionGetCurrentV2ResponseMPayload.from_json(json)
20+
# print the JSON string representation of the object
21+
print(ActivesessionGetCurrentV2ResponseMPayload.to_json())
22+
23+
# convert the object into a dict
24+
activesession_get_current_v2_response_m_payload_dict = activesession_get_current_v2_response_m_payload_instance.to_dict()
25+
# create an instance of ActivesessionGetCurrentV2ResponseMPayload from a dict
26+
activesession_get_current_v2_response_m_payload_from_dict = ActivesessionGetCurrentV2ResponseMPayload.from_dict(activesession_get_current_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/ObjectActivesessionApi.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**activesession_generate_federation_token_v1**](ObjectActivesessionApi.md#activesession_generate_federation_token_v1) | **POST** /1/object/activesession/generateFederationToken | Generate a federation token
88
[**activesession_get_current_v1**](ObjectActivesessionApi.md#activesession_get_current_v1) | **GET** /1/object/activesession/getCurrent | Get Current Activesession
9+
[**activesession_get_current_v2**](ObjectActivesessionApi.md#activesession_get_current_v2) | **GET** /2/object/activesession/getCurrent | Get Current Activesession
910
[**activesession_get_list_v1**](ObjectActivesessionApi.md#activesession_get_list_v1) | **GET** /1/object/activesession/getList | Retrieve Activesession list
1011

1112

@@ -172,6 +173,88 @@ This endpoint does not need any parameter.
172173

173174
[[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)
174175

176+
# **activesession_get_current_v2**
177+
> ActivesessionGetCurrentV2Response activesession_get_current_v2()
178+
179+
Get Current Activesession
180+
181+
Retrieve the details about the current activesession
182+
183+
### Example
184+
185+
* Api Key Authentication (Authorization):
186+
187+
```python
188+
import eZmaxApi
189+
from eZmaxApi.models.activesession_get_current_v2_response import ActivesessionGetCurrentV2Response
190+
from eZmaxApi.rest import ApiException
191+
from pprint import pprint
192+
193+
# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
194+
# See configuration.py for a list of all supported configuration parameters.
195+
configuration = eZmaxApi.Configuration(
196+
host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
197+
)
198+
199+
# The client must configure the authentication and authorization parameters
200+
# in accordance with the API server security policy.
201+
# Examples for each auth method are provided below, use the example that
202+
# satisfies your auth use case.
203+
204+
# Configure API key authorization: Authorization
205+
configuration.api_key['Authorization'] = os.environ["API_KEY"]
206+
207+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
208+
# configuration.api_key_prefix['Authorization'] = 'Bearer'
209+
210+
# Enter a context with an instance of the API client
211+
with eZmaxApi.ApiClient(configuration) as api_client:
212+
# Create an instance of the API class
213+
api_instance = eZmaxApi.ObjectActivesessionApi(api_client)
214+
215+
try:
216+
# Get Current Activesession
217+
api_response = api_instance.activesession_get_current_v2()
218+
print("The response of ObjectActivesessionApi->activesession_get_current_v2:\n")
219+
pprint(api_response)
220+
except Exception as e:
221+
print("Exception when calling ObjectActivesessionApi->activesession_get_current_v2: %s\n" % e)
222+
```
223+
224+
225+
226+
### Parameters
227+
228+
This endpoint does not need any parameter.
229+
230+
### Return type
231+
232+
[**ActivesessionGetCurrentV2Response**](ActivesessionGetCurrentV2Response.md)
233+
234+
### Authorization
235+
236+
[Authorization](../README.md#Authorization)
237+
238+
### HTTP request headers
239+
240+
- **Content-Type**: Not defined
241+
- **Accept**: application/json
242+
243+
### HTTP response details
244+
245+
| Status code | Description | Response headers |
246+
|-------------|-------------|------------------|
247+
**200** | OK | - |
248+
**350** | The user must authenticate before he can continue with this request | - |
249+
**351** | The user is configured with 2FA and needs to validate its phone number before he can continue with this request | - |
250+
**352** | The user is configured with 2FA and needs to answer a Secretquestion before he can continue with this request | - |
251+
**353** | The user must accept clauses before he can continue with this request | - |
252+
**354** | The user's computer must be validated before he can continue with this request | - |
253+
**355** | The user must change its password before he can continue with this request | - |
254+
**356** | The user is not running the latest version of the native application. He must valide or update its version before he can continue with this request | - |
255+
256+
[[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)
257+
175258
# **activesession_get_list_v1**
176259
> ActivesessionGetListV1Response activesession_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)
177260

‎docs/WebhookGetHistoryV1Response.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
1010
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
11-
**m_payload** | **object** | Payload for GET /1/object/webhook/{pkiWebhookID}/getHistory |
11+
**m_payload** | [**WebhookGetHistoryV1ResponseMPayload**](WebhookGetHistoryV1ResponseMPayload.md) | |
1212

1313
## Example
1414

‎eZmaxApi/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@
145145
from eZmaxApi.models.activesession_generate_federation_token_v1_response_m_payload import ActivesessionGenerateFederationTokenV1ResponseMPayload
146146
from eZmaxApi.models.activesession_get_current_v1_response import ActivesessionGetCurrentV1Response
147147
from eZmaxApi.models.activesession_get_current_v1_response_m_payload import ActivesessionGetCurrentV1ResponseMPayload
148+
from eZmaxApi.models.activesession_get_current_v2_response import ActivesessionGetCurrentV2Response
149+
from eZmaxApi.models.activesession_get_current_v2_response_m_payload import ActivesessionGetCurrentV2ResponseMPayload
148150
from eZmaxApi.models.activesession_get_list_v1_response import ActivesessionGetListV1Response
149151
from eZmaxApi.models.activesession_get_list_v1_response_m_payload import ActivesessionGetListV1ResponseMPayload
150152
from eZmaxApi.models.activesession_list_element import ActivesessionListElement

0 commit comments

Comments
 (0)