Skip to content

Commit 9d2de97

Browse files
author
Api (Codebuild)
committed
Look for details in API documentation's changelog
1 parent 2a1300c commit 9d2de97

1,537 files changed

Lines changed: 2695 additions & 1541 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.openapi-generator/FILES

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ docs/ActivesessionGenerateFederationTokenV1Response.md
1111
docs/ActivesessionGenerateFederationTokenV1ResponseMPayload.md
1212
docs/ActivesessionGetCurrentV1Response.md
1313
docs/ActivesessionGetCurrentV1ResponseMPayload.md
14+
docs/ActivesessionGetCurrentV2Response.md
15+
docs/ActivesessionGetCurrentV2ResponseMPayload.md
1416
docs/ActivesessionGetListV1Response.md
1517
docs/ActivesessionGetListV1ResponseMPayload.md
1618
docs/ActivesessionListElement.md
@@ -1874,6 +1876,8 @@ src/main/java/com/ezmax/api/model/ActivesessionGenerateFederationTokenV1Response
18741876
src/main/java/com/ezmax/api/model/ActivesessionGenerateFederationTokenV1ResponseMPayload.java
18751877
src/main/java/com/ezmax/api/model/ActivesessionGetCurrentV1Response.java
18761878
src/main/java/com/ezmax/api/model/ActivesessionGetCurrentV1ResponseMPayload.java
1879+
src/main/java/com/ezmax/api/model/ActivesessionGetCurrentV2Response.java
1880+
src/main/java/com/ezmax/api/model/ActivesessionGetCurrentV2ResponseMPayload.java
18771881
src/main/java/com/ezmax/api/model/ActivesessionGetListV1Response.java
18781882
src/main/java/com/ezmax/api/model/ActivesessionGetListV1ResponseMPayload.java
18791883
src/main/java/com/ezmax/api/model/ActivesessionListElement.java
@@ -3635,6 +3639,8 @@ src/test/java/com/ezmax/api/model/ActivesessionGenerateFederationTokenV1Response
36353639
src/test/java/com/ezmax/api/model/ActivesessionGenerateFederationTokenV1ResponseTest.java
36363640
src/test/java/com/ezmax/api/model/ActivesessionGetCurrentV1ResponseMPayloadTest.java
36373641
src/test/java/com/ezmax/api/model/ActivesessionGetCurrentV1ResponseTest.java
3642+
src/test/java/com/ezmax/api/model/ActivesessionGetCurrentV2ResponseMPayloadTest.java
3643+
src/test/java/com/ezmax/api/model/ActivesessionGetCurrentV2ResponseTest.java
36383644
src/test/java/com/ezmax/api/model/ActivesessionGetListV1ResponseMPayloadTest.java
36393645
src/test/java/com/ezmax/api/model/ActivesessionGetListV1ResponseTest.java
36403646
src/test/java/com/ezmax/api/model/ActivesessionListElementTest.java

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
eZmax API Definition (Full)
44
- API version: 1.2.1
5-
- Build date: 2025-01-15T19:58:52.873320463Z[Etc/UTC]
5+
- Build date: 2025-01-15T21:36:57.992386529Z[Etc/UTC]
66
- Generator version: 7.10.0
77

88
This API expose all the functionnalities for the eZmax and eZsign applications.
@@ -124,6 +124,7 @@ Class | Method | HTTP request | Description
124124
*ModuleUserApi* | [**userCreateEzsignuserV1**](docs/ModuleUserApi.md#userCreateEzsignuserV1) | **POST** /1/module/user/createezsignuser | Create a new User of type Ezsignuser
125125
*ObjectActivesessionApi* | [**activesessionGenerateFederationTokenV1**](docs/ObjectActivesessionApi.md#activesessionGenerateFederationTokenV1) | **POST** /1/object/activesession/generateFederationToken | Generate a federation token
126126
*ObjectActivesessionApi* | [**activesessionGetCurrentV1**](docs/ObjectActivesessionApi.md#activesessionGetCurrentV1) | **GET** /1/object/activesession/getCurrent | Get Current Activesession
127+
*ObjectActivesessionApi* | [**activesessionGetCurrentV2**](docs/ObjectActivesessionApi.md#activesessionGetCurrentV2) | **GET** /2/object/activesession/getCurrent | Get Current Activesession
127128
*ObjectActivesessionApi* | [**activesessionGetListV1**](docs/ObjectActivesessionApi.md#activesessionGetListV1) | **GET** /1/object/activesession/getList | Retrieve Activesession list
128129
*ObjectApikeyApi* | [**apikeyCreateObjectV2**](docs/ObjectApikeyApi.md#apikeyCreateObjectV2) | **POST** /2/object/apikey | Create a new Apikey
129130
*ObjectApikeyApi* | [**apikeyEditObjectV1**](docs/ObjectApikeyApi.md#apikeyEditObjectV1) | **PUT** /1/object/apikey/{pkiApikeyID} | Edit an existing Apikey
@@ -581,6 +582,8 @@ Class | Method | HTTP request | Description
581582
- [ActivesessionGenerateFederationTokenV1ResponseMPayload](docs/ActivesessionGenerateFederationTokenV1ResponseMPayload.md)
582583
- [ActivesessionGetCurrentV1Response](docs/ActivesessionGetCurrentV1Response.md)
583584
- [ActivesessionGetCurrentV1ResponseMPayload](docs/ActivesessionGetCurrentV1ResponseMPayload.md)
585+
- [ActivesessionGetCurrentV2Response](docs/ActivesessionGetCurrentV2Response.md)
586+
- [ActivesessionGetCurrentV2ResponseMPayload](docs/ActivesessionGetCurrentV2ResponseMPayload.md)
584587
- [ActivesessionGetListV1Response](docs/ActivesessionGetListV1Response.md)
585588
- [ActivesessionGetListV1ResponseMPayload](docs/ActivesessionGetListV1ResponseMPayload.md)
586589
- [ActivesessionListElement](docs/ActivesessionListElement.md)

api/openapi.yaml

Lines changed: 273 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1769,9 +1769,61 @@ paths:
17691769
x-content-type: application/json
17701770
x-accepts:
17711771
- application/json
1772+
/2/object/activesession/getCurrent:
1773+
description: ""
1774+
get:
1775+
description: Retrieve the details about the current activesession
1776+
operationId: Activesession_GetCurrent_V2
1777+
responses:
1778+
"200":
1779+
content:
1780+
application/json:
1781+
schema:
1782+
$ref: '#/components/schemas/activesession-getCurrent-v2-Response'
1783+
description: OK
1784+
"350":
1785+
description: The user must authenticate before he can continue with this
1786+
request
1787+
"351":
1788+
description: The user is configured with 2FA and needs to validate its phone
1789+
number before he can continue with this request
1790+
"352":
1791+
content:
1792+
application/json:
1793+
schema:
1794+
$ref: '#/components/schemas/Common-Response-Redirect-sSecretquestionTextX'
1795+
description: The user is configured with 2FA and needs to answer a Secretquestion
1796+
before he can continue with this request
1797+
"353":
1798+
description: The user must accept clauses before he can continue with this
1799+
request
1800+
"354":
1801+
description: The user's computer must be validated before he can continue
1802+
with this request
1803+
"355":
1804+
description: The user must change its password before he can continue with
1805+
this request
1806+
"356":
1807+
description: The user is not running the latest version of the native application.
1808+
He must valide or update its version before he can continue with this
1809+
request
1810+
security:
1811+
- Authorization: []
1812+
summary: Get Current Activesession
1813+
tags:
1814+
- Object_Activesession
1815+
x-permissions:
1816+
- All
1817+
x-usertypeextra:
1818+
- AgentBroker
1819+
- Assistant
1820+
- EzsignSigner
1821+
x-accepts:
1822+
- application/json
17721823
/1/object/activesession/getCurrent:
17731824
description: ""
17741825
get:
1826+
deprecated: true
17751827
description: Retrieve the details about the current activesession
17761828
operationId: Activesession_GetCurrent_V1
17771829
responses:
@@ -35853,6 +35905,64 @@ components:
3585335905
- objUserReal
3585435906
type: object
3585535907
description: Payload for GET /1/object/activesession/getCurrent
35908+
example:
35909+
bActivesessionCanafe: false
35910+
fkiEzsignuserID: 94
35911+
dtUserEzsignprepaidexpiration: 2020-12-31
35912+
bActivesessionRealestatecompleted: false
35913+
eActivesessionRealestateinprogress: Create
35914+
bSystemconfigurationEzsignpaidbyoffice: true
35915+
eActivesessionEzsign: Full
35916+
fkiSignatureID: 12
35917+
objUserCloned:
35918+
sAvatarUrl: http://www.website.com/avatar.jpg
35919+
bUserInterfacedark: false
35920+
iUserInterfacecolor: 3752795
35921+
eUserEzsignsendreminderfrequency: None
35922+
sUserFirstname: John
35923+
pkiUserID: 70
35924+
fkiTimezoneID: 247
35925+
sEmailAddress: email@example.com
35926+
iUserListresult: 25
35927+
sUserLastname: Doe
35928+
eActivesessionWeekdaystart: Sunday
35929+
fkiLanguageID: 2
35930+
pksCustomerCode: demo
35931+
bUserEzsigntrial: false
35932+
bActivesessionAttachment: false
35933+
eActivesessionEzsignprepaid: Basic
35934+
eSystemconfigurationEzsignofficeplan: Standard
35935+
bActivesessionFinancial: false
35936+
objApikey:
35937+
pkiApikeyID: 99
35938+
sApikeyDescriptionX: Project X
35939+
a_eModuleInternalname:
35940+
- Purchases
35941+
- Purchases
35942+
bActivesessionDebug: false
35943+
eActivesessionEzsignaccess: Prepaid
35944+
sDepartmentNameX: Head Office
35945+
sCompanyNameX: Acme inc.
35946+
eActivesessionUsertype: Normal
35947+
objUserReal:
35948+
sAvatarUrl: http://www.website.com/avatar.jpg
35949+
bUserInterfacedark: false
35950+
iUserInterfacecolor: 3752795
35951+
eUserEzsignsendreminderfrequency: None
35952+
sUserFirstname: John
35953+
pkiUserID: 70
35954+
fkiTimezoneID: 247
35955+
sEmailAddress: email@example.com
35956+
iUserListresult: 25
35957+
sUserLastname: Doe
35958+
fkiSystemconfigurationtypeID: 28
35959+
eUserEzsignprepaid: Basic
35960+
eActivesessionOrigin: BuiltIn
35961+
bActivesessionIssuperadmin: false
35962+
a_pkiPermissionID:
35963+
- 53
35964+
- 53
35965+
eUserEzsignaccess: PaidByOffice
3585635966
type: object
3585735967
activesession-ResponseCompound-Apikey:
3585835968
description: An Activesession->Apikey object and children to create a complete
@@ -36164,6 +36274,162 @@ components:
3616436274
- 53
3616536275
eUserEzsignaccess: PaidByOffice
3616636276
type: object
36277+
activesession-getCurrent-v2-Response:
36278+
allOf:
36279+
- properties:
36280+
mPayload:
36281+
$ref: '#/components/schemas/activesession-getCurrent-v2-Response-mPayload'
36282+
required:
36283+
- mPayload
36284+
type: object
36285+
- $ref: '#/components/schemas/Common-Response'
36286+
description: Response for GET /2/object/activesession/getCurrent
36287+
example:
36288+
objDebugPayload:
36289+
dtResponseDate: 2020-12-31 23:59:59
36290+
iVersionMax: 2
36291+
iVersionMin: 1
36292+
bVersionDeprecated: false
36293+
a_RequiredPermission:
36294+
- 117
36295+
- 117
36296+
mPayload:
36297+
objActivesession:
36298+
bActivesessionCanafe: false
36299+
fkiEzsignuserID: 94
36300+
dtUserEzsignprepaidexpiration: 2020-12-31
36301+
bActivesessionRealestatecompleted: false
36302+
eActivesessionRealestateinprogress: Create
36303+
bSystemconfigurationEzsignpaidbyoffice: true
36304+
eActivesessionEzsign: Full
36305+
fkiSignatureID: 12
36306+
objUserCloned:
36307+
sAvatarUrl: http://www.website.com/avatar.jpg
36308+
bUserInterfacedark: false
36309+
iUserInterfacecolor: 3752795
36310+
eUserEzsignsendreminderfrequency: None
36311+
sUserFirstname: John
36312+
pkiUserID: 70
36313+
fkiTimezoneID: 247
36314+
sEmailAddress: email@example.com
36315+
iUserListresult: 25
36316+
sUserLastname: Doe
36317+
eActivesessionWeekdaystart: Sunday
36318+
fkiLanguageID: 2
36319+
pksCustomerCode: demo
36320+
bUserEzsigntrial: false
36321+
bActivesessionAttachment: false
36322+
eActivesessionEzsignprepaid: Basic
36323+
eSystemconfigurationEzsignofficeplan: Standard
36324+
bActivesessionFinancial: false
36325+
objApikey:
36326+
pkiApikeyID: 99
36327+
sApikeyDescriptionX: Project X
36328+
a_eModuleInternalname:
36329+
- Purchases
36330+
- Purchases
36331+
bActivesessionDebug: false
36332+
eActivesessionEzsignaccess: Prepaid
36333+
sDepartmentNameX: Head Office
36334+
sCompanyNameX: Acme inc.
36335+
eActivesessionUsertype: Normal
36336+
objUserReal:
36337+
sAvatarUrl: http://www.website.com/avatar.jpg
36338+
bUserInterfacedark: false
36339+
iUserInterfacecolor: 3752795
36340+
eUserEzsignsendreminderfrequency: None
36341+
sUserFirstname: John
36342+
pkiUserID: 70
36343+
fkiTimezoneID: 247
36344+
sEmailAddress: email@example.com
36345+
iUserListresult: 25
36346+
sUserLastname: Doe
36347+
fkiSystemconfigurationtypeID: 28
36348+
eUserEzsignprepaid: Basic
36349+
eActivesessionOrigin: BuiltIn
36350+
bActivesessionIssuperadmin: false
36351+
a_pkiPermissionID:
36352+
- 53
36353+
- 53
36354+
eUserEzsignaccess: PaidByOffice
36355+
objDebug:
36356+
sMemoryUsage: "11,923MB"
36357+
sRunTime: 0.6084s
36358+
iSQLSelects: 3
36359+
iSQLQueries: 6
36360+
a_objSQLQuery:
36361+
- sQuery: SELECT * FROM table
36362+
fDuration: 1.0E-4
36363+
- sQuery: SELECT * FROM table
36364+
fDuration: 1.0E-4
36365+
type: object
36366+
activesession-getCurrent-v2-Response-mPayload:
36367+
description: Payload for GET /1/object/activesession/getCurrent
36368+
example:
36369+
objActivesession:
36370+
bActivesessionCanafe: false
36371+
fkiEzsignuserID: 94
36372+
dtUserEzsignprepaidexpiration: 2020-12-31
36373+
bActivesessionRealestatecompleted: false
36374+
eActivesessionRealestateinprogress: Create
36375+
bSystemconfigurationEzsignpaidbyoffice: true
36376+
eActivesessionEzsign: Full
36377+
fkiSignatureID: 12
36378+
objUserCloned:
36379+
sAvatarUrl: http://www.website.com/avatar.jpg
36380+
bUserInterfacedark: false
36381+
iUserInterfacecolor: 3752795
36382+
eUserEzsignsendreminderfrequency: None
36383+
sUserFirstname: John
36384+
pkiUserID: 70
36385+
fkiTimezoneID: 247
36386+
sEmailAddress: email@example.com
36387+
iUserListresult: 25
36388+
sUserLastname: Doe
36389+
eActivesessionWeekdaystart: Sunday
36390+
fkiLanguageID: 2
36391+
pksCustomerCode: demo
36392+
bUserEzsigntrial: false
36393+
bActivesessionAttachment: false
36394+
eActivesessionEzsignprepaid: Basic
36395+
eSystemconfigurationEzsignofficeplan: Standard
36396+
bActivesessionFinancial: false
36397+
objApikey:
36398+
pkiApikeyID: 99
36399+
sApikeyDescriptionX: Project X
36400+
a_eModuleInternalname:
36401+
- Purchases
36402+
- Purchases
36403+
bActivesessionDebug: false
36404+
eActivesessionEzsignaccess: Prepaid
36405+
sDepartmentNameX: Head Office
36406+
sCompanyNameX: Acme inc.
36407+
eActivesessionUsertype: Normal
36408+
objUserReal:
36409+
sAvatarUrl: http://www.website.com/avatar.jpg
36410+
bUserInterfacedark: false
36411+
iUserInterfacecolor: 3752795
36412+
eUserEzsignsendreminderfrequency: None
36413+
sUserFirstname: John
36414+
pkiUserID: 70
36415+
fkiTimezoneID: 247
36416+
sEmailAddress: email@example.com
36417+
iUserListresult: 25
36418+
sUserLastname: Doe
36419+
fkiSystemconfigurationtypeID: 28
36420+
eUserEzsignprepaid: Basic
36421+
eActivesessionOrigin: BuiltIn
36422+
bActivesessionIssuperadmin: false
36423+
a_pkiPermissionID:
36424+
- 53
36425+
- 53
36426+
eUserEzsignaccess: PaidByOffice
36427+
properties:
36428+
objActivesession:
36429+
$ref: '#/components/schemas/activesession-ResponseCompound'
36430+
required:
36431+
- objActivesession
36432+
type: object
3616736433
activesession-getList-v1-Response:
3616836434
allOf:
3616936435
- properties:
@@ -119613,22 +119879,20 @@ components:
119613119879
fDuration: 1.0E-4
119614119880
type: object
119615119881
webhook-getHistory-v1-Response-mPayload:
119616-
allOf:
119617-
- properties:
119618-
a_objWebhooklog:
119619-
items:
119620-
$ref: '#/components/schemas/Custom-Webhooklog-Response'
119621-
type: array
119622-
required:
119623-
- a_objWebhooklog
119624-
type: object
119625119882
description: "Payload for GET /1/object/webhook/{pkiWebhookID}/getHistory"
119626119883
example:
119627119884
a_objWebhooklog:
119628119885
- dtWebhooklogDate: 2020-12-31 23:59:59
119629119886
tWebhooklogJson: "{}"
119630119887
- dtWebhooklogDate: 2020-12-31 23:59:59
119631119888
tWebhooklogJson: "{}"
119889+
properties:
119890+
a_objWebhooklog:
119891+
items:
119892+
$ref: '#/components/schemas/Custom-Webhooklog-Response'
119893+
type: array
119894+
required:
119895+
- a_objWebhooklog
119632119896
type: object
119633119897
webhook-getList-v1-Response:
119634119898
allOf:
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# ActivesessionGetCurrentV2Response
4+
5+
Response for GET /2/object/activesession/getCurrent
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**objDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | |
12+
|**objDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] |
13+
|**mPayload** | [**ActivesessionGetCurrentV2ResponseMPayload**](ActivesessionGetCurrentV2ResponseMPayload.md) | | |
14+
15+
16+

0 commit comments

Comments
 (0)