Skip to content

Commit 39f8dad

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

1,553 files changed

Lines changed: 2093 additions & 1551 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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,6 +1023,7 @@ docs/EzsigntemplatepublicCreateEzsignfolderV1ResponseMPayload.md
10231023
docs/EzsigntemplatepublicCreateObjectV1Request.md
10241024
docs/EzsigntemplatepublicCreateObjectV1Response.md
10251025
docs/EzsigntemplatepublicCreateObjectV1ResponseMPayload.md
1026+
docs/EzsigntemplatepublicDeleteObjectV1Response.md
10261027
docs/EzsigntemplatepublicEditObjectV1Request.md
10271028
docs/EzsigntemplatepublicEditObjectV1Response.md
10281029
docs/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request.md
@@ -2913,6 +2914,7 @@ src/main/java/com/ezmax/api/model/EzsigntemplatepublicCreateEzsignfolderV1Respon
29132914
src/main/java/com/ezmax/api/model/EzsigntemplatepublicCreateObjectV1Request.java
29142915
src/main/java/com/ezmax/api/model/EzsigntemplatepublicCreateObjectV1Response.java
29152916
src/main/java/com/ezmax/api/model/EzsigntemplatepublicCreateObjectV1ResponseMPayload.java
2917+
src/main/java/com/ezmax/api/model/EzsigntemplatepublicDeleteObjectV1Response.java
29162918
src/main/java/com/ezmax/api/model/EzsigntemplatepublicEditObjectV1Request.java
29172919
src/main/java/com/ezmax/api/model/EzsigntemplatepublicEditObjectV1Response.java
29182920
src/main/java/com/ezmax/api/model/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request.java

README.md

Lines changed: 3 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.2
5-
- Build date: 2025-01-30T18:06:46.926395278Z[Etc/UTC]
5+
- Build date: 2025-01-30T20:25:06.858397322Z[Etc/UTC]
66
- Generator version: 7.11.0
77

88
This API expose all the functionnalities for the eZmax and eZsign applications.
@@ -410,6 +410,7 @@ Class | Method | HTTP request | Description
410410
*ObjectEzsigntemplatepackagesignermembershipApi* | [**ezsigntemplatepackagesignermembershipGetObjectV2**](docs/ObjectEzsigntemplatepackagesignermembershipApi.md#ezsigntemplatepackagesignermembershipGetObjectV2) | **GET** /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} | Retrieve an existing Ezsigntemplatepackagesignermembership
411411
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublicCreateEzsignfolderV1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicCreateEzsignfolderV1) | **POST** /1/object/ezsigntemplatepublic/createEzsignfolder | Create an Ezsignfolder
412412
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublicCreateObjectV1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicCreateObjectV1) | **POST** /1/object/ezsigntemplatepublic | Create a new Ezsigntemplatepublic
413+
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublicDeleteObjectV1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicDeleteObjectV1) | **DELETE** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Delete an existing Ezsigntemplatepublic
413414
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublicEditObjectV1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicEditObjectV1) | **PUT** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Edit an existing Ezsigntemplatepublic
414415
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublicGetEzsigntemplatepublicDetailsV1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicGetEzsigntemplatepublicDetailsV1) | **POST** /1/object/ezsigntemplatepublic/getEzsigntemplatepublicDetails | Retrieve the Ezsigntemplatepublic details
415416
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublicGetFormsDataV1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicGetFormsDataV1) | **GET** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}/getFormsData | Retrieve an existing Ezsigntemplatepublic's forms data
@@ -1601,6 +1602,7 @@ Class | Method | HTTP request | Description
16011602
- [EzsigntemplatepublicCreateObjectV1Request](docs/EzsigntemplatepublicCreateObjectV1Request.md)
16021603
- [EzsigntemplatepublicCreateObjectV1Response](docs/EzsigntemplatepublicCreateObjectV1Response.md)
16031604
- [EzsigntemplatepublicCreateObjectV1ResponseMPayload](docs/EzsigntemplatepublicCreateObjectV1ResponseMPayload.md)
1605+
- [EzsigntemplatepublicDeleteObjectV1Response](docs/EzsigntemplatepublicDeleteObjectV1Response.md)
16041606
- [EzsigntemplatepublicEditObjectV1Request](docs/EzsigntemplatepublicEditObjectV1Request.md)
16051607
- [EzsigntemplatepublicEditObjectV1Response](docs/EzsigntemplatepublicEditObjectV1Response.md)
16061608
- [EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request](docs/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request.md)

api/openapi.yaml

Lines changed: 73 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ tags:
8181
\ ask users to update to the newer version of the function and give them ample\
8282
\ time to do so.\r\nOnly after that delay expires (or no more users are still\
8383
\ using it), we will have the function **Removed**.\r\n\r\n## 1.2.X Releases\r\
84-
\n\r\n### [1.2.2] - 2025-\r\n\r\n#### Added\r\n- Property sEzsignsignergroupDescriptionX\
85-
\ in ezsignsignature-ResponseCompound\r\n- Property sEzsignsignergroupDescriptionX\
86-
\ in ezsignsignature-ResponseCompoundV3\r\n\r\n### [1.2.1] - 2025-01-28\r\n\r\n\
87-
#### Notes\r\n- The eZmax-SDK-csharp sdk can now be installed from NuGet\r\n\r\
88-
\n#### Added\r\n- DELETE /1/object/authenticationexternal/{pkiAuthenticationexternalID}\r\
84+
\n\r\n### [1.2.2] - 2025-\r\n\r\n#### Added\r\n- DELETE /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}\r\
85+
\n- Property sEzsignsignergroupDescriptionX in ezsignsignature-ResponseCompound\r\
86+
\n- Property sEzsignsignergroupDescriptionX in ezsignsignature-ResponseCompoundV3\r\
87+
\n\r\n### [1.2.1] - 2025-01-28\r\n\r\n#### Notes\r\n- The eZmax-SDK-csharp sdk\
88+
\ can now be installed from NuGet\r\n\r\n#### Added\r\n- DELETE /1/object/authenticationexternal/{pkiAuthenticationexternalID}\r\
8989
\n- DELETE /1/object/creditcardmerchant/{pkiCreditcardmerchantID}\r\n- DELETE\
9090
\ /1/object/domain/{pkiDomainID}\r\n- DELETE /1/object/ezsigntemplatedocumentpagerecognition/{pkiEzsigntemplatedocumentpagerecognitionID}\r\
9191
\n- DELETE /1/object/supply/{pkiSupplyID}\r\n- GET /1/object/authenticationexternal/getList\r\
@@ -15152,6 +15152,50 @@ paths:
1515215152
x-accepts:
1515315153
- application/json
1515415154
/1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}:
15155+
delete:
15156+
description: ""
15157+
operationId: Ezsigntemplatepublic_DeleteObject_V1
15158+
parameters:
15159+
- description: The unique ID of the Ezsigntemplatepublic
15160+
explode: false
15161+
in: path
15162+
name: pkiEzsigntemplatepublicID
15163+
required: true
15164+
schema:
15165+
$ref: '#/components/schemas/Field-pkiEzsigntemplatepublicID'
15166+
style: simple
15167+
responses:
15168+
"200":
15169+
content:
15170+
application/json:
15171+
schema:
15172+
$ref: '#/components/schemas/ezsigntemplatepublic-deleteObject-v1-Response'
15173+
description: Successful response
15174+
"404":
15175+
content:
15176+
application/json:
15177+
schema:
15178+
$ref: '#/components/schemas/Common-Response-Error'
15179+
description: The request failed. The element on which you were trying to
15180+
work does not exists. Look for detail about the error in the body
15181+
"422":
15182+
content:
15183+
application/json:
15184+
schema:
15185+
$ref: '#/components/schemas/Common-Response-Error'
15186+
description: The request was syntactically valid but failed because of an
15187+
interdependance condition. Look for detail about the error in the body
15188+
security:
15189+
- Authorization: []
15190+
summary: Delete an existing Ezsigntemplatepublic
15191+
tags:
15192+
- Object_Ezsigntemplatepublic
15193+
x-permissions:
15194+
- All
15195+
x-usertypeextra:
15196+
- AgentBroker
15197+
x-accepts:
15198+
- application/json
1515515199
description: ""
1515615200
put:
1515715201
description: ""
@@ -92352,6 +92396,30 @@ components:
9235292396
required:
9235392397
- a_pkiEzsigntemplatepublicID
9235492398
type: object
92399+
ezsigntemplatepublic-deleteObject-v1-Response:
92400+
allOf:
92401+
- $ref: '#/components/schemas/Common-Response'
92402+
description: "Response for DELETE /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}"
92403+
example:
92404+
objDebugPayload:
92405+
dtResponseDate: 2020-12-31 23:59:59
92406+
iVersionMax: 2
92407+
iVersionMin: 1
92408+
bVersionDeprecated: false
92409+
a_RequiredPermission:
92410+
- 117
92411+
- 117
92412+
objDebug:
92413+
sMemoryUsage: "11,923MB"
92414+
sRunTime: 0.6084s
92415+
iSQLSelects: 3
92416+
iSQLQueries: 6
92417+
a_objSQLQuery:
92418+
- sQuery: SELECT * FROM table
92419+
fDuration: 1.0E-4
92420+
- sQuery: SELECT * FROM table
92421+
fDuration: 1.0E-4
92422+
type: object
9235592423
ezsigntemplatepublic-editObject-v1-Request:
9235692424
description: "Request for PUT /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}"
9235792425
properties:
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
2+
3+
# EzsigntemplatepublicDeleteObjectV1Response
4+
5+
Response for DELETE /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}
6+
7+
## Properties
8+
9+
| Name | Type | Description | Notes |
10+
|------------ | ------------- | ------------- | -------------|
11+
|**objDebugPayload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | |
12+
|**objDebug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] |
13+
14+
15+

docs/ObjectEzsigntemplatepublicApi.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/r
66
|------------- | ------------- | -------------|
77
| [**ezsigntemplatepublicCreateEzsignfolderV1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicCreateEzsignfolderV1) | **POST** /1/object/ezsigntemplatepublic/createEzsignfolder | Create an Ezsignfolder |
88
| [**ezsigntemplatepublicCreateObjectV1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicCreateObjectV1) | **POST** /1/object/ezsigntemplatepublic | Create a new Ezsigntemplatepublic |
9+
| [**ezsigntemplatepublicDeleteObjectV1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicDeleteObjectV1) | **DELETE** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Delete an existing Ezsigntemplatepublic |
910
| [**ezsigntemplatepublicEditObjectV1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicEditObjectV1) | **PUT** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Edit an existing Ezsigntemplatepublic |
1011
| [**ezsigntemplatepublicGetEzsigntemplatepublicDetailsV1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicGetEzsigntemplatepublicDetailsV1) | **POST** /1/object/ezsigntemplatepublic/getEzsigntemplatepublicDetails | Retrieve the Ezsigntemplatepublic details |
1112
| [**ezsigntemplatepublicGetFormsDataV1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublicGetFormsDataV1) | **GET** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}/getFormsData | Retrieve an existing Ezsigntemplatepublic's forms data |
@@ -154,6 +155,77 @@ public class Example {
154155
|-------------|-------------|------------------|
155156
| **201** | Successful response | - |
156157

158+
<a id="ezsigntemplatepublicDeleteObjectV1"></a>
159+
# **ezsigntemplatepublicDeleteObjectV1**
160+
> EzsigntemplatepublicDeleteObjectV1Response ezsigntemplatepublicDeleteObjectV1(pkiEzsigntemplatepublicID)
161+
162+
Delete an existing Ezsigntemplatepublic
163+
164+
165+
166+
### Example
167+
```java
168+
// Import classes:
169+
import eZmaxAPI.ApiClient;
170+
import eZmaxAPI.ApiException;
171+
import eZmaxAPI.Configuration;
172+
import eZmaxAPI.auth.*;
173+
import eZmaxAPI.models.*;
174+
import com.ezmax.api.ObjectEzsigntemplatepublicApi;
175+
176+
public class Example {
177+
public static void main(String[] args) {
178+
ApiClient defaultClient = Configuration.getDefaultApiClient();
179+
defaultClient.setBasePath("https://prod.api.appcluster01.ca-central-1.ezmax.com/rest");
180+
181+
// Configure API key authorization: Authorization
182+
ApiKeyAuth Authorization = (ApiKeyAuth) defaultClient.getAuthentication("Authorization");
183+
Authorization.setApiKey("YOUR API KEY");
184+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
185+
//Authorization.setApiKeyPrefix("Token");
186+
187+
ObjectEzsigntemplatepublicApi apiInstance = new ObjectEzsigntemplatepublicApi(defaultClient);
188+
Integer pkiEzsigntemplatepublicID = 56; // Integer | The unique ID of the Ezsigntemplatepublic
189+
try {
190+
EzsigntemplatepublicDeleteObjectV1Response result = apiInstance.ezsigntemplatepublicDeleteObjectV1(pkiEzsigntemplatepublicID);
191+
System.out.println(result);
192+
} catch (ApiException e) {
193+
System.err.println("Exception when calling ObjectEzsigntemplatepublicApi#ezsigntemplatepublicDeleteObjectV1");
194+
System.err.println("Status code: " + e.getCode());
195+
System.err.println("Reason: " + e.getResponseBody());
196+
System.err.println("Response headers: " + e.getResponseHeaders());
197+
e.printStackTrace();
198+
}
199+
}
200+
}
201+
```
202+
203+
### Parameters
204+
205+
| Name | Type | Description | Notes |
206+
|------------- | ------------- | ------------- | -------------|
207+
| **pkiEzsigntemplatepublicID** | **Integer**| The unique ID of the Ezsigntemplatepublic | |
208+
209+
### Return type
210+
211+
[**EzsigntemplatepublicDeleteObjectV1Response**](EzsigntemplatepublicDeleteObjectV1Response.md)
212+
213+
### Authorization
214+
215+
[Authorization](../README.md#Authorization)
216+
217+
### HTTP request headers
218+
219+
- **Content-Type**: Not defined
220+
- **Accept**: application/json
221+
222+
### HTTP response details
223+
| Status code | Description | Response headers |
224+
|-------------|-------------|------------------|
225+
| **200** | Successful response | - |
226+
| **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 | - |
227+
| **422** | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
228+
157229
<a id="ezsigntemplatepublicEditObjectV1"></a>
158230
# **ezsigntemplatepublicEditObjectV1**
159231
> EzsigntemplatepublicEditObjectV1Response ezsigntemplatepublicEditObjectV1(pkiEzsigntemplatepublicID, ezsigntemplatepublicEditObjectV1Request)

0 commit comments

Comments
 (0)