Skip to content

Commit

Permalink
Look for details in API documentation's changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
Api (Codebuild) committed Jan 14, 2025
1 parent aa4753a commit c47e7f1
Show file tree
Hide file tree
Showing 4,291 changed files with 360,518 additions and 76,195 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
1,449 changes: 1,239 additions & 210 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.4.0
7.9.0
608 changes: 515 additions & 93 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/Api/GlobalEzmaxclientApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ $apiInstance = new eZmaxAPI\Api\GlobalEzmaxclientApi(
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$pksEzmaxclientOs = new \eZmaxAPI\Model\FieldPksEzmaxclientOs(); // FieldPksEzmaxclientOs
$pksEzmaxclientOs = new \eZmaxAPI\Model\\eZmaxAPI\Model\FieldPksEzmaxclientOs(); // \eZmaxAPI\Model\FieldPksEzmaxclientOs

try {
$result = $apiInstance->globalEzmaxclientVersionV1($pksEzmaxclientOs);
Expand All @@ -44,7 +44,7 @@ try {

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **pksEzmaxclientOs** | [**FieldPksEzmaxclientOs**](../Model/.md)| | |
| **pksEzmaxclientOs** | [**\eZmaxAPI\Model\FieldPksEzmaxclientOs**](../Model/.md)| | |

### Return type

Expand Down
130 changes: 0 additions & 130 deletions docs/Api/ModuleEzsignApi.md

This file was deleted.

67 changes: 65 additions & 2 deletions docs/Api/ObjectActivesessionApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,73 @@ All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/re

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**activesessionGenerateFederationTokenV1()**](ObjectActivesessionApi.md#activesessionGenerateFederationTokenV1) | **POST** /1/object/activesession/generateFederationToken | Generate a federation token |
| [**activesessionGetCurrentV1()**](ObjectActivesessionApi.md#activesessionGetCurrentV1) | **GET** /1/object/activesession/getCurrent | Get Current Activesession |
| [**activesessionGetListV1()**](ObjectActivesessionApi.md#activesessionGetListV1) | **GET** /1/object/activesession/getList | Retrieve Activesession list |


## `activesessionGenerateFederationTokenV1()`

```php
activesessionGenerateFederationTokenV1($activesessionGenerateFederationTokenV1Request): \eZmaxAPI\Model\ActivesessionGenerateFederationTokenV1Response
```

Generate a federation token



### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectActivesessionApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$activesessionGenerateFederationTokenV1Request = new \eZmaxAPI\Model\ActivesessionGenerateFederationTokenV1Request(); // \eZmaxAPI\Model\ActivesessionGenerateFederationTokenV1Request

try {
$result = $apiInstance->activesessionGenerateFederationTokenV1($activesessionGenerateFederationTokenV1Request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ObjectActivesessionApi->activesessionGenerateFederationTokenV1: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **activesessionGenerateFederationTokenV1Request** | [**\eZmaxAPI\Model\ActivesessionGenerateFederationTokenV1Request**](../Model/ActivesessionGenerateFederationTokenV1Request.md)| | |

### Return type

[**\eZmaxAPI\Model\ActivesessionGenerateFederationTokenV1Response**](../Model/ActivesessionGenerateFederationTokenV1Response.md)

### Authorization

[Authorization](../../README.md#Authorization)

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `activesessionGetCurrentV1()`

```php
Expand Down Expand Up @@ -97,7 +160,7 @@ $apiInstance = new eZmaxAPI\Api\ObjectActivesessionApi(
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\HeaderAcceptLanguage(); // HeaderAcceptLanguage
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
Expand All @@ -115,7 +178,7 @@ try {
| **eOrderBy** | **string**| Specify how you want the results to be sorted | [optional] |
| **iRowMax** | **int**| | [optional] |
| **iRowOffset** | **int**| | [optional] [default to 0] |
| **acceptLanguage** | [**HeaderAcceptLanguage**](../Model/.md)| | [optional] |
| **acceptLanguage** | [**\eZmaxAPI\Model\HeaderAcceptLanguage**](../Model/.md)| | [optional] |
| **sFilter** | **string**| | [optional] |

### Return type
Expand Down
67 changes: 65 additions & 2 deletions docs/Api/ObjectApikeyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/re
| [**apikeyCreateObjectV2()**](ObjectApikeyApi.md#apikeyCreateObjectV2) | **POST** /2/object/apikey | Create a new Apikey |
| [**apikeyEditObjectV1()**](ObjectApikeyApi.md#apikeyEditObjectV1) | **PUT** /1/object/apikey/{pkiApikeyID} | Edit an existing Apikey |
| [**apikeyEditPermissionsV1()**](ObjectApikeyApi.md#apikeyEditPermissionsV1) | **PUT** /1/object/apikey/{pkiApikeyID}/editPermissions | Edit multiple Permissions |
| [**apikeyGenerateDelegatedCredentialsV1()**](ObjectApikeyApi.md#apikeyGenerateDelegatedCredentialsV1) | **POST** /1/object/apikey/generateDelegatedCredentials | Generate a delegated credentials |
| [**apikeyGetCorsV1()**](ObjectApikeyApi.md#apikeyGetCorsV1) | **GET** /1/object/apikey/{pkiApikeyID}/getCors | Retrieve an existing Apikey&#39;s cors |
| [**apikeyGetListV1()**](ObjectApikeyApi.md#apikeyGetListV1) | **GET** /1/object/apikey/getList | Retrieve Apikey list |
| [**apikeyGetObjectV2()**](ObjectApikeyApi.md#apikeyGetObjectV2) | **GET** /2/object/apikey/{pkiApikeyID} | Retrieve an existing Apikey |
Expand Down Expand Up @@ -205,6 +206,68 @@ try {
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apikeyGenerateDelegatedCredentialsV1()`

```php
apikeyGenerateDelegatedCredentialsV1($apikeyGenerateDelegatedCredentialsV1Request): \eZmaxAPI\Model\ApikeyGenerateDelegatedCredentialsV1Response
```

Generate a delegated credentials



### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: Authorization
$config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = eZmaxAPI\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new eZmaxAPI\Api\ObjectApikeyApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$apikeyGenerateDelegatedCredentialsV1Request = new \eZmaxAPI\Model\ApikeyGenerateDelegatedCredentialsV1Request(); // \eZmaxAPI\Model\ApikeyGenerateDelegatedCredentialsV1Request

try {
$result = $apiInstance->apikeyGenerateDelegatedCredentialsV1($apikeyGenerateDelegatedCredentialsV1Request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ObjectApikeyApi->apikeyGenerateDelegatedCredentialsV1: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **apikeyGenerateDelegatedCredentialsV1Request** | [**\eZmaxAPI\Model\ApikeyGenerateDelegatedCredentialsV1Request**](../Model/ApikeyGenerateDelegatedCredentialsV1Request.md)| | |

### Return type

[**\eZmaxAPI\Model\ApikeyGenerateDelegatedCredentialsV1Response**](../Model/ApikeyGenerateDelegatedCredentialsV1Response.md)

### Authorization

[Authorization](../../README.md#Authorization)

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `apikeyGetCorsV1()`

```php
Expand Down Expand Up @@ -297,7 +360,7 @@ $apiInstance = new eZmaxAPI\Api\ObjectApikeyApi(
$eOrderBy = 'eOrderBy_example'; // string | Specify how you want the results to be sorted
$iRowMax = 56; // int
$iRowOffset = 0; // int
$acceptLanguage = new \eZmaxAPI\Model\HeaderAcceptLanguage(); // HeaderAcceptLanguage
$acceptLanguage = new \eZmaxAPI\Model\\eZmaxAPI\Model\HeaderAcceptLanguage(); // \eZmaxAPI\Model\HeaderAcceptLanguage
$sFilter = 'sFilter_example'; // string

try {
Expand All @@ -315,7 +378,7 @@ try {
| **eOrderBy** | **string**| Specify how you want the results to be sorted | [optional] |
| **iRowMax** | **int**| | [optional] |
| **iRowOffset** | **int**| | [optional] [default to 0] |
| **acceptLanguage** | [**HeaderAcceptLanguage**](../Model/.md)| | [optional] |
| **acceptLanguage** | [**\eZmaxAPI\Model\HeaderAcceptLanguage**](../Model/.md)| | [optional] |
| **sFilter** | **string**| | [optional] |

### Return type
Expand Down
Loading

0 comments on commit c47e7f1

Please sign in to comment.