Skip to content

Commit 2a58bb2

Browse files
Ian LordIan Lord
authored andcommitted
Look for details in API documentation's changelog
1 parent 6f1b4cf commit 2a58bb2

1,615 files changed

Lines changed: 176330 additions & 8415 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.

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ composer.phar
99

1010
# php-cs-fixer cache
1111
.php_cs.cache
12+
.php-cs-fixer.cache
1213

1314
# PHPUnit cache
1415
.phpunit.result.cache

.openapi-generator/FILES

Lines changed: 892 additions & 70 deletions
Large diffs are not rendered by default.

.php-cs-fixer.dist.php

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<?php
2+
3+
/**
4+
* @generated
5+
* @link https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/HEAD/doc/config.rst
6+
*/
7+
$finder = PhpCsFixer\Finder::create()
8+
->in(__DIR__)
9+
->exclude('vendor')
10+
->exclude('test')
11+
->exclude('tests')
12+
;
13+
14+
$config = new PhpCsFixer\Config();
15+
return $config->setRules([
16+
'@PSR12' => true,
17+
'phpdoc_order' => true,
18+
'array_syntax' => [ 'syntax' => 'short' ],
19+
'strict_comparison' => true,
20+
'strict_param' => true,
21+
'no_trailing_whitespace' => false,
22+
'no_trailing_whitespace_in_comment' => false,
23+
'braces' => false,
24+
'single_blank_line_at_eof' => false,
25+
'blank_line_after_namespace' => false,
26+
'no_leading_import_slash' => false,
27+
])
28+
->setFinder($finder)
29+
;

.php_cs

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

.travis.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ language: php
33
# https://docs.travis-ci.com/user/reference/bionic/#php-support
44
dist: bionic
55
php:
6-
- 7.3
76
- 7.4
87
before_install: "composer install"
98
script: "vendor/bin/phpunit"

README.md

Lines changed: 360 additions & 28 deletions
Large diffs are not rendered by default.

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
}
2121
],
2222
"require": {
23-
"php": "^7.3 || ^8.0",
23+
"php": "^7.4 || ^8.0",
2424
"ext-curl": "*",
2525
"ext-json": "*",
2626
"ext-mbstring": "*",
@@ -29,7 +29,7 @@
2929
},
3030
"require-dev": {
3131
"phpunit/phpunit": "^8.0 || ^9.0",
32-
"friendsofphp/php-cs-fixer": "^2.12"
32+
"friendsofphp/php-cs-fixer": "^3.5"
3333
},
3434
"autoload": {
3535
"psr-4": { "eZmaxAPI\\" : "lib/" }

docs/Api/ModuleAuthenticateApi.md

Lines changed: 0 additions & 72 deletions
This file was deleted.
Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# eZmaxAPI\ModuleListApi
1+
# eZmaxAPI\ModuleEzsignApi
22

33
All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest.
44

55
Method | 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

4241
try {
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

105101
try {
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

115111
Name | 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

Comments
 (0)