Skip to content

Commit

Permalink
Look for details in API documentation's changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Api (Codebuild) committed Jan 15, 2025
1 parent 098f458 commit 4faca57
Show file tree
Hide file tree
Showing 16 changed files with 775 additions and 9 deletions.
6 changes: 6 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ docs/ActivesessionGenerateFederationTokenV1Response.md
docs/ActivesessionGenerateFederationTokenV1ResponseMPayload.md
docs/ActivesessionGetCurrentV1Response.md
docs/ActivesessionGetCurrentV1ResponseMPayload.md
docs/ActivesessionGetCurrentV2Response.md
docs/ActivesessionGetCurrentV2ResponseMPayload.md
docs/ActivesessionGetListV1Response.md
docs/ActivesessionGetListV1ResponseMPayload.md
docs/ActivesessionListElement.md
Expand Down Expand Up @@ -1869,6 +1871,8 @@ eZmaxApi/models/activesession_generate_federation_token_v1_response.py
eZmaxApi/models/activesession_generate_federation_token_v1_response_m_payload.py
eZmaxApi/models/activesession_get_current_v1_response.py
eZmaxApi/models/activesession_get_current_v1_response_m_payload.py
eZmaxApi/models/activesession_get_current_v2_response.py
eZmaxApi/models/activesession_get_current_v2_response_m_payload.py
eZmaxApi/models/activesession_get_list_v1_response.py
eZmaxApi/models/activesession_get_list_v1_response_m_payload.py
eZmaxApi/models/activesession_list_element.py
Expand Down Expand Up @@ -3513,6 +3517,8 @@ test/test_activesession_generate_federation_token_v1_response.py
test/test_activesession_generate_federation_token_v1_response_m_payload.py
test/test_activesession_get_current_v1_response.py
test/test_activesession_get_current_v1_response_m_payload.py
test/test_activesession_get_current_v2_response.py
test/test_activesession_get_current_v2_response_m_payload.py
test/test_activesession_get_list_v1_response.py
test/test_activesession_get_list_v1_response_m_payload.py
test/test_activesession_list_element.py
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
*ModuleUserApi* | [**user_create_ezsignuser_v1**](docs/ModuleUserApi.md#user_create_ezsignuser_v1) | **POST** /1/module/user/createezsignuser | Create a new User of type Ezsignuser
*ObjectActivesessionApi* | [**activesession_generate_federation_token_v1**](docs/ObjectActivesessionApi.md#activesession_generate_federation_token_v1) | **POST** /1/object/activesession/generateFederationToken | Generate a federation token
*ObjectActivesessionApi* | [**activesession_get_current_v1**](docs/ObjectActivesessionApi.md#activesession_get_current_v1) | **GET** /1/object/activesession/getCurrent | Get Current Activesession
*ObjectActivesessionApi* | [**activesession_get_current_v2**](docs/ObjectActivesessionApi.md#activesession_get_current_v2) | **GET** /2/object/activesession/getCurrent | Get Current Activesession
*ObjectActivesessionApi* | [**activesession_get_list_v1**](docs/ObjectActivesessionApi.md#activesession_get_list_v1) | **GET** /1/object/activesession/getList | Retrieve Activesession list
*ObjectApikeyApi* | [**apikey_create_object_v2**](docs/ObjectApikeyApi.md#apikey_create_object_v2) | **POST** /2/object/apikey | Create a new Apikey
*ObjectApikeyApi* | [**apikey_edit_object_v1**](docs/ObjectApikeyApi.md#apikey_edit_object_v1) | **PUT** /1/object/apikey/{pkiApikeyID} | Edit an existing Apikey
Expand Down Expand Up @@ -551,6 +552,8 @@ Class | Method | HTTP request | Description
- [ActivesessionGenerateFederationTokenV1ResponseMPayload](docs/ActivesessionGenerateFederationTokenV1ResponseMPayload.md)
- [ActivesessionGetCurrentV1Response](docs/ActivesessionGetCurrentV1Response.md)
- [ActivesessionGetCurrentV1ResponseMPayload](docs/ActivesessionGetCurrentV1ResponseMPayload.md)
- [ActivesessionGetCurrentV2Response](docs/ActivesessionGetCurrentV2Response.md)
- [ActivesessionGetCurrentV2ResponseMPayload](docs/ActivesessionGetCurrentV2ResponseMPayload.md)
- [ActivesessionGetListV1Response](docs/ActivesessionGetListV1Response.md)
- [ActivesessionGetListV1ResponseMPayload](docs/ActivesessionGetListV1ResponseMPayload.md)
- [ActivesessionListElement](docs/ActivesessionListElement.md)
Expand Down
32 changes: 32 additions & 0 deletions docs/ActivesessionGetCurrentV2Response.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ActivesessionGetCurrentV2Response

Response for GET /2/object/activesession/getCurrent

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
**m_payload** | [**ActivesessionGetCurrentV2ResponseMPayload**](ActivesessionGetCurrentV2ResponseMPayload.md) | |

## Example

```python
from eZmaxApi.models.activesession_get_current_v2_response import ActivesessionGetCurrentV2Response

# TODO update the JSON string below
json = "{}"
# create an instance of ActivesessionGetCurrentV2Response from a JSON string
activesession_get_current_v2_response_instance = ActivesessionGetCurrentV2Response.from_json(json)
# print the JSON string representation of the object
print(ActivesessionGetCurrentV2Response.to_json())

# convert the object into a dict
activesession_get_current_v2_response_dict = activesession_get_current_v2_response_instance.to_dict()
# create an instance of ActivesessionGetCurrentV2Response from a dict
activesession_get_current_v2_response_from_dict = ActivesessionGetCurrentV2Response.from_dict(activesession_get_current_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)


30 changes: 30 additions & 0 deletions docs/ActivesessionGetCurrentV2ResponseMPayload.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# ActivesessionGetCurrentV2ResponseMPayload

Payload for GET /1/object/activesession/getCurrent

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_activesession** | [**ActivesessionResponseCompound**](ActivesessionResponseCompound.md) | |

## Example

```python
from eZmaxApi.models.activesession_get_current_v2_response_m_payload import ActivesessionGetCurrentV2ResponseMPayload

# TODO update the JSON string below
json = "{}"
# create an instance of ActivesessionGetCurrentV2ResponseMPayload from a JSON string
activesession_get_current_v2_response_m_payload_instance = ActivesessionGetCurrentV2ResponseMPayload.from_json(json)
# print the JSON string representation of the object
print(ActivesessionGetCurrentV2ResponseMPayload.to_json())

# convert the object into a dict
activesession_get_current_v2_response_m_payload_dict = activesession_get_current_v2_response_m_payload_instance.to_dict()
# create an instance of ActivesessionGetCurrentV2ResponseMPayload from a dict
activesession_get_current_v2_response_m_payload_from_dict = ActivesessionGetCurrentV2ResponseMPayload.from_dict(activesession_get_current_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)


83 changes: 83 additions & 0 deletions docs/ObjectActivesessionApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**activesession_generate_federation_token_v1**](ObjectActivesessionApi.md#activesession_generate_federation_token_v1) | **POST** /1/object/activesession/generateFederationToken | Generate a federation token
[**activesession_get_current_v1**](ObjectActivesessionApi.md#activesession_get_current_v1) | **GET** /1/object/activesession/getCurrent | Get Current Activesession
[**activesession_get_current_v2**](ObjectActivesessionApi.md#activesession_get_current_v2) | **GET** /2/object/activesession/getCurrent | Get Current Activesession
[**activesession_get_list_v1**](ObjectActivesessionApi.md#activesession_get_list_v1) | **GET** /1/object/activesession/getList | Retrieve Activesession list


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

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

# **activesession_get_current_v2**
> ActivesessionGetCurrentV2Response activesession_get_current_v2()
Get Current Activesession

Retrieve the details about the current activesession

### Example

* Api Key Authentication (Authorization):

```python
import eZmaxApi
from eZmaxApi.models.activesession_get_current_v2_response import ActivesessionGetCurrentV2Response
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.ObjectActivesessionApi(api_client)

try:
# Get Current Activesession
api_response = api_instance.activesession_get_current_v2()
print("The response of ObjectActivesessionApi->activesession_get_current_v2:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ObjectActivesessionApi->activesession_get_current_v2: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ActivesessionGetCurrentV2Response**](ActivesessionGetCurrentV2Response.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** | OK | - |
**350** | The user must authenticate before he can continue with this request | - |
**351** | The user is configured with 2FA and needs to validate its phone number before he can continue with this request | - |
**352** | The user is configured with 2FA and needs to answer a Secretquestion before he can continue with this request | - |
**353** | The user must accept clauses before he can continue with this request | - |
**354** | The user's computer must be validated before he can continue with this request | - |
**355** | The user must change its password before he can continue with this request | - |
**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 | - |

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

# **activesession_get_list_v1**
> 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)
Expand Down
2 changes: 1 addition & 1 deletion docs/WebhookGetHistoryV1Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
**m_payload** | **object** | Payload for GET /1/object/webhook/{pkiWebhookID}/getHistory |
**m_payload** | [**WebhookGetHistoryV1ResponseMPayload**](WebhookGetHistoryV1ResponseMPayload.md) | |

## Example

Expand Down
2 changes: 2 additions & 0 deletions eZmaxApi/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@
from eZmaxApi.models.activesession_generate_federation_token_v1_response_m_payload import ActivesessionGenerateFederationTokenV1ResponseMPayload
from eZmaxApi.models.activesession_get_current_v1_response import ActivesessionGetCurrentV1Response
from eZmaxApi.models.activesession_get_current_v1_response_m_payload import ActivesessionGetCurrentV1ResponseMPayload
from eZmaxApi.models.activesession_get_current_v2_response import ActivesessionGetCurrentV2Response
from eZmaxApi.models.activesession_get_current_v2_response_m_payload import ActivesessionGetCurrentV2ResponseMPayload
from eZmaxApi.models.activesession_get_list_v1_response import ActivesessionGetListV1Response
from eZmaxApi.models.activesession_get_list_v1_response_m_payload import ActivesessionGetListV1ResponseMPayload
from eZmaxApi.models.activesession_list_element import ActivesessionListElement
Expand Down
Loading

0 comments on commit 4faca57

Please sign in to comment.