1- # eZmaxAPI\ModuleListApi
1+ # eZmaxAPI\ModuleEzsignApi
22
33All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest .
44
55Method | HTTP request | Description
66------------- | ------------- | -------------
7- [ ** listGetListpresentationV1 ()** ] ( ModuleListApi .md#listGetListpresentationV1 ) | ** GET** /1/module/list/listpresentation/{sListName} | Get all Listpresentation for a specific list
8- [ ** listSaveListpresentationV1 ()** ] ( ModuleListApi .md#listSaveListpresentationV1 ) | ** POST ** /1/module/list/listpresentation/{sListName} | Save all Listpresentation for a specific list
7+ [ ** ezsignSuggestSignersV1 ()** ] ( ModuleEzsignApi .md#ezsignSuggestSignersV1 ) | ** GET** /1/module/ezsign/suggestSigners | Suggest signers
8+ [ ** ezsignSuggestTemplatesV1 ()** ] ( ModuleEzsignApi .md#ezsignSuggestTemplatesV1 ) | ** GET ** /1/module/ezsign/suggestTemplates | Suggest templates
99
1010
11- ## ` listGetListpresentationV1 ()`
11+ ## ` ezsignSuggestSignersV1 ()`
1212
1313``` php
14- listGetListpresentationV1($sListName ): \eZmaxAPI\Model\ListGetListpresentationV1Response
14+ ezsignSuggestSignersV1( ): \eZmaxAPI\Model\EzsignSuggestSignersV1Response
1515```
1616
17- Get all Listpresentation for a specific list
17+ Suggest signers
1818
19- Retrive previously saved Listpresentation
19+ Retrieve previously used Ezsignsigners and all users from the system
2020
2121### Example
2222
@@ -31,31 +31,28 @@ $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authoriz
3131// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
3232
3333
34- $apiInstance = new eZmaxAPI\Api\ModuleListApi (
34+ $apiInstance = new eZmaxAPI\Api\ModuleEzsignApi (
3535 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
3636 // This is optional, `GuzzleHttp\Client` will be used as default.
3737 new GuzzleHttp\Client(),
3838 $config
3939);
40- $sListName = 'sListName_example'; // string | The list Name
4140
4241try {
43- $result = $apiInstance->listGetListpresentationV1($sListName );
42+ $result = $apiInstance->ezsignSuggestSignersV1( );
4443 print_r($result);
4544} catch (Exception $e) {
46- echo 'Exception when calling ModuleListApi->listGetListpresentationV1 : ', $e->getMessage(), PHP_EOL;
45+ echo 'Exception when calling ModuleEzsignApi->ezsignSuggestSignersV1 : ', $e->getMessage(), PHP_EOL;
4746}
4847```
4948
5049### Parameters
5150
52- Name | Type | Description | Notes
53- ------------- | ------------- | ------------- | -------------
54- ** sListName** | ** string** | The list Name |
51+ This endpoint does not need any parameter.
5552
5653### Return type
5754
58- [ ** \eZmaxAPI\Model\ListGetListpresentationV1Response ** ] ( ../Model/ListGetListpresentationV1Response .md )
55+ [ ** \eZmaxAPI\Model\EzsignSuggestSignersV1Response ** ] ( ../Model/EzsignSuggestSignersV1Response .md )
5956
6057### Authorization
6158
@@ -70,15 +67,15 @@ Name | Type | Description | Notes
7067[[ Back to Model list]] ( ../../README.md#models )
7168[[ Back to README]] ( ../../README.md )
7269
73- ## ` listSaveListpresentationV1 ()`
70+ ## ` ezsignSuggestTemplatesV1 ()`
7471
7572``` php
76- listSaveListpresentationV1($sListName, $listSaveListpresentationV1Request ): \eZmaxAPI\Model\ListSaveListpresentationV1Response
73+ ezsignSuggestTemplatesV1($fkiEzsignfoldertypeID ): \eZmaxAPI\Model\EzsignSuggestTemplatesV1Response
7774```
7875
79- Save all Listpresentation for a specific list
76+ Suggest templates
8077
81- Users can create many Listpresentations for lists in the system. They can customize orber by, filters, numbers of rows, etc.
78+ Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder
8279
8380### Example
8481
@@ -93,41 +90,39 @@ $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authoriz
9390// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
9491
9592
96- $apiInstance = new eZmaxAPI\Api\ModuleListApi (
93+ $apiInstance = new eZmaxAPI\Api\ModuleEzsignApi (
9794 // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
9895 // This is optional, `GuzzleHttp\Client` will be used as default.
9996 new GuzzleHttp\Client(),
10097 $config
10198);
102- $sListName = 'sListName_example'; // string | The list Name
103- $listSaveListpresentationV1Request = new \eZmaxAPI\Model\ListSaveListpresentationV1Request(); // \eZmaxAPI\Model\ListSaveListpresentationV1Request |
99+ $fkiEzsignfoldertypeID = 56; // int
104100
105101try {
106- $result = $apiInstance->listSaveListpresentationV1($sListName, $listSaveListpresentationV1Request );
102+ $result = $apiInstance->ezsignSuggestTemplatesV1($fkiEzsignfoldertypeID );
107103 print_r($result);
108104} catch (Exception $e) {
109- echo 'Exception when calling ModuleListApi->listSaveListpresentationV1 : ', $e->getMessage(), PHP_EOL;
105+ echo 'Exception when calling ModuleEzsignApi->ezsignSuggestTemplatesV1 : ', $e->getMessage(), PHP_EOL;
110106}
111107```
112108
113109### Parameters
114110
115111Name | Type | Description | Notes
116112------------- | ------------- | ------------- | -------------
117- ** sListName** | ** string** | The list Name |
118- ** listSaveListpresentationV1Request** | [ ** \eZmaxAPI\Model\ListSaveListpresentationV1Request** ] ( ../Model/ListSaveListpresentationV1Request.md ) | |
113+ ** fkiEzsignfoldertypeID** | ** int** | | [ optional]
119114
120115### Return type
121116
122- [ ** \eZmaxAPI\Model\ListSaveListpresentationV1Response ** ] ( ../Model/ListSaveListpresentationV1Response .md )
117+ [ ** \eZmaxAPI\Model\EzsignSuggestTemplatesV1Response ** ] ( ../Model/EzsignSuggestTemplatesV1Response .md )
123118
124119### Authorization
125120
126121[ Authorization] ( ../../README.md#Authorization )
127122
128123### HTTP request headers
129124
130- - ** Content-Type** : ` application/json `
125+ - ** Content-Type** : Not defined
131126- ** Accept** : ` application/json `
132127
133128[[ Back to top]] ( # ) [[ Back to API list]] ( ../../README.md#endpoints )
0 commit comments