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

Commit cce8f04

Browse files
Herrick19Herrick19
committed
Look for details in API documentation's changelog
1 parent addae29 commit cce8f04

15 files changed

+210
-137
lines changed

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ docs/ContactinformationsRequestCompoundAllOf.md
3838
docs/CustomFormDataDocumentResponse.md
3939
docs/CustomFormDataFolderResponse.md
4040
docs/CustomFormDataSignerResponse.md
41-
docs/CustomWordPositionResponse.md
41+
docs/CustomWordPositionOccurenceResponse.md
42+
docs/CustomWordPositionWordResponse.md
4243
docs/EmailRequest.md
4344
docs/EzsigndocumentApplyEzsigntemplateV1Request.md
4445
docs/EzsigndocumentApplyEzsigntemplateV1Response.md
@@ -64,7 +65,6 @@ docs/EzsigndocumentGetObjectV1ResponseMPayload.md
6465
docs/EzsigndocumentGetWordsPositionsV1Request.md
6566
docs/EzsigndocumentGetWordsPositionsV1Response.md
6667
docs/EzsigndocumentGetWordsPositionsV1ResponseAllOf.md
67-
docs/EzsigndocumentGetWordsPositionsV1ResponseMPayload.md
6868
docs/EzsigndocumentRequest.md
6969
docs/EzsigndocumentRequestCompound.md
7070
docs/EzsigndocumentResponse.md
@@ -230,7 +230,8 @@ src/eZmaxAPI/model/ContactinformationsRequestCompoundAllOf.js
230230
src/eZmaxAPI/model/CustomFormDataDocumentResponse.js
231231
src/eZmaxAPI/model/CustomFormDataFolderResponse.js
232232
src/eZmaxAPI/model/CustomFormDataSignerResponse.js
233-
src/eZmaxAPI/model/CustomWordPositionResponse.js
233+
src/eZmaxAPI/model/CustomWordPositionOccurenceResponse.js
234+
src/eZmaxAPI/model/CustomWordPositionWordResponse.js
234235
src/eZmaxAPI/model/EmailRequest.js
235236
src/eZmaxAPI/model/EzsigndocumentApplyEzsigntemplateV1Request.js
236237
src/eZmaxAPI/model/EzsigndocumentApplyEzsigntemplateV1Response.js
@@ -256,7 +257,6 @@ src/eZmaxAPI/model/EzsigndocumentGetObjectV1ResponseMPayload.js
256257
src/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1Request.js
257258
src/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1Response.js
258259
src/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1ResponseAllOf.js
259-
src/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1ResponseMPayload.js
260260
src/eZmaxAPI/model/EzsigndocumentRequest.js
261261
src/eZmaxAPI/model/EzsigndocumentRequestCompound.js
262262
src/eZmaxAPI/model/EzsigndocumentResponse.js
@@ -403,7 +403,8 @@ test/eZmaxAPI/model/ContactinformationsRequestCompoundAllOf.spec.js
403403
test/eZmaxAPI/model/CustomFormDataDocumentResponse.spec.js
404404
test/eZmaxAPI/model/CustomFormDataFolderResponse.spec.js
405405
test/eZmaxAPI/model/CustomFormDataSignerResponse.spec.js
406-
test/eZmaxAPI/model/CustomWordPositionResponse.spec.js
406+
test/eZmaxAPI/model/CustomWordPositionOccurenceResponse.spec.js
407+
test/eZmaxAPI/model/CustomWordPositionWordResponse.spec.js
407408
test/eZmaxAPI/model/EmailRequest.spec.js
408409
test/eZmaxAPI/model/EzsigndocumentApplyEzsigntemplateV1Request.spec.js
409410
test/eZmaxAPI/model/EzsigndocumentApplyEzsigntemplateV1Response.spec.js
@@ -429,7 +430,6 @@ test/eZmaxAPI/model/EzsigndocumentGetObjectV1ResponseMPayload.spec.js
429430
test/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1Request.spec.js
430431
test/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1Response.spec.js
431432
test/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1ResponseAllOf.spec.js
432-
test/eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1ResponseMPayload.spec.js
433433
test/eZmaxAPI/model/EzsigndocumentRequest.spec.js
434434
test/eZmaxAPI/model/EzsigndocumentRequestCompound.spec.js
435435
test/eZmaxAPI/model/EzsigndocumentResponse.spec.js

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,8 @@ Class | Method | HTTP request | Description
209209
- [EZmaxApiDefinition.CustomFormDataDocumentResponse](docs/CustomFormDataDocumentResponse.md)
210210
- [EZmaxApiDefinition.CustomFormDataFolderResponse](docs/CustomFormDataFolderResponse.md)
211211
- [EZmaxApiDefinition.CustomFormDataSignerResponse](docs/CustomFormDataSignerResponse.md)
212-
- [EZmaxApiDefinition.CustomWordPositionResponse](docs/CustomWordPositionResponse.md)
212+
- [EZmaxApiDefinition.CustomWordPositionOccurenceResponse](docs/CustomWordPositionOccurenceResponse.md)
213+
- [EZmaxApiDefinition.CustomWordPositionWordResponse](docs/CustomWordPositionWordResponse.md)
213214
- [EZmaxApiDefinition.EmailRequest](docs/EmailRequest.md)
214215
- [EZmaxApiDefinition.EzsigndocumentApplyEzsigntemplateV1Request](docs/EzsigndocumentApplyEzsigntemplateV1Request.md)
215216
- [EZmaxApiDefinition.EzsigndocumentApplyEzsigntemplateV1Response](docs/EzsigndocumentApplyEzsigntemplateV1Response.md)
@@ -235,7 +236,6 @@ Class | Method | HTTP request | Description
235236
- [EZmaxApiDefinition.EzsigndocumentGetWordsPositionsV1Request](docs/EzsigndocumentGetWordsPositionsV1Request.md)
236237
- [EZmaxApiDefinition.EzsigndocumentGetWordsPositionsV1Response](docs/EzsigndocumentGetWordsPositionsV1Response.md)
237238
- [EZmaxApiDefinition.EzsigndocumentGetWordsPositionsV1ResponseAllOf](docs/EzsigndocumentGetWordsPositionsV1ResponseAllOf.md)
238-
- [EZmaxApiDefinition.EzsigndocumentGetWordsPositionsV1ResponseMPayload](docs/EzsigndocumentGetWordsPositionsV1ResponseMPayload.md)
239239
- [EZmaxApiDefinition.EzsigndocumentRequest](docs/EzsigndocumentRequest.md)
240240
- [EZmaxApiDefinition.EzsigndocumentRequestCompound](docs/EzsigndocumentRequestCompound.md)
241241
- [EZmaxApiDefinition.EzsigndocumentResponse](docs/EzsigndocumentResponse.md)

‎docs/CustomWordPositionResponse.md‎ renamed to ‎docs/CustomWordPositionOccurenceResponse.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# EZmaxApiDefinition.CustomWordPositionResponse
1+
# EZmaxApiDefinition.CustomWordPositionOccurenceResponse
22

33
## Properties
44

‎docs/CustomWordPositionWordResponse.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# EZmaxApiDefinition.CustomWordPositionWordResponse
2+
3+
## Properties
4+
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**sWord** | **String** | The searched word |
8+
**objWordPositionOccurence** | [**[CustomWordPositionOccurenceResponse]**](CustomWordPositionOccurenceResponse.md) | The found occurences for the seached word |
9+
10+

‎docs/EzsigndocumentGetWordsPositionsV1Response.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**mPayload** | [**EzsigndocumentGetWordsPositionsV1ResponseMPayload**](EzsigndocumentGetWordsPositionsV1ResponseMPayload.md) | |
7+
**mPayload** | [**[CustomWordPositionWordResponse]**](CustomWordPositionWordResponse.md) | Payload for the /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions API Request |
88
**objDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | [optional]
99
**objDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
1010

‎docs/EzsigndocumentGetWordsPositionsV1ResponseAllOf.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**mPayload** | [**EzsigndocumentGetWordsPositionsV1ResponseMPayload**](EzsigndocumentGetWordsPositionsV1ResponseMPayload.md) | |
7+
**mPayload** | [**[CustomWordPositionWordResponse]**](CustomWordPositionWordResponse.md) | Payload for the /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions API Request |
88

99

‎docs/EzsigndocumentGetWordsPositionsV1ResponseMPayload.md‎

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

‎src/eZmaxAPI/index.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ import ContactinformationsRequestCompoundAllOf from './model/Contactinformations
4848
import CustomFormDataDocumentResponse from './model/CustomFormDataDocumentResponse';
4949
import CustomFormDataFolderResponse from './model/CustomFormDataFolderResponse';
5050
import CustomFormDataSignerResponse from './model/CustomFormDataSignerResponse';
51-
import CustomWordPositionResponse from './model/CustomWordPositionResponse';
51+
import CustomWordPositionOccurenceResponse from './model/CustomWordPositionOccurenceResponse';
52+
import CustomWordPositionWordResponse from './model/CustomWordPositionWordResponse';
5253
import EmailRequest from './model/EmailRequest';
5354
import EzsigndocumentApplyEzsigntemplateV1Request from './model/EzsigndocumentApplyEzsigntemplateV1Request';
5455
import EzsigndocumentApplyEzsigntemplateV1Response from './model/EzsigndocumentApplyEzsigntemplateV1Response';
@@ -74,7 +75,6 @@ import EzsigndocumentGetObjectV1ResponseMPayload from './model/EzsigndocumentGet
7475
import EzsigndocumentGetWordsPositionsV1Request from './model/EzsigndocumentGetWordsPositionsV1Request';
7576
import EzsigndocumentGetWordsPositionsV1Response from './model/EzsigndocumentGetWordsPositionsV1Response';
7677
import EzsigndocumentGetWordsPositionsV1ResponseAllOf from './model/EzsigndocumentGetWordsPositionsV1ResponseAllOf';
77-
import EzsigndocumentGetWordsPositionsV1ResponseMPayload from './model/EzsigndocumentGetWordsPositionsV1ResponseMPayload';
7878
import EzsigndocumentRequest from './model/EzsigndocumentRequest';
7979
import EzsigndocumentRequestCompound from './model/EzsigndocumentRequestCompound';
8080
import EzsigndocumentResponse from './model/EzsigndocumentResponse';
@@ -437,10 +437,16 @@ export {
437437
CustomFormDataSignerResponse,
438438

439439
/**
440-
* The CustomWordPositionResponse model constructor.
441-
* @property {module:eZmaxAPI/model/CustomWordPositionResponse}
440+
* The CustomWordPositionOccurenceResponse model constructor.
441+
* @property {module:eZmaxAPI/model/CustomWordPositionOccurenceResponse}
442442
*/
443-
CustomWordPositionResponse,
443+
CustomWordPositionOccurenceResponse,
444+
445+
/**
446+
* The CustomWordPositionWordResponse model constructor.
447+
* @property {module:eZmaxAPI/model/CustomWordPositionWordResponse}
448+
*/
449+
CustomWordPositionWordResponse,
444450

445451
/**
446452
* The EmailRequest model constructor.
@@ -592,12 +598,6 @@ export {
592598
*/
593599
EzsigndocumentGetWordsPositionsV1ResponseAllOf,
594600

595-
/**
596-
* The EzsigndocumentGetWordsPositionsV1ResponseMPayload model constructor.
597-
* @property {module:eZmaxAPI/model/EzsigndocumentGetWordsPositionsV1ResponseMPayload}
598-
*/
599-
EzsigndocumentGetWordsPositionsV1ResponseMPayload,
600-
601601
/**
602602
* The EzsigndocumentRequest model constructor.
603603
* @property {module:eZmaxAPI/model/EzsigndocumentRequest}

‎src/eZmaxAPI/model/CustomWordPositionResponse.js‎ renamed to ‎src/eZmaxAPI/model/CustomWordPositionOccurenceResponse.js‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@
1414
import ApiClient from '../ApiClient';
1515

1616
/**
17-
* The CustomWordPositionResponse model module.
18-
* @module eZmaxAPI/model/CustomWordPositionResponse
17+
* The CustomWordPositionOccurenceResponse model module.
18+
* @module eZmaxAPI/model/CustomWordPositionOccurenceResponse
1919
* @version 1.1.0
2020
*/
21-
class CustomWordPositionResponse {
21+
class CustomWordPositionOccurenceResponse {
2222
/**
23-
* Constructs a new <code>CustomWordPositionResponse</code>.
23+
* Constructs a new <code>CustomWordPositionOccurenceResponse</code>.
2424
* A Word Position Object
25-
* @alias module:eZmaxAPI/model/CustomWordPositionResponse
25+
* @alias module:eZmaxAPI/model/CustomWordPositionOccurenceResponse
2626
*/
2727
constructor() {
2828

29-
CustomWordPositionResponse.initialize(this);
29+
CustomWordPositionOccurenceResponse.initialize(this);
3030
}
3131

3232
/**
@@ -38,15 +38,15 @@ class CustomWordPositionResponse {
3838
}
3939

4040
/**
41-
* Constructs a <code>CustomWordPositionResponse</code> from a plain JavaScript object, optionally creating a new instance.
41+
* Constructs a <code>CustomWordPositionOccurenceResponse</code> from a plain JavaScript object, optionally creating a new instance.
4242
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
4343
* @param {Object} data The plain JavaScript object bearing properties of interest.
44-
* @param {module:eZmaxAPI/model/CustomWordPositionResponse} obj Optional instance to populate.
45-
* @return {module:eZmaxAPI/model/CustomWordPositionResponse} The populated <code>CustomWordPositionResponse</code> instance.
44+
* @param {module:eZmaxAPI/model/CustomWordPositionOccurenceResponse} obj Optional instance to populate.
45+
* @return {module:eZmaxAPI/model/CustomWordPositionOccurenceResponse} The populated <code>CustomWordPositionOccurenceResponse</code> instance.
4646
*/
4747
static constructFromObject(data, obj) {
4848
if (data) {
49-
obj = obj || new CustomWordPositionResponse();
49+
obj = obj || new CustomWordPositionOccurenceResponse();
5050

5151
if (data.hasOwnProperty('iPage')) {
5252
obj['iPage'] = ApiClient.convertToType(data['iPage'], 'Number');
@@ -116,24 +116,24 @@ class CustomWordPositionResponse {
116116
* The page where the word occurence was found
117117
* @member {Number} iPage
118118
*/
119-
CustomWordPositionResponse.prototype['iPage'] = undefined;
119+
CustomWordPositionOccurenceResponse.prototype['iPage'] = undefined;
120120

121121
/**
122122
* The X coordinate (Horizontal) where the Word occurence was found. Coordinate is calculated at 100dpi (dot per inch).
123123
* @member {Number} iX
124124
*/
125-
CustomWordPositionResponse.prototype['iX'] = undefined;
125+
CustomWordPositionOccurenceResponse.prototype['iX'] = undefined;
126126

127127
/**
128128
* The Y coordinate (Vertical) where the Word occurence was found. Coordinate is calculated at 100dpi (dot per inch).
129129
* @member {Number} iY
130130
*/
131-
CustomWordPositionResponse.prototype['iY'] = undefined;
131+
CustomWordPositionOccurenceResponse.prototype['iY'] = undefined;
132132

133133

134134

135135

136136

137137

138-
export default CustomWordPositionResponse;
138+
export default CustomWordPositionOccurenceResponse;
139139

‎src/eZmaxAPI/model/CustomWordPositionWordResponse.js‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
/**
2+
* eZmax API Definition
3+
* This API expose all the functionnalities for the eZmax and eZsign applications.
4+
*
5+
* The version of the OpenAPI document: 1.1.0
6+
* Contact: support-api@ezmax.ca
7+
*
8+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9+
* https://openapi-generator.tech
10+
* Do not edit the class manually.
11+
*
12+
*/
13+
14+
import ApiClient from '../ApiClient';
15+
import CustomWordPositionOccurenceResponse from './CustomWordPositionOccurenceResponse';
16+
17+
/**
18+
* The CustomWordPositionWordResponse model module.
19+
* @module eZmaxAPI/model/CustomWordPositionWordResponse
20+
* @version 1.1.0
21+
*/
22+
class CustomWordPositionWordResponse {
23+
/**
24+
* Constructs a new <code>CustomWordPositionWordResponse</code>.
25+
* A Word Position Object
26+
* @alias module:eZmaxAPI/model/CustomWordPositionWordResponse
27+
* @param sWord {String} The searched word
28+
* @param objWordPositionOccurence {Array.<module:eZmaxAPI/model/CustomWordPositionOccurenceResponse>} The found occurences for the seached word
29+
*/
30+
constructor(sWord, objWordPositionOccurence) {
31+
32+
CustomWordPositionWordResponse.initialize(this, sWord, objWordPositionOccurence);
33+
}
34+
35+
/**
36+
* Initializes the fields of this object.
37+
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
38+
* Only for internal use.
39+
*/
40+
static initialize(obj, sWord, objWordPositionOccurence) {
41+
obj['sWord'] = sWord;
42+
obj['objWordPositionOccurence'] = objWordPositionOccurence;
43+
}
44+
45+
/**
46+
* Constructs a <code>CustomWordPositionWordResponse</code> from a plain JavaScript object, optionally creating a new instance.
47+
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
48+
* @param {Object} data The plain JavaScript object bearing properties of interest.
49+
* @param {module:eZmaxAPI/model/CustomWordPositionWordResponse} obj Optional instance to populate.
50+
* @return {module:eZmaxAPI/model/CustomWordPositionWordResponse} The populated <code>CustomWordPositionWordResponse</code> instance.
51+
*/
52+
static constructFromObject(data, obj) {
53+
if (data) {
54+
obj = obj || new CustomWordPositionWordResponse();
55+
56+
if (data.hasOwnProperty('sWord')) {
57+
obj['sWord'] = ApiClient.convertToType(data['sWord'], 'String');
58+
}
59+
if (data.hasOwnProperty('objWordPositionOccurence')) {
60+
obj['objWordPositionOccurence'] = ApiClient.convertToType(data['objWordPositionOccurence'], [CustomWordPositionOccurenceResponse]);
61+
}
62+
}
63+
return obj;
64+
}
65+
66+
/**
67+
* Returns The searched word
68+
* @return {String}
69+
*/
70+
getSWord() {
71+
return this.sWord;
72+
}
73+
74+
/**
75+
* Sets The searched word
76+
* @param {String} sWord The searched word
77+
*/
78+
setSWord(sWord) {
79+
this['sWord'] = sWord;
80+
}
81+
/**
82+
* Returns The found occurences for the seached word
83+
* @return {Array.<module:eZmaxAPI/model/CustomWordPositionOccurenceResponse>}
84+
*/
85+
getObjWordPositionOccurence() {
86+
return this.objWordPositionOccurence;
87+
}
88+
89+
/**
90+
* Sets The found occurences for the seached word
91+
* @param {Array.<module:eZmaxAPI/model/CustomWordPositionOccurenceResponse>} objWordPositionOccurence The found occurences for the seached word
92+
*/
93+
setObjWordPositionOccurence(objWordPositionOccurence) {
94+
this['objWordPositionOccurence'] = objWordPositionOccurence;
95+
}
96+
97+
}
98+
99+
/**
100+
* The searched word
101+
* @member {String} sWord
102+
*/
103+
CustomWordPositionWordResponse.prototype['sWord'] = undefined;
104+
105+
/**
106+
* The found occurences for the seached word
107+
* @member {Array.<module:eZmaxAPI/model/CustomWordPositionOccurenceResponse>} objWordPositionOccurence
108+
*/
109+
CustomWordPositionWordResponse.prototype['objWordPositionOccurence'] = undefined;
110+
111+
112+
113+
114+
115+
116+
export default CustomWordPositionWordResponse;
117+

0 commit comments

Comments
 (0)