Skip to content
This repository was archived by the owner on Apr 14, 2024. It is now read-only.

Commit 88e492d

Browse files
Herrick19Herrick19
committed
=Look for details in API documentation's changelog
1 parent eed7270 commit 88e492d

40 files changed

+1287
-816
lines changed

‎.openapi-generator/FILES‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ docs/EzsigndocumentDeleteObjectV1Response.md
4646
docs/EzsigndocumentGetDownloadUrlV1Response.md
4747
docs/EzsigndocumentGetDownloadUrlV1ResponseAllOf.md
4848
docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md
49+
docs/EzsigndocumentGetEzsignpagesV1Response.md
50+
docs/EzsigndocumentGetEzsignpagesV1ResponseAllOf.md
51+
docs/EzsigndocumentGetEzsignpagesV1ResponseMPayload.md
4952
docs/EzsigndocumentGetObjectV1Response.md
5053
docs/EzsigndocumentGetObjectV1ResponseAllOf.md
5154
docs/EzsigndocumentGetObjectV1ResponseMPayload.md
@@ -56,7 +59,6 @@ docs/EzsigndocumentGetWordsPositionsV1ResponseMPayload.md
5659
docs/EzsigndocumentRequest.md
5760
docs/EzsigndocumentRequestCompound.md
5861
docs/EzsigndocumentResponse.md
59-
docs/EzsigndocumentResponseAllOf.md
6062
docs/EzsigndocumentResponseCompound.md
6163
docs/EzsignfolderCreateObjectV1Request.md
6264
docs/EzsignfolderCreateObjectV1Response.md
@@ -85,6 +87,7 @@ docs/EzsignfoldersignerassociationGetObjectV1ResponseAllOf.md
8587
docs/EzsignfoldersignerassociationRequest.md
8688
docs/EzsignfoldersignerassociationRequestCompound.md
8789
docs/EzsignfoldersignerassociationRequestCompoundAllOf.md
90+
docs/EzsignpageResponse.md
8891
docs/EzsignsignatureCreateObjectV1Request.md
8992
docs/EzsignsignatureCreateObjectV1Response.md
9093
docs/EzsignsignatureCreateObjectV1ResponseAllOf.md
@@ -219,6 +222,9 @@ src/eZmaxAPI/model/EzsigndocumentDeleteObjectV1Response.js
219222
src/eZmaxAPI/model/EzsigndocumentGetDownloadUrlV1Response.js
220223
src/eZmaxAPI/model/EzsigndocumentGetDownloadUrlV1ResponseAllOf.js
221224
src/eZmaxAPI/model/EzsigndocumentGetDownloadUrlV1ResponseMPayload.js
225+
src/eZmaxAPI/model/EzsigndocumentGetEzsignpagesV1Response.js
226+
src/eZmaxAPI/model/EzsigndocumentGetEzsignpagesV1ResponseAllOf.js
227+
src/eZmaxAPI/model/EzsigndocumentGetEzsignpagesV1ResponseMPayload.js
222228
src/eZmaxAPI/model/EzsigndocumentGetObjectV1Response.js
223229
src/eZmaxAPI/model/EzsigndocumentGetObjectV1ResponseAllOf.js
224230
src/eZmaxAPI/model/EzsigndocumentGetObjectV1ResponseMPayload.js
@@ -229,7 +235,6 @@ src/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1ResponseMPayload.js
229235
src/eZmaxAPI/model/EzsigndocumentRequest.js
230236
src/eZmaxAPI/model/EzsigndocumentRequestCompound.js
231237
src/eZmaxAPI/model/EzsigndocumentResponse.js
232-
src/eZmaxAPI/model/EzsigndocumentResponseAllOf.js
233238
src/eZmaxAPI/model/EzsigndocumentResponseCompound.js
234239
src/eZmaxAPI/model/EzsignfolderCreateObjectV1Request.js
235240
src/eZmaxAPI/model/EzsignfolderCreateObjectV1Response.js
@@ -258,6 +263,7 @@ src/eZmaxAPI/model/EzsignfoldersignerassociationGetObjectV1ResponseAllOf.js
258263
src/eZmaxAPI/model/EzsignfoldersignerassociationRequest.js
259264
src/eZmaxAPI/model/EzsignfoldersignerassociationRequestCompound.js
260265
src/eZmaxAPI/model/EzsignfoldersignerassociationRequestCompoundAllOf.js
266+
src/eZmaxAPI/model/EzsignpageResponse.js
261267
src/eZmaxAPI/model/EzsignsignatureCreateObjectV1Request.js
262268
src/eZmaxAPI/model/EzsignsignatureCreateObjectV1Response.js
263269
src/eZmaxAPI/model/EzsignsignatureCreateObjectV1ResponseAllOf.js
@@ -373,6 +379,9 @@ test/eZmaxAPI/model/EzsigndocumentDeleteObjectV1Response.spec.js
373379
test/eZmaxAPI/model/EzsigndocumentGetDownloadUrlV1Response.spec.js
374380
test/eZmaxAPI/model/EzsigndocumentGetDownloadUrlV1ResponseAllOf.spec.js
375381
test/eZmaxAPI/model/EzsigndocumentGetDownloadUrlV1ResponseMPayload.spec.js
382+
test/eZmaxAPI/model/EzsigndocumentGetEzsignpagesV1Response.spec.js
383+
test/eZmaxAPI/model/EzsigndocumentGetEzsignpagesV1ResponseAllOf.spec.js
384+
test/eZmaxAPI/model/EzsigndocumentGetEzsignpagesV1ResponseMPayload.spec.js
376385
test/eZmaxAPI/model/EzsigndocumentGetObjectV1Response.spec.js
377386
test/eZmaxAPI/model/EzsigndocumentGetObjectV1ResponseAllOf.spec.js
378387
test/eZmaxAPI/model/EzsigndocumentGetObjectV1ResponseMPayload.spec.js
@@ -383,7 +392,6 @@ test/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1ResponseMPayload.spec.js
383392
test/eZmaxAPI/model/EzsigndocumentRequest.spec.js
384393
test/eZmaxAPI/model/EzsigndocumentRequestCompound.spec.js
385394
test/eZmaxAPI/model/EzsigndocumentResponse.spec.js
386-
test/eZmaxAPI/model/EzsigndocumentResponseAllOf.spec.js
387395
test/eZmaxAPI/model/EzsigndocumentResponseCompound.spec.js
388396
test/eZmaxAPI/model/EzsignfolderCreateObjectV1Request.spec.js
389397
test/eZmaxAPI/model/EzsignfolderCreateObjectV1Response.spec.js
@@ -412,6 +420,7 @@ test/eZmaxAPI/model/EzsignfoldersignerassociationGetObjectV1ResponseAllOf.spec.j
412420
test/eZmaxAPI/model/EzsignfoldersignerassociationRequest.spec.js
413421
test/eZmaxAPI/model/EzsignfoldersignerassociationRequestCompound.spec.js
414422
test/eZmaxAPI/model/EzsignfoldersignerassociationRequestCompoundAllOf.spec.js
423+
test/eZmaxAPI/model/EzsignpageResponse.spec.js
415424
test/eZmaxAPI/model/EzsignsignatureCreateObjectV1Request.spec.js
416425
test/eZmaxAPI/model/EzsignsignatureCreateObjectV1Response.spec.js
417426
test/eZmaxAPI/model/EzsignsignatureCreateObjectV1ResponseAllOf.spec.js

‎README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Authorization.apiKey = "YOUR API KEY"
109109
//Authorization.apiKeyPrefix['Authorization'] = "Token"
110110

111111
var api = new EZmaxApiDefinition.GlobalCustomerApi()
112-
var pksCustomerCode = "pksCustomerCode_example"; // {String} The customer code assigned to your account
112+
var pksCustomerCode = "pksCustomerCode_example"; // {String}
113113
var opts = {
114114
'sInfrastructureproductCode': "sInfrastructureproductCode_example" // {String} The infrastructure product Code If undefined, \"appcluster01\" is assumed
115115
};
@@ -146,12 +146,14 @@ Class | Method | HTTP request | Description
146146
*EZmaxApiDefinition.ObjectEzsigndocumentApi* | [**ezsigndocumentDeleteObjectV1**](docs/ObjectEzsigndocumentApi.md#ezsigndocumentDeleteObjectV1) | **DELETE** /1/object/ezsigndocument/{pkiEzsigndocumentID} | Delete an existing Ezsigndocument
147147
*EZmaxApiDefinition.ObjectEzsigndocumentApi* | [**ezsigndocumentGetChildrenV1**](docs/ObjectEzsigndocumentApi.md#ezsigndocumentGetChildrenV1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getChildren | Retrieve an existing Ezsigndocument's children IDs
148148
*EZmaxApiDefinition.ObjectEzsigndocumentApi* | [**ezsigndocumentGetDownloadUrlV1**](docs/ObjectEzsigndocumentApi.md#ezsigndocumentGetDownloadUrlV1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} | Retrieve a URL to download documents.
149+
*EZmaxApiDefinition.ObjectEzsigndocumentApi* | [**ezsigndocumentGetEzsignpagesV1**](docs/ObjectEzsigndocumentApi.md#ezsigndocumentGetEzsignpagesV1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages | Retrieve an existing Ezsigndocument's Ezsignpages
149150
*EZmaxApiDefinition.ObjectEzsigndocumentApi* | [**ezsigndocumentGetFormDataV1**](docs/ObjectEzsigndocumentApi.md#ezsigndocumentGetFormDataV1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData | Retrieve an existing Ezsigndocument's Form Data
150151
*EZmaxApiDefinition.ObjectEzsigndocumentApi* | [**ezsigndocumentGetObjectV1**](docs/ObjectEzsigndocumentApi.md#ezsigndocumentGetObjectV1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID} | Retrieve an existing Ezsigndocument
151152
*EZmaxApiDefinition.ObjectEzsigndocumentApi* | [**ezsigndocumentGetWordsPositionsV1**](docs/ObjectEzsigndocumentApi.md#ezsigndocumentGetWordsPositionsV1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions | Retrieve positions X,Y of given words from a Ezsigndocument
152153
*EZmaxApiDefinition.ObjectEzsignfolderApi* | [**ezsignfolderCreateObjectV1**](docs/ObjectEzsignfolderApi.md#ezsignfolderCreateObjectV1) | **POST** /1/object/ezsignfolder | Create a new Ezsignfolder
153154
*EZmaxApiDefinition.ObjectEzsignfolderApi* | [**ezsignfolderDeleteObjectV1**](docs/ObjectEzsignfolderApi.md#ezsignfolderDeleteObjectV1) | **DELETE** /1/object/ezsignfolder/{pkiEzsignfolderID} | Delete an existing Ezsignfolder
154155
*EZmaxApiDefinition.ObjectEzsignfolderApi* | [**ezsignfolderGetChildrenV1**](docs/ObjectEzsignfolderApi.md#ezsignfolderGetChildrenV1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getChildren | Retrieve an existing Ezsignfolder's children IDs
156+
*EZmaxApiDefinition.ObjectEzsignfolderApi* | [**ezsignfolderGetFormsDataV1**](docs/ObjectEzsignfolderApi.md#ezsignfolderGetFormsDataV1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData | Retrieve an existing Ezsignfolder's forms data
155157
*EZmaxApiDefinition.ObjectEzsignfolderApi* | [**ezsignfolderGetObjectV1**](docs/ObjectEzsignfolderApi.md#ezsignfolderGetObjectV1) | **GET** /1/object/ezsignfolder/{pkiEzsignfolderID} | Retrieve an existing Ezsignfolder
156158
*EZmaxApiDefinition.ObjectEzsignfolderApi* | [**ezsignfolderSendV1**](docs/ObjectEzsignfolderApi.md#ezsignfolderSendV1) | **POST** /1/object/ezsignfolder/{pkiEzsignfolderID}/send | Send the Ezsignfolder to the signatories for signature
157159
*EZmaxApiDefinition.ObjectEzsignfoldersignerassociationApi* | [**ezsignfoldersignerassociationCreateObjectV1**](docs/ObjectEzsignfoldersignerassociationApi.md#ezsignfoldersignerassociationCreateObjectV1) | **POST** /1/object/ezsignfoldersignerassociation | Create a new Ezsignfoldersignerassociation
@@ -214,6 +216,9 @@ Class | Method | HTTP request | Description
214216
- [EZmaxApiDefinition.EzsigndocumentGetDownloadUrlV1Response](docs/EzsigndocumentGetDownloadUrlV1Response.md)
215217
- [EZmaxApiDefinition.EzsigndocumentGetDownloadUrlV1ResponseAllOf](docs/EzsigndocumentGetDownloadUrlV1ResponseAllOf.md)
216218
- [EZmaxApiDefinition.EzsigndocumentGetDownloadUrlV1ResponseMPayload](docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md)
219+
- [EZmaxApiDefinition.EzsigndocumentGetEzsignpagesV1Response](docs/EzsigndocumentGetEzsignpagesV1Response.md)
220+
- [EZmaxApiDefinition.EzsigndocumentGetEzsignpagesV1ResponseAllOf](docs/EzsigndocumentGetEzsignpagesV1ResponseAllOf.md)
221+
- [EZmaxApiDefinition.EzsigndocumentGetEzsignpagesV1ResponseMPayload](docs/EzsigndocumentGetEzsignpagesV1ResponseMPayload.md)
217222
- [EZmaxApiDefinition.EzsigndocumentGetObjectV1Response](docs/EzsigndocumentGetObjectV1Response.md)
218223
- [EZmaxApiDefinition.EzsigndocumentGetObjectV1ResponseAllOf](docs/EzsigndocumentGetObjectV1ResponseAllOf.md)
219224
- [EZmaxApiDefinition.EzsigndocumentGetObjectV1ResponseMPayload](docs/EzsigndocumentGetObjectV1ResponseMPayload.md)
@@ -224,7 +229,6 @@ Class | Method | HTTP request | Description
224229
- [EZmaxApiDefinition.EzsigndocumentRequest](docs/EzsigndocumentRequest.md)
225230
- [EZmaxApiDefinition.EzsigndocumentRequestCompound](docs/EzsigndocumentRequestCompound.md)
226231
- [EZmaxApiDefinition.EzsigndocumentResponse](docs/EzsigndocumentResponse.md)
227-
- [EZmaxApiDefinition.EzsigndocumentResponseAllOf](docs/EzsigndocumentResponseAllOf.md)
228232
- [EZmaxApiDefinition.EzsigndocumentResponseCompound](docs/EzsigndocumentResponseCompound.md)
229233
- [EZmaxApiDefinition.EzsignfolderCreateObjectV1Request](docs/EzsignfolderCreateObjectV1Request.md)
230234
- [EZmaxApiDefinition.EzsignfolderCreateObjectV1Response](docs/EzsignfolderCreateObjectV1Response.md)
@@ -253,6 +257,7 @@ Class | Method | HTTP request | Description
253257
- [EZmaxApiDefinition.EzsignfoldersignerassociationRequest](docs/EzsignfoldersignerassociationRequest.md)
254258
- [EZmaxApiDefinition.EzsignfoldersignerassociationRequestCompound](docs/EzsignfoldersignerassociationRequestCompound.md)
255259
- [EZmaxApiDefinition.EzsignfoldersignerassociationRequestCompoundAllOf](docs/EzsignfoldersignerassociationRequestCompoundAllOf.md)
260+
- [EZmaxApiDefinition.EzsignpageResponse](docs/EzsignpageResponse.md)
256261
- [EZmaxApiDefinition.EzsignsignatureCreateObjectV1Request](docs/EzsignsignatureCreateObjectV1Request.md)
257262
- [EZmaxApiDefinition.EzsignsignatureCreateObjectV1Response](docs/EzsignsignatureCreateObjectV1Response.md)
258263
- [EZmaxApiDefinition.EzsignsignatureCreateObjectV1ResponseAllOf](docs/EzsignsignatureCreateObjectV1ResponseAllOf.md)

‎docs/EzsigndocumentGetEzsignpagesV1Response.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# EZmaxApiDefinition.EzsigndocumentGetEzsignpagesV1Response
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**mPayload** | [**EzsigndocumentGetEzsignpagesV1ResponseMPayload**](EzsigndocumentGetEzsignpagesV1ResponseMPayload.md) | |
8+
**objDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | [optional]
9+
**objDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
10+
11+

‎docs/EzsigndocumentGetEzsignpagesV1ResponseAllOf.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# EZmaxApiDefinition.EzsigndocumentGetEzsignpagesV1ResponseAllOf
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**mPayload** | [**EzsigndocumentGetEzsignpagesV1ResponseMPayload**](EzsigndocumentGetEzsignpagesV1ResponseMPayload.md) | |
8+
9+

‎docs/EzsigndocumentGetEzsignpagesV1ResponseMPayload.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# EZmaxApiDefinition.EzsigndocumentGetEzsignpagesV1ResponseMPayload
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**a_objEzsignpage** | [**[EzsignpageResponse]**](EzsignpageResponse.md) | |
8+
9+

‎docs/EzsigndocumentGetObjectV1ResponseMPayload.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**dtEzsigndocumentDuedate** | **String** | The maximum date and time at which the document can be signed. |
99
**fkiLanguageID** | **Number** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| |
1010
**sEzsigndocumentName** | **String** | The name of the document that will be presented to Ezsignfoldersignerassociations |
11-
**pkiEzsigndocumentID** | **Number** | The unique ID of the Ezsigntemplate |
11+
**pkiEzsigndocumentID** | **Number** | The unique ID of the Ezsigndocument |
1212
**eEzsigndocumentStep** | [**FieldEEzsigndocumentStep**](FieldEEzsigndocumentStep.md) | |
1313
**dtEzsigndocumentFirstsend** | **String** | The date and time when the Ezsigndocument was first sent. |
1414
**dtEzsigndocumentLastsend** | **String** | The date and time when the Ezsigndocument was sent the last time. |

‎docs/EzsigndocumentResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**dtEzsigndocumentDuedate** | **String** | The maximum date and time at which the document can be signed. |
99
**fkiLanguageID** | **Number** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| |
1010
**sEzsigndocumentName** | **String** | The name of the document that will be presented to Ezsignfoldersignerassociations |
11-
**pkiEzsigndocumentID** | **Number** | The unique ID of the Ezsigntemplate |
11+
**pkiEzsigndocumentID** | **Number** | The unique ID of the Ezsigndocument |
1212
**eEzsigndocumentStep** | [**FieldEEzsigndocumentStep**](FieldEEzsigndocumentStep.md) | |
1313
**dtEzsigndocumentFirstsend** | **String** | The date and time when the Ezsigndocument was first sent. |
1414
**dtEzsigndocumentLastsend** | **String** | The date and time when the Ezsigndocument was sent the last time. |

‎docs/EzsigndocumentResponseAllOf.md‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎docs/EzsigndocumentResponseCompound.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
**dtEzsigndocumentDuedate** | **String** | The maximum date and time at which the document can be signed. |
99
**fkiLanguageID** | **Number** | The unique ID of the Language. Valid values: |Value|Description| |-|-| |1|French| |2|English| |
1010
**sEzsigndocumentName** | **String** | The name of the document that will be presented to Ezsignfoldersignerassociations |
11-
**pkiEzsigndocumentID** | **Number** | The unique ID of the Ezsigntemplate |
11+
**pkiEzsigndocumentID** | **Number** | The unique ID of the Ezsigndocument |
1212
**eEzsigndocumentStep** | [**FieldEEzsigndocumentStep**](FieldEEzsigndocumentStep.md) | |
1313
**dtEzsigndocumentFirstsend** | **String** | The date and time when the Ezsigndocument was first sent. |
1414
**dtEzsigndocumentLastsend** | **String** | The date and time when the Ezsigndocument was sent the last time. |

‎docs/EzsignpageResponse.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# EZmaxApiDefinition.EzsignpageResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**pkiEzsignpageID** | **Number** | The unique ID of the Ezsignpage |
8+
**iEzsignpageWidthimage** | **Number** | The Width of the page's image in pixels calculated at 100 DPI |
9+
**iEzsignpageHeightimage** | **Number** | The Height of the page's image in pixels calculated at 100 DPI |
10+
**iEzsignpageWidthpdf** | **Number** | The Width of the page in points calculated at 72 DPI |
11+
**iEzsignpageHeightpdf** | **Number** | The Height of the page in points calculated at 72 DPI |
12+
**iEzsignpagePagenumber** | **Number** | The page number in the Ezsigndocument |
13+
**sImageUrl** | **String** | The Url to the Ezsignpage's rasterized image. Url will expire after 5 minutes. |
14+
15+

0 commit comments

Comments
 (0)