Skip to content

Commit 607cae5

Browse files
author
Api (Codebuild)
committed
Look for details in API documentation's changelog
1 parent 8414eb6 commit 607cae5

File tree

8 files changed

+485
-0
lines changed

8 files changed

+485
-0
lines changed

.openapi-generator/FILES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1021,6 +1021,7 @@ docs/EzsigntemplatepublicCreateEzsignfolderV1ResponseMPayload.md
10211021
docs/EzsigntemplatepublicCreateObjectV1Request.md
10221022
docs/EzsigntemplatepublicCreateObjectV1Response.md
10231023
docs/EzsigntemplatepublicCreateObjectV1ResponseMPayload.md
1024+
docs/EzsigntemplatepublicDeleteObjectV1Response.md
10241025
docs/EzsigntemplatepublicEditObjectV1Request.md
10251026
docs/EzsigntemplatepublicEditObjectV1Response.md
10261027
docs/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request.md
@@ -2908,6 +2909,7 @@ eZmaxApi/models/ezsigntemplatepublic_create_ezsignfolder_v1_response_m_payload.p
29082909
eZmaxApi/models/ezsigntemplatepublic_create_object_v1_request.py
29092910
eZmaxApi/models/ezsigntemplatepublic_create_object_v1_response.py
29102911
eZmaxApi/models/ezsigntemplatepublic_create_object_v1_response_m_payload.py
2912+
eZmaxApi/models/ezsigntemplatepublic_delete_object_v1_response.py
29112913
eZmaxApi/models/ezsigntemplatepublic_edit_object_v1_request.py
29122914
eZmaxApi/models/ezsigntemplatepublic_edit_object_v1_response.py
29132915
eZmaxApi/models/ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_request.py

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,7 @@ Class | Method | HTTP request | Description
380380
*ObjectEzsigntemplatepackagesignermembershipApi* | [**ezsigntemplatepackagesignermembership_get_object_v2**](docs/ObjectEzsigntemplatepackagesignermembershipApi.md#ezsigntemplatepackagesignermembership_get_object_v2) | **GET** /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID} | Retrieve an existing Ezsigntemplatepackagesignermembership
381381
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublic_create_ezsignfolder_v1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_create_ezsignfolder_v1) | **POST** /1/object/ezsigntemplatepublic/createEzsignfolder | Create an Ezsignfolder
382382
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublic_create_object_v1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_create_object_v1) | **POST** /1/object/ezsigntemplatepublic | Create a new Ezsigntemplatepublic
383+
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublic_delete_object_v1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_delete_object_v1) | **DELETE** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Delete an existing Ezsigntemplatepublic
383384
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublic_edit_object_v1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_edit_object_v1) | **PUT** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Edit an existing Ezsigntemplatepublic
384385
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1) | **POST** /1/object/ezsigntemplatepublic/getEzsigntemplatepublicDetails | Retrieve the Ezsigntemplatepublic details
385386
*ObjectEzsigntemplatepublicApi* | [**ezsigntemplatepublic_get_forms_data_v1**](docs/ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_get_forms_data_v1) | **GET** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}/getFormsData | Retrieve an existing Ezsigntemplatepublic's forms data
@@ -1571,6 +1572,7 @@ Class | Method | HTTP request | Description
15711572
- [EzsigntemplatepublicCreateObjectV1Request](docs/EzsigntemplatepublicCreateObjectV1Request.md)
15721573
- [EzsigntemplatepublicCreateObjectV1Response](docs/EzsigntemplatepublicCreateObjectV1Response.md)
15731574
- [EzsigntemplatepublicCreateObjectV1ResponseMPayload](docs/EzsigntemplatepublicCreateObjectV1ResponseMPayload.md)
1575+
- [EzsigntemplatepublicDeleteObjectV1Response](docs/EzsigntemplatepublicDeleteObjectV1Response.md)
15741576
- [EzsigntemplatepublicEditObjectV1Request](docs/EzsigntemplatepublicEditObjectV1Request.md)
15751577
- [EzsigntemplatepublicEditObjectV1Response](docs/EzsigntemplatepublicEditObjectV1Response.md)
15761578
- [EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request](docs/EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request.md)
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# EzsigntemplatepublicDeleteObjectV1Response
2+
3+
Response for DELETE /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | |
10+
**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional]
11+
12+
## Example
13+
14+
```python
15+
from eZmaxApi.models.ezsigntemplatepublic_delete_object_v1_response import EzsigntemplatepublicDeleteObjectV1Response
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of EzsigntemplatepublicDeleteObjectV1Response from a JSON string
20+
ezsigntemplatepublic_delete_object_v1_response_instance = EzsigntemplatepublicDeleteObjectV1Response.from_json(json)
21+
# print the JSON string representation of the object
22+
print(EzsigntemplatepublicDeleteObjectV1Response.to_json())
23+
24+
# convert the object into a dict
25+
ezsigntemplatepublic_delete_object_v1_response_dict = ezsigntemplatepublic_delete_object_v1_response_instance.to_dict()
26+
# create an instance of EzsigntemplatepublicDeleteObjectV1Response from a dict
27+
ezsigntemplatepublic_delete_object_v1_response_from_dict = EzsigntemplatepublicDeleteObjectV1Response.from_dict(ezsigntemplatepublic_delete_object_v1_response_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

docs/ObjectEzsigntemplatepublicApi.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**ezsigntemplatepublic_create_ezsignfolder_v1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_create_ezsignfolder_v1) | **POST** /1/object/ezsigntemplatepublic/createEzsignfolder | Create an Ezsignfolder
88
[**ezsigntemplatepublic_create_object_v1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_create_object_v1) | **POST** /1/object/ezsigntemplatepublic | Create a new Ezsigntemplatepublic
9+
[**ezsigntemplatepublic_delete_object_v1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_delete_object_v1) | **DELETE** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Delete an existing Ezsigntemplatepublic
910
[**ezsigntemplatepublic_edit_object_v1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_edit_object_v1) | **PUT** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID} | Edit an existing Ezsigntemplatepublic
1011
[**ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1) | **POST** /1/object/ezsigntemplatepublic/getEzsigntemplatepublicDetails | Retrieve the Ezsigntemplatepublic details
1112
[**ezsigntemplatepublic_get_forms_data_v1**](ObjectEzsigntemplatepublicApi.md#ezsigntemplatepublic_get_forms_data_v1) | **GET** /1/object/ezsigntemplatepublic/{pkiEzsigntemplatepublicID}/getFormsData | Retrieve an existing Ezsigntemplatepublic's forms data
@@ -176,6 +177,87 @@ Name | Type | Description | Notes
176177

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

180+
# **ezsigntemplatepublic_delete_object_v1**
181+
> EzsigntemplatepublicDeleteObjectV1Response ezsigntemplatepublic_delete_object_v1(pki_ezsigntemplatepublic_id)
182+
183+
Delete an existing Ezsigntemplatepublic
184+
185+
186+
187+
### Example
188+
189+
* Api Key Authentication (Authorization):
190+
191+
```python
192+
import eZmaxApi
193+
from eZmaxApi.models.ezsigntemplatepublic_delete_object_v1_response import EzsigntemplatepublicDeleteObjectV1Response
194+
from eZmaxApi.rest import ApiException
195+
from pprint import pprint
196+
197+
# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
198+
# See configuration.py for a list of all supported configuration parameters.
199+
configuration = eZmaxApi.Configuration(
200+
host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
201+
)
202+
203+
# The client must configure the authentication and authorization parameters
204+
# in accordance with the API server security policy.
205+
# Examples for each auth method are provided below, use the example that
206+
# satisfies your auth use case.
207+
208+
# Configure API key authorization: Authorization
209+
configuration.api_key['Authorization'] = os.environ["API_KEY"]
210+
211+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
212+
# configuration.api_key_prefix['Authorization'] = 'Bearer'
213+
214+
# Enter a context with an instance of the API client
215+
with eZmaxApi.ApiClient(configuration) as api_client:
216+
# Create an instance of the API class
217+
api_instance = eZmaxApi.ObjectEzsigntemplatepublicApi(api_client)
218+
pki_ezsigntemplatepublic_id = 56 # int | The unique ID of the Ezsigntemplatepublic
219+
220+
try:
221+
# Delete an existing Ezsigntemplatepublic
222+
api_response = api_instance.ezsigntemplatepublic_delete_object_v1(pki_ezsigntemplatepublic_id)
223+
print("The response of ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_delete_object_v1:\n")
224+
pprint(api_response)
225+
except Exception as e:
226+
print("Exception when calling ObjectEzsigntemplatepublicApi->ezsigntemplatepublic_delete_object_v1: %s\n" % e)
227+
```
228+
229+
230+
231+
### Parameters
232+
233+
234+
Name | Type | Description | Notes
235+
------------- | ------------- | ------------- | -------------
236+
**pki_ezsigntemplatepublic_id** | **int**| The unique ID of the Ezsigntemplatepublic |
237+
238+
### Return type
239+
240+
[**EzsigntemplatepublicDeleteObjectV1Response**](EzsigntemplatepublicDeleteObjectV1Response.md)
241+
242+
### Authorization
243+
244+
[Authorization](../README.md#Authorization)
245+
246+
### HTTP request headers
247+
248+
- **Content-Type**: Not defined
249+
- **Accept**: application/json
250+
251+
### HTTP response details
252+
253+
| Status code | Description | Response headers |
254+
|-------------|-------------|------------------|
255+
**200** | Successful response | - |
256+
**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 | - |
257+
**422** | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body | - |
258+
259+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
260+
179261
# **ezsigntemplatepublic_edit_object_v1**
180262
> EzsigntemplatepublicEditObjectV1Response ezsigntemplatepublic_edit_object_v1(pki_ezsigntemplatepublic_id, ezsigntemplatepublic_edit_object_v1_request)
181263

eZmaxApi/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1159,6 +1159,7 @@
11591159
from eZmaxApi.models.ezsigntemplatepublic_create_object_v1_request import EzsigntemplatepublicCreateObjectV1Request
11601160
from eZmaxApi.models.ezsigntemplatepublic_create_object_v1_response import EzsigntemplatepublicCreateObjectV1Response
11611161
from eZmaxApi.models.ezsigntemplatepublic_create_object_v1_response_m_payload import EzsigntemplatepublicCreateObjectV1ResponseMPayload
1162+
from eZmaxApi.models.ezsigntemplatepublic_delete_object_v1_response import EzsigntemplatepublicDeleteObjectV1Response
11621163
from eZmaxApi.models.ezsigntemplatepublic_edit_object_v1_request import EzsigntemplatepublicEditObjectV1Request
11631164
from eZmaxApi.models.ezsigntemplatepublic_edit_object_v1_response import EzsigntemplatepublicEditObjectV1Response
11641165
from eZmaxApi.models.ezsigntemplatepublic_get_ezsigntemplatepublic_details_v1_request import EzsigntemplatepublicGetEzsigntemplatepublicDetailsV1Request

0 commit comments

Comments
 (0)