Skip to content

Commit 5dd0afb

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

File tree

183 files changed

+15934
-2406
lines changed

Some content is hidden

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

183 files changed

+15934
-2406
lines changed

.openapi-generator/FILES

+104-12
Large diffs are not rendered by default.

.openapi-generator/VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.11.0
1+
7.12.0

README.md

+61-10
Large diffs are not rendered by default.

api/openapi.yaml

+4,815-1,204
Large diffs are not rendered by default.

docs/CommonReport.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ A Report containing Reportsections
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**AObjReportsection** | [**List<CommonReportsection>**](CommonReportsection.md) | |
9+
**BReportPaginate** | **bool** | Whether we display pagination in the report | [optional]
10+
**SReportTitle** | **string** | The title of this Report | [optional]
911

1012
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1113

docs/CommonReportcell.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**IReportcellColumnspan** | **int** | The number of Reportcolumns the Reportcell spans |
99
**IReportcellRowspan** | **int** | The number of Reportrows the Reportcell spans |
10+
**SReportcellContent** | **string** | The content of this Reportcell |
11+
**IReportcellColumn** | **int** | Position of the column where it is placed |
1012

1113
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1214

docs/CommonReportcolumn.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**ObjReportcellstyleDefault** | [**CommonReportcellstyle**](CommonReportcellstyle.md) | |
99
**IReportcolumnWidth** | **int** | The Reportcolumn width in pixels |
10+
**EReportcolumnType** | **EnumReportdataType** | |
1011

1112
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1213

docs/CommonReportgroup.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**AObjReport** | [**List<CommonReport>**](CommonReport.md) | |
99
**AObjReportcellstyleCustom** | [**List<CommonReportcellstyle>**](CommonReportcellstyle.md) | |
10+
**AObjReportgroupParameter** | [**List<CommonReportgroupParameter>**](CommonReportgroupParameter.md) | |
11+
**SReportgroupFilename** | **string** | The name of the file |
1012

1113
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1214

docs/CommonReportgroupParameter.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# eZmaxApi.Model.CommonReportgroupParameter
2+
A parameter of Reportgroup
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**SReportgroupParameterName** | **string** | The Reportparameter name |
9+
**SReportgroupParameterValue** | **string** | The Reportparameter value | [optional]
10+
**ASReportgroupParameterValue** | **List<string>** | | [optional]
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+

docs/CommonReportrow.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ A row in a Reportsubsectionpart
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**AObjReportcell** | [**List<CommonReportcell>**](CommonReportcell.md) | |
9+
**ObjVariableobject** | **Dictionary<string, Object>** | A Variable object without predefined property names |
910
**IReportrowHeight** | **int** | The reportrow height in pixels |
1011

1112
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/CommonReportsection.md

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
1010
**EReportsectionHorizontalalignment** | **EnumHorizontalalignment** | |
1111
**IReportsectionColumncount** | **int** | The number of Reportcolumns in the Reportsection |
1212
**IReportsectionWidth** | **int** | The combined width of all the Reportcolumns in the Reportsection |
13+
**SReportsectionTitle** | **string** | The title of this Reportsection | [optional]
1314

1415
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1516

docs/CommonReportsubsection.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**ObjReportsubsectionpartHeader** | [**CommonReportsubsectionpart**](CommonReportsubsectionpart.md) | |
99
**ObjReportsubsectionpartBody** | [**CommonReportsubsectionpart**](CommonReportsubsectionpart.md) | |
1010
**ObjReportsubsectionpartFooter** | [**CommonReportsubsectionpart**](CommonReportsubsectionpart.md) | |
11+
**SReportsubsectionTitle** | **string** | The title of this Reportsubsection | [optional]
1112

1213
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1314

docs/CommonReportsubsectionpart.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**EReportsubsectionpartType** | **string** | The type of the Reportsubsectionpart |
99
**AObjReportrow** | [**List<CommonReportrow>**](CommonReportrow.md) | |
10+
**ASVariableobjectProperty** | **List<string>** | |
1011

1112
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1213

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
# eZmaxApi.Model.CreditcardmerchantCreateObjectV1Request
2-
Request for POST /1/object/creditcardmerchant
1+
# eZmaxApi.Model.ComputedEEzsignimportfolderStatus
2+
The Status of Ezsignimportfolder.
33

44
## Properties
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**AObjCreditcardmerchant** | [**List<CreditcardmerchantRequestCompound>**](CreditcardmerchantRequestCompound.md) | |
98

109
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1110

docs/CreditcardmerchantCreateObjectV1ResponseMPayload.md

-11
This file was deleted.

docs/CustomCreditcardRequest.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# eZmaxApi.Model.CustomCreditcardRequest
2+
A Custom Creditcard Object
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**FksCreditcardtokenID** | **string** | The creditcard token identifier |
9+
**SCreditcardCVV** | **string** | The creditcard card CVV |
10+
**ObjCreditcarddetail** | [**CreditcarddetailRequest**](CreditcarddetailRequest.md) | |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# eZmaxApi.Model.CustomEzsignfoldertypeTemplateResponse
2+
A Custom Ezsignfoldertype Object
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**PkiEzsignfoldertypeID** | **int** | The unique ID of the Ezsignfoldertype. |
9+
**BEzsignfoldertypeAllowdownloadproofezsignsigner** | **bool** | Whether we allow the proof to be downloaded by an Ezsignsigner | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# eZmaxApi.Model.CustomEzsignimportdocumentResponse
2+
An Ezsignimportdocument
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**PkiEzsignimportdocumentID** | **int** | The unique ID of the Ezsignimportdocument |
9+
**SEzsignimportdocumentName** | **string** | The name of the Ezsignimportdocument |
10+
**FkiEzsignfolderID** | **int** | The unique ID of the Ezsignfolder | [optional]
11+
**SEzsignfolderDescription** | **string** | The description of the Ezsignfolder | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+

docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**PkiEzsignsignatureID** | **int** | The unique ID of the Ezsignsignature | [optional]
99
**FkiEzsignfoldersignerassociationID** | **int** | The unique ID of the Ezsignfoldersignerassociation |
10+
**FkiPaymentgatewayID** | **int** | The unique ID of the Paymentgateway | [optional]
1011
**IEzsignpagePagenumber** | **int** | The page number in the Ezsigndocument |
1112
**IEzsignsignatureX** | **int** | The X coordinate (Horizontal) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate. |
1213
**IEzsignsignatureY** | **int** | The Y coordinate (Vertical) where to put the Ezsignsignature on the page. Coordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate. |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# eZmaxApi.Model.CustomPrefillEzsignformValueRequest
2+
A Custom PrefillEzsignformValue Object
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**SEzsignformfieldgroupLabel** | **string** | The Label for the Ezsignformfieldgroup |
9+
**SEzsignformfieldLabel** | **string** | The Label for the Ezsignformfield | [optional]
10+
**SEzsignformfieldEnteredvalue** | **string** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional]
11+
**BEzsignformfieldSelected** | **bool** | Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional]
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# eZmaxApi.Model.CustomerAutocompleteElementResponse
2+
A Customer AutocompleteElement Response
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**PkiCustomerID** | **int** | The unique ID of the Customer. |
9+
**SCustomerName** | **string** | The name of the Customer |
10+
**BCustomerIsactive** | **bool** | Whether the customer is active or not |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13+
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# eZmaxApi.Model.CreditcardmerchantCreateObjectV1Response
2-
Response for POST /1/object/creditcardmerchant
1+
# eZmaxApi.Model.CustomerGetAutocompleteV2Response
2+
Response for GET /2/object/customer/getAutocomplete
33

44
## Properties
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**ObjDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
99
**ObjDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
10-
**MPayload** | [**CreditcardmerchantCreateObjectV1ResponseMPayload**](CreditcardmerchantCreateObjectV1ResponseMPayload.md) | |
10+
**MPayload** | [**CustomerGetAutocompleteV2ResponseMPayload**](CustomerGetAutocompleteV2ResponseMPayload.md) | |
1111

1212
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1313

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# eZmaxApi.Model.CustomerGetAutocompleteV2ResponseMPayload
2+
Payload for POST /2/object/customer/getAutocomplete
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**AObjCustomer** | [**List<CustomerAutocompleteElementResponse>**](CustomerAutocompleteElementResponse.md) | An array of Customer autocomplete element response. |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
# eZmaxApi.Model.CreditcardmerchantEditObjectV1Request
2-
Request for PUT /1/object/creditcardmerchant/{pkiCreditcardmerchantID}
1+
# eZmaxApi.Model.EnumReportdataType
2+
Type of data in column
33

44
## Properties
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**ObjCreditcardmerchant** | [**CreditcardmerchantRequestCompound**](CreditcardmerchantRequestCompound.md) | |
98

109
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1110

docs/EzmaxcasePatchObjectV1Request.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# eZmaxApi.Model.EzmaxcasePatchObjectV1Request
2+
Request for PATCH /1/object/ezmaxcase/{pkiEzmaxcaseID}
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**ObjEzmaxcase** | [**EzmaxcaseRequestPatch**](EzmaxcaseRequestPatch.md) | |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+

docs/CreditcardmerchantEditObjectV1Response.md docs/EzmaxcasePatchObjectV1Response.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# eZmaxApi.Model.CreditcardmerchantEditObjectV1Response
2-
Response for PUT /1/object/creditcardmerchant/{pkiCreditcardmerchantID}
1+
# eZmaxApi.Model.EzmaxcasePatchObjectV1Response
2+
Response for PATCH /1/object/creditcardclient/{pkiCreditcardclientID}
33

44
## Properties
55

docs/EzmaxcaseRequestPatch.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# eZmaxApi.Model.EzmaxcaseRequestPatch
2+
An Ezmaxcase Object
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**FkiEzmaxcasequeueID** | **int** | The unique ID of the Ezmaxcasequeue | [optional]
9+
**FkiEzmaxcasepriorityID** | **int** | The unique ID of the Ezmaxcasepriority | [optional]
10+
**FkiEzmaxcasestateID** | **int** | The unique ID of the Ezmaxcasestate | [optional]
11+
**FkiEzmaxfeaturerequestID** | **int** | The unique ID of the Ezmaxfeaturerequest | [optional]
12+
**FkiEzmaxknownissueID** | **int** | The unique ID of the Ezmaxknownissue | [optional]
13+
**FkiUserIDOwner** | **int** | The unique ID of the User | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# eZmaxApi.Model.EzsigndocumentPrefillEzsignformV1Request
2+
Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/prefillEzsignform
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**AObjPrefillezsignformvalue** | [**List<CustomPrefillEzsignformValueRequest>**](CustomPrefillEzsignformValueRequest.md) | |
9+
10+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
11+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# eZmaxApi.Model.EzsigndocumentPrefillEzsignformV1Response
2+
Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/prefillEzsignform
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**ObjDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
9+
**ObjDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+

docs/EzsigndocumentRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**FkiEzsignfolderID** | **int** | The unique ID of the Ezsignfolder |
1010
**FkiEzsigntemplateID** | **int** | The unique ID of the Ezsigntemplate | [optional]
1111
**FkiEzsignfoldersignerassociationID** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional]
12+
**FkiEzsignimportdocumentID** | **int** | The unique ID of the Ezsignimportdocument | [optional]
1213
**FkiLanguageID** | **int** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| |
1314
**EEzsigndocumentSource** | **string** | Indicates where to look for the document binary content. |
1415
**EEzsigndocumentFormat** | **string** | Indicates the format of the document. | [optional]

docs/EzsigndocumentRequestCompound.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**FkiEzsignfolderID** | **int** | The unique ID of the Ezsignfolder |
1010
**FkiEzsigntemplateID** | **int** | The unique ID of the Ezsigntemplate | [optional]
1111
**FkiEzsignfoldersignerassociationID** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional]
12+
**FkiEzsignimportdocumentID** | **int** | The unique ID of the Ezsignimportdocument | [optional]
1213
**FkiLanguageID** | **int** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| |
1314
**EEzsigndocumentSource** | **string** | Indicates where to look for the document binary content. |
1415
**EEzsigndocumentFormat** | **string** | Indicates the format of the document. | [optional]

docs/EzsignfolderListElement.md

+3
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ Name | Type | Description | Notes
2525
**DEzsignfolderCompletedpercentage** | **string** | Percentage of Ezsignform/Ezsignsignatures has completed |
2626
**DEzsignfolderFormcompletedpercentage** | **string** | Percentage of Ezsignform has completed |
2727
**DEzsignfolderSignaturecompletedpercentage** | **string** | Percentage of Ezsignsignatures has signed |
28+
**DtEzsignfolderClose** | **string** | The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely. | [optional]
29+
**DtEzsignfolderArchive** | **string** | The date and time at which the Ezsignfolder was archived. | [optional]
30+
**DtEzsignfolderDispose** | **string** | The date and time at which the Ezsignfolder was disposed. | [optional]
2831
**BEzsignfolderSigner** | **bool** | Whether the Ezsignfolder has an Ezsignsignatures that need to be signed or an Ezsignformfieldgroups that need to be filled by the current user | [optional]
2932

3033
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

docs/EzsignfolderResponseCompoundV3.md

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ Name | Type | Description | Notes
2828
**DtEzsignfolderScheduleddispose** | **string** | The scheduled date at which the Ezsignfolder should be Disposed. | [optional]
2929
**EEzsignfolderStep** | **FieldEEzsignfolderStep** | | [optional]
3030
**DtEzsignfolderClose** | **string** | The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely. | [optional]
31+
**DtEzsignfolderArchive** | **string** | The date and time at which the Ezsignfolder was archived. | [optional]
32+
**DtEzsignfolderDispose** | **string** | The date and time at which the Ezsignfolder was disposed. | [optional]
3133
**TEzsignfolderMessage** | **string** | A custom text message that will be added to the email sent. | [optional]
3234
**ObjAudit** | [**CommonAudit**](CommonAudit.md) | | [optional]
3335
**SEzsignfolderExternalid** | **string** | This field can be used to store an External ID from the client's system. Anything can be stored in this field, it will never be evaluated by the eZmax system and will be returned AS-IS. To store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format. | [optional]

0 commit comments

Comments
 (0)