Skip to content

Commit 5600980

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

File tree

1,129 files changed

+21108
-4744
lines changed

Some content is hidden

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

1,129 files changed

+21108
-4744
lines changed

‎.openapi-generator/FILES

+111
Large diffs are not rendered by default.

‎.openapi-generator/VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.5.0
1+
6.6.0

‎README.md

+45-1
Large diffs are not rendered by default.

‎api/openapi.yaml

+1,392-119
Large diffs are not rendered by default.

‎docs/ActivesessionGetCurrentV1ResponseMPayload.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Payload for GET /1/object/activesession/getCurrent
99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
1111
|**eActivesessionUsertype** | **FieldEActivesessionUsertype** | | |
12+
|**eActivesessionOrigin** | **FieldEActivesessionOrigin** | | |
1213
|**eActivesessionWeekdaystart** | **FieldEActivesessionWeekdaystart** | | |
1314
|**fkiLanguageID** | **Integer** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| | |
1415
|**sCompanyNameX** | **String** | The Name of the Company in the language of the requester | |

‎docs/ActivesessionResponse.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ An Activesession Object
99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
1111
|**eActivesessionUsertype** | **FieldEActivesessionUsertype** | | |
12+
|**eActivesessionOrigin** | **FieldEActivesessionOrigin** | | |
1213
|**eActivesessionWeekdaystart** | **FieldEActivesessionWeekdaystart** | | |
1314
|**fkiLanguageID** | **Integer** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| | |
1415
|**sCompanyNameX** | **String** | The Name of the Company in the language of the requester | |

‎docs/ActivesessionResponseCompound.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Payload for GET /1/object/activesession/getCurrent
99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
1111
|**eActivesessionUsertype** | **FieldEActivesessionUsertype** | | |
12+
|**eActivesessionOrigin** | **FieldEActivesessionOrigin** | | |
1213
|**eActivesessionWeekdaystart** | **FieldEActivesessionWeekdaystart** | | |
1314
|**fkiLanguageID** | **Integer** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| | |
1415
|**sCompanyNameX** | **String** | The Name of the Company in the language of the requester | |

‎docs/BillingentityinternalAutocompleteElementResponse.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ A Billingentityinternal AutocompleteElement Response
88

99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
11-
|**sBillingentityinternalDescriptionX** | **String** | The description of the Billingentityinternal in the language of the requester | |
1211
|**pkiBillingentityinternalID** | **Integer** | The unique ID of the Billingentityinternal. | |
12+
|**sBillingentityinternalDescriptionX** | **String** | The description of the Billingentityinternal in the language of the requester | |
1313
|**bBillingentityinternalIsactive** | **Boolean** | Whether the Billingentityinternal is active or not | |
1414

1515

‎docs/ClonehistoryGetListV1Response.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# ClonehistoryGetListV1Response
4+
5+
Response for GET /1/object/clonehistory/getList
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**mPayload** | [**ClonehistoryGetListV1ResponseMPayload**](ClonehistoryGetListV1ResponseMPayload.md) | | |
12+
|**objDebugPayload** | [**CommonResponseObjDebugPayloadGetList**](CommonResponseObjDebugPayloadGetList.md) | | [optional] |
13+
|**objDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] |
14+
15+
16+

‎docs/ClonehistoryGetListV1ResponseAllOf.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# ClonehistoryGetListV1ResponseAllOf
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**mPayload** | [**ClonehistoryGetListV1ResponseMPayload**](ClonehistoryGetListV1ResponseMPayload.md) | | |
11+
12+
13+

‎docs/ClonehistoryGetListV1ResponseMPayload.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# ClonehistoryGetListV1ResponseMPayload
4+
5+
Payload for GET /1/object/clonehistory/getList
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**aObjClonehistory** | [**List<ClonehistoryListElement>**](ClonehistoryListElement.md) | | |
12+
|**iRowReturned** | **Integer** | The number of rows returned | |
13+
|**iRowFiltered** | **Integer** | The number of rows matching your filters (if any) or the total number of rows | |
14+
15+
16+

‎docs/ClonehistoryGetListV1ResponseMPayloadAllOf.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# ClonehistoryGetListV1ResponseMPayloadAllOf
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**aObjClonehistory** | [**List<ClonehistoryListElement>**](ClonehistoryListElement.md) | | |
11+
12+
13+

‎docs/ClonehistoryListElement.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
3+
# ClonehistoryListElement
4+
5+
A Clonehistory List Element
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**pkiClonehistoryID** | **Integer** | The unique ID of the Clonehistory | |
12+
|**fkiUserIDCloning** | **Integer** | The unique ID of the User | |
13+
|**fkiUserIDCloned** | **Integer** | The unique ID of the User | |
14+
|**dtClonehistoryFirsthit** | **String** | The firsthit of the Clonehistory | |
15+
|**dtClonehistoryLasthit** | **String** | The lasthit of the Clonehistory | [optional] |
16+
|**sUserLoginnameCloning** | **String** | The Login name of the User. | |
17+
|**sUserFirstnameCloning** | **String** | The First name of the user | |
18+
|**sUserLastnameCloning** | **String** | The Last name of the user | |
19+
|**sUserLoginnameCloned** | **String** | The Login name of the User. | |
20+
|**sUserFirstnameCloned** | **String** | The First name of the user | |
21+
|**sUserLastnameCloned** | **String** | The Last name of the user | |
22+
23+
24+

‎docs/CustomCreditcardtransactionResponse.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
# CustomCreditcardtransactionResponse
4+
5+
A custom Creditcardtransaction Object
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**sCreditcardtypeCodename** | **String** | The codename of the Creditcardtype | |
12+
|**dCreditcardtransactionAmount** | **String** | The amount of the Creditcardtransaction | |
13+
|**sCreditcardtransactionPartiallydecryptednumber** | **String** | The partially decrypted credit card number used in the Creditcardtransaction | |
14+
|**sCreditcardtransactionReferencenumber** | **String** | The reference number on the creditcard service for the Creditcardtransaction | |
15+
16+
17+

‎docs/EzsigndocumentGetCompletedElementsV1Response.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
# EzsigndocumentGetCompletedElementsV1Response
4+
5+
Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**mPayload** | [**EzsigndocumentGetCompletedElementsV1ResponseMPayload**](EzsigndocumentGetCompletedElementsV1ResponseMPayload.md) | | |
12+
|**objDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | [optional] |
13+
|**objDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] |
14+
15+
16+

‎docs/EzsigndocumentGetCompletedElementsV1ResponseAllOf.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# EzsigndocumentGetCompletedElementsV1ResponseAllOf
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**mPayload** | [**EzsigndocumentGetCompletedElementsV1ResponseMPayload**](EzsigndocumentGetCompletedElementsV1ResponseMPayload.md) | | |
11+
12+
13+

‎docs/EzsigndocumentGetCompletedElementsV1ResponseMPayload.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# EzsigndocumentGetCompletedElementsV1ResponseMPayload
4+
5+
Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**aObjEzsignsignature** | [**List<EzsignsignatureResponseCompound>**](EzsignsignatureResponseCompound.md) | | |
12+
|**aObjEzsignformfieldgroup** | [**List<EzsignformfieldgroupResponseCompound>**](EzsignformfieldgroupResponseCompound.md) | | |
13+
14+
15+

‎docs/EzsignsignatureResponse.md

+2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ An Ezsignsignature Object
2424
|**eEzsignsignatureAttachmentnamesource** | **FieldEEzsignsignatureAttachmentnamesource** | | [optional] |
2525
|**bEzsignsignatureRequired** | **Boolean** | Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments. | [optional] |
2626
|**fkiEzsignfoldersignerassociationIDValidation** | **Integer** | The unique ID of the Ezsignfoldersignerassociation | [optional] |
27+
|**dtEzsignsignatureDate** | **String** | The date the Ezsignsignature was signed | [optional] |
28+
|**objContactName** | [**CustomContactNameResponse**](CustomContactNameResponse.md) | | |
2729

2830

2931

‎docs/EzsignsignatureResponseCompound.md

+3
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,11 @@ An Ezsignsignature Object and children to create a complete structure
2424
|**eEzsignsignatureAttachmentnamesource** | **FieldEEzsignsignatureAttachmentnamesource** | | [optional] |
2525
|**bEzsignsignatureRequired** | **Boolean** | Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments. | [optional] |
2626
|**fkiEzsignfoldersignerassociationIDValidation** | **Integer** | The unique ID of the Ezsignfoldersignerassociation | [optional] |
27+
|**dtEzsignsignatureDate** | **String** | The date the Ezsignsignature was signed | [optional] |
28+
|**objContactName** | [**CustomContactNameResponse**](CustomContactNameResponse.md) | | |
2729
|**bEzsignsignatureCustomdate** | **Boolean** | Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**) | [optional] |
2830
|**aObjEzsignsignaturecustomdate** | [**List<EzsignsignaturecustomdateResponseCompound>**](EzsignsignaturecustomdateResponseCompound.md) | An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsignsignatureCustomdate is true. Use an empty array if you don't want to have a date at all. | [optional] |
31+
|**objCreditcardtransaction** | [**CustomCreditcardtransactionResponse**](CustomCreditcardtransactionResponse.md) | | [optional] |
2932

3033

3134

‎docs/EzsignsignatureResponseCompoundAllOf.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
|------------ | ------------- | ------------- | -------------|
1010
|**bEzsignsignatureCustomdate** | **Boolean** | Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**) | [optional] |
1111
|**aObjEzsignsignaturecustomdate** | [**List<EzsignsignaturecustomdateResponseCompound>**](EzsignsignaturecustomdateResponseCompound.md) | An array of custom date blocks that will be filled at the time of signature. Can only be used if bEzsignsignatureCustomdate is true. Use an empty array if you don't want to have a date at all. | [optional] |
12+
|**objCreditcardtransaction** | [**CustomCreditcardtransactionResponse**](CustomCreditcardtransactionResponse.md) | | [optional] |
1213

1314

1415

‎docs/FieldEActivesessionOrigin.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# FieldEActivesessionOrigin
4+
5+
## Enum
6+
7+
8+
* `BUILTIN` (value: `"BuiltIn"`)
9+
10+
* `EXTERNAL` (value: `"External"`)
11+
12+
13+

‎docs/FieldESessionhistoryEndby.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
2+
3+
# FieldESessionhistoryEndby
4+
5+
## Enum
6+
7+
8+
* `DECRYPTION` (value: `"Decryption"`)
9+
10+
* `HACK` (value: `"Hack"`)
11+
12+
* `EXPIRED` (value: `"Expired"`)
13+
14+
* `HIJACK` (value: `"Hijack"`)
15+
16+
* `DOUBLELOGON` (value: `"DoubleLogon"`)
17+
18+
* `GARBAGE` (value: `"Garbage"`)
19+
20+
* `LOGOFF` (value: `"Logoff"`)
21+
22+
* `BADAUTH` (value: `"BadAuth"`)
23+
24+
* `LOCKED` (value: `"Locked"`)
25+
26+
* `INACTIVE` (value: `"Inactive"`)
27+
28+
* `INVALIDUSER` (value: `"InvalidUser"`)
29+
30+
* `BADUSERTYPE` (value: `"BadUserType"`)
31+
32+
* `BADIP` (value: `"BadIP"`)
33+
34+
35+

‎docs/FieldEWebhookEzsignevent.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77

88
* `DOCUMENTCOMPLETED` (value: `"DocumentCompleted"`)
99

10+
* `EZSIGNSIGNERACCEPTCLAUSE` (value: `"EzsignsignerAcceptclause"`)
11+
12+
* `EZSIGNSIGNERCONNECT` (value: `"EzsignsignerConnect"`)
13+
1014
* `FOLDERCOMPLETED` (value: `"FolderCompleted"`)
1115

1216

‎docs/GlobalCustomerApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r
77
| [**globalCustomerGetEndpointV1**](GlobalCustomerApi.md#globalCustomerGetEndpointV1) | **GET** /1/customer/{pksCustomerCode}/endpoint | Get customer endpoint |
88

99

10-
<a name="globalCustomerGetEndpointV1"></a>
10+
<a id="globalCustomerGetEndpointV1"></a>
1111
# **globalCustomerGetEndpointV1**
1212
> GlobalCustomerGetEndpointV1Response globalCustomerGetEndpointV1(pksCustomerCode, sInfrastructureproductCode)
1313

‎docs/GlobalEzmaxclientApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r
77
| [**globalEzmaxclientVersionV1**](GlobalEzmaxclientApi.md#globalEzmaxclientVersionV1) | **GET** /1/ezmaxclient/{pksEzmaxclientOs}/version | Retrieve the latest version of the Ezmaxclient |
88

99

10-
<a name="globalEzmaxclientVersionV1"></a>
10+
<a id="globalEzmaxclientVersionV1"></a>
1111
# **globalEzmaxclientVersionV1**
1212
> GlobalEzmaxclientVersionV1Response globalEzmaxclientVersionV1(pksEzmaxclientOs)
1313

‎docs/GlobalEzmaxcustomerApi.md

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# GlobalEzmaxcustomerApi
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+
| [**globalEzmaxcustomerGetConfigurationV1**](GlobalEzmaxcustomerApi.md#globalEzmaxcustomerGetConfigurationV1) | **GET** /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration | Get ezmaxcustomer configuration |
8+
9+
10+
<a id="globalEzmaxcustomerGetConfigurationV1"></a>
11+
# **globalEzmaxcustomerGetConfigurationV1**
12+
> GlobalEzmaxcustomerGetConfigurationV1Response globalEzmaxcustomerGetConfigurationV1(pksEzmaxcustomerCode)
13+
14+
Get ezmaxcustomer configuration
15+
16+
Retrieve the ezmaxcustomer&#39;s specific configuration. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer&#39;s data is stored.
17+
18+
### Example
19+
```java
20+
// Import classes:
21+
import eZmaxAPI.ApiClient;
22+
import eZmaxAPI.ApiException;
23+
import eZmaxAPI.Configuration;
24+
import eZmaxAPI.auth.*;
25+
import eZmaxAPI.models.*;
26+
import com.ezmax.api.GlobalEzmaxcustomerApi;
27+
28+
public class Example {
29+
public static void main(String[] args) {
30+
ApiClient defaultClient = Configuration.getDefaultApiClient();
31+
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
32+
33+
// Configure API key authorization: Authorization
34+
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
35+
Authorization.setApiKey("YOUR API KEY");
36+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
37+
//Authorization.setApiKeyPrefix("Token");
38+
39+
GlobalEzmaxcustomerApi apiInstance = new GlobalEzmaxcustomerApi(defaultClient);
40+
String pksEzmaxcustomerCode = "pksEzmaxcustomerCode_example"; // String |
41+
try {
42+
GlobalEzmaxcustomerGetConfigurationV1Response result = apiInstance.globalEzmaxcustomerGetConfigurationV1(pksEzmaxcustomerCode);
43+
System.out.println(result);
44+
} catch (ApiException e) {
45+
System.err.println("Exception when calling GlobalEzmaxcustomerApi#globalEzmaxcustomerGetConfigurationV1");
46+
System.err.println("Status code: " + e.getCode());
47+
System.err.println("Reason: " + e.getResponseBody());
48+
System.err.println("Response headers: " + e.getResponseHeaders());
49+
e.printStackTrace();
50+
}
51+
}
52+
}
53+
```
54+
55+
### Parameters
56+
57+
| Name | Type | Description | Notes |
58+
|------------- | ------------- | ------------- | -------------|
59+
| **pksEzmaxcustomerCode** | **String**| | |
60+
61+
### Return type
62+
63+
[**GlobalEzmaxcustomerGetConfigurationV1Response**](GlobalEzmaxcustomerGetConfigurationV1Response.md)
64+
65+
### Authorization
66+
67+
[Authorization](../README.md#Authorization)
68+
69+
### HTTP request headers
70+
71+
- **Content-Type**: Not defined
72+
- **Accept**: application/json
73+
74+
### HTTP response details
75+
| Status code | Description | Response headers |
76+
|-------------|-------------|------------------|
77+
| **200** | Successful response | - |
78+
| **404** | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body | - |
79+

‎docs/GlobalEzmaxcustomerGetConfigurationV1Response.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
3+
# GlobalEzmaxcustomerGetConfigurationV1Response
4+
5+
Response for GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**sInfrastructureregionCode** | **String** | The region code | |
12+
|**sInfrastructureregionCodeWeb** | **String** | The region code | |
13+
|**sInfrastructureenvironmenttypeDescription** | **String** | The environment type Description | |
14+
|**sCognitoClientIDExternal** | **String** | The ID of the client in Cognito | [optional] |
15+
|**sCognitoClientIDEzmaxpublic** | **String** | The ID of the client in Cognito | |
16+
17+
18+

0 commit comments

Comments
 (0)