Skip to content
This repository was archived by the owner on Sep 3, 2024. It is now read-only.

Commit 7ba70fc

Browse files
p-zielinskip-zielinski
committed
regenerate
1 parent 7e41484 commit 7ba70fc

File tree

956 files changed

+40014
-64456
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

956 files changed

+40014
-64456
lines changed

‎.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,3 @@ build/phplint.cache
2828
/test-requirements.txt
2929
/.env
3030
/.idea/
31-
/__tests__/_generated/
32-
/__tests__/_output/
33-
/__tests__/Support/

‎README.md

Lines changed: 47 additions & 238 deletions
Large diffs are not rendered by default.

‎composer.json

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,15 @@
2626
"guzzlehttp/psr7": "^2.0"
2727
},
2828
"require-dev": {
29-
"codeception/codeception": "5.0.13",
30-
"codeception/module-asserts": "*"
29+
"friendsofphp/php-cs-fixer": "^3.5",
30+
"overtrue/phplint": "^9.0",
31+
"phpunit/phpunit": "^9.0"
3132
},
3233
"autoload": {
33-
"psr-4": {
34-
"OpenAPI\\Client\\": "src/"
35-
}
34+
"psr-4": { "OpenAPI\\Client\\" : "src/" }
3635
},
3736
"autoload-dev": {
38-
"psr-4": {
39-
"OpenAPI\\Client\\Test\\": "tests/"
40-
}
37+
"psr-4": { "OpenAPI\\Client\\Test\\" : "tests/" }
4138
},
4239
"scripts": {
4340
"test": [

‎docs/Api/AsyncActionsApi.md

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
# OpenAPI\Client\AsyncActionsApi
2+
3+
All URIs are relative to https://api.voucherify.io, except if the operation defines another base path.
4+
5+
| Method | HTTP request | Description |
6+
| ------------- | ------------- | ------------- |
7+
| [**getAsyncAction()**](AsyncActionsApi.md#getAsyncAction) | **GET** /v1/async-actions/{asyncActionId} | Get Async Action |
8+
| [**listAsyncActions()**](AsyncActionsApi.md#listAsyncActions) | **GET** /v1/async-actions | List Async Actions |
9+
10+
11+
## `getAsyncAction()`
12+
13+
```php
14+
getAsyncAction($async_action_id): \OpenAPI\Client\Model\AsyncActionGetResponseBody
15+
```
16+
17+
Get Async Action
18+
19+
Check the result of a scheduled asynchronous operation. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).
20+
21+
### Example
22+
23+
```php
24+
<?php
25+
require_once(__DIR__ . '/vendor/autoload.php');
26+
27+
28+
// Configure API key authorization: X-App-Id
29+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
30+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
31+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
32+
33+
// Configure API key authorization: X-App-Token
34+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
35+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
36+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
37+
38+
39+
$apiInstance = new OpenAPI\Client\Api\AsyncActionsApi(
40+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
41+
// This is optional, `GuzzleHttp\Client` will be used as default.
42+
new GuzzleHttp\Client(),
43+
$config
44+
);
45+
$async_action_id = 'async_action_id_example'; // string | Unique ID of the asynchronous operation.
46+
47+
try {
48+
$result = $apiInstance->getAsyncAction($async_action_id);
49+
print_r($result);
50+
} catch (Exception $e) {
51+
echo 'Exception when calling AsyncActionsApi->getAsyncAction: ', $e->getMessage(), PHP_EOL;
52+
}
53+
```
54+
55+
### Parameters
56+
57+
| Name | Type | Description | Notes |
58+
| ------------- | ------------- | ------------- | ------------- |
59+
| **async_action_id** | **string**| Unique ID of the asynchronous operation. | |
60+
61+
### Return type
62+
63+
[**\OpenAPI\Client\Model\AsyncActionGetResponseBody**](../Model/AsyncActionGetResponseBody.md)
64+
65+
### Authorization
66+
67+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
68+
69+
### HTTP request headers
70+
71+
- **Content-Type**: Not defined
72+
- **Accept**: `application/json`
73+
74+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
75+
[[Back to Model list]](../../README.md#models)
76+
[[Back to README]](../../README.md)
77+
78+
## `listAsyncActions()`
79+
80+
```php
81+
listAsyncActions($limit, $end_date): \OpenAPI\Client\Model\AsyncActionsListResponseBody
82+
```
83+
84+
List Async Actions
85+
86+
Track asynchronous operations scheduled in your project. The table below lists the possible types of async actions. The types are different for each endpoint generating the async action. If you would like to learn more about importing data into Voucherify, read more [here](https://support.voucherify.io/article/574-data-import).
87+
88+
### Example
89+
90+
```php
91+
<?php
92+
require_once(__DIR__ . '/vendor/autoload.php');
93+
94+
95+
// Configure API key authorization: X-App-Id
96+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
97+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
98+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
99+
100+
// Configure API key authorization: X-App-Token
101+
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
102+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
103+
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
104+
105+
106+
$apiInstance = new OpenAPI\Client\Api\AsyncActionsApi(
107+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
108+
// This is optional, `GuzzleHttp\Client` will be used as default.
109+
new GuzzleHttp\Client(),
110+
$config
111+
);
112+
$limit = 56; // int | Limit the number of asynchronous actions that the API returns in the response.
113+
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16).
114+
115+
try {
116+
$result = $apiInstance->listAsyncActions($limit, $end_date);
117+
print_r($result);
118+
} catch (Exception $e) {
119+
echo 'Exception when calling AsyncActionsApi->listAsyncActions: ', $e->getMessage(), PHP_EOL;
120+
}
121+
```
122+
123+
### Parameters
124+
125+
| Name | Type | Description | Notes |
126+
| ------------- | ------------- | ------------- | ------------- |
127+
| **limit** | **int**| Limit the number of asynchronous actions that the API returns in the response. | [optional] |
128+
| **end_date** | **\DateTime**| Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). | [optional] |
129+
130+
### Return type
131+
132+
[**\OpenAPI\Client\Model\AsyncActionsListResponseBody**](../Model/AsyncActionsListResponseBody.md)
133+
134+
### Authorization
135+
136+
[X-App-Id](../../README.md#X-App-Id), [X-App-Token](../../README.md#X-App-Token)
137+
138+
### HTTP request headers
139+
140+
- **Content-Type**: Not defined
141+
- **Accept**: `application/json`
142+
143+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
144+
[[Back to Model list]](../../README.md#models)
145+
[[Back to README]](../../README.md)

0 commit comments

Comments
 (0)