|
7 | 7 |
|
8 | 8 | * [list](#list) - List executions for report |
9 | 9 | * [url](#url) - Create URL for executed report |
| 10 | +* [all](#all) - List executed reports |
| 11 | +* [get](#get) - Get executed report |
10 | 12 |
|
11 | 13 | ## list |
12 | 14 |
|
13 | | -List all executed reports that have been generated. |
| 15 | +List all executions of a specific report. |
14 | 16 |
|
15 | 17 | ### Example Usage |
16 | 18 |
|
@@ -122,6 +124,128 @@ if ($response->reportExecutionUrl !== null) { |
122 | 124 |
|
123 | 125 | ### Errors |
124 | 126 |
|
| 127 | +| Error Type | Status Code | Content Type | |
| 128 | +| -------------------------- | -------------------------- | -------------------------- | |
| 129 | +| errors\Error400 | 400 | application/json | |
| 130 | +| errors\Error401 | 401 | application/json | |
| 131 | +| errors\Error403 | 403 | application/json | |
| 132 | +| errors\Error404 | 404 | application/json | |
| 133 | +| errors\Error405 | 405 | application/json | |
| 134 | +| errors\Error409 | 409 | application/json | |
| 135 | +| errors\HTTPValidationError | 422 | application/json | |
| 136 | +| errors\Error425 | 425 | application/json | |
| 137 | +| errors\Error429 | 429 | application/json | |
| 138 | +| errors\Error500 | 500 | application/json | |
| 139 | +| errors\Error502 | 502 | application/json | |
| 140 | +| errors\Error504 | 504 | application/json | |
| 141 | +| errors\APIException | 4XX, 5XX | \*/\* | |
| 142 | + |
| 143 | +## all |
| 144 | + |
| 145 | +List all executed reports that have been generated. |
| 146 | + |
| 147 | +### Example Usage |
| 148 | + |
| 149 | +```php |
| 150 | +declare(strict_types=1); |
| 151 | + |
| 152 | +require 'vendor/autoload.php'; |
| 153 | + |
| 154 | +use Gr4vy; |
| 155 | + |
| 156 | +$sdk = Gr4vy\SDK::builder() |
| 157 | + ->setMerchantAccountId('default') |
| 158 | + ->setSecurity( |
| 159 | + '<YOUR_BEARER_TOKEN_HERE>' |
| 160 | + ) |
| 161 | + ->build(); |
| 162 | + |
| 163 | +$request = new Gr4vy\ListAllReportExecutionsRequest(); |
| 164 | + |
| 165 | +$responses = $sdk->reports->executions->all( |
| 166 | + request: $request |
| 167 | +); |
| 168 | + |
| 169 | + |
| 170 | +foreach ($responses as $response) { |
| 171 | + if ($response->statusCode === 200) { |
| 172 | + // handle response |
| 173 | + } |
| 174 | +} |
| 175 | +``` |
| 176 | + |
| 177 | +### Parameters |
| 178 | + |
| 179 | +| Parameter | Type | Required | Description | |
| 180 | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | |
| 181 | +| `$request` | [Gr4vy\ListAllReportExecutionsRequest](../../ListAllReportExecutionsRequest.md) | :heavy_check_mark: | The request object to use for the request. | |
| 182 | + |
| 183 | +### Response |
| 184 | + |
| 185 | +**[?ListAllReportExecutionsResponse](../../ListAllReportExecutionsResponse.md)** |
| 186 | + |
| 187 | +### Errors |
| 188 | + |
| 189 | +| Error Type | Status Code | Content Type | |
| 190 | +| -------------------------- | -------------------------- | -------------------------- | |
| 191 | +| errors\Error400 | 400 | application/json | |
| 192 | +| errors\Error401 | 401 | application/json | |
| 193 | +| errors\Error403 | 403 | application/json | |
| 194 | +| errors\Error404 | 404 | application/json | |
| 195 | +| errors\Error405 | 405 | application/json | |
| 196 | +| errors\Error409 | 409 | application/json | |
| 197 | +| errors\HTTPValidationError | 422 | application/json | |
| 198 | +| errors\Error425 | 425 | application/json | |
| 199 | +| errors\Error429 | 429 | application/json | |
| 200 | +| errors\Error500 | 500 | application/json | |
| 201 | +| errors\Error502 | 502 | application/json | |
| 202 | +| errors\Error504 | 504 | application/json | |
| 203 | +| errors\APIException | 4XX, 5XX | \*/\* | |
| 204 | + |
| 205 | +## get |
| 206 | + |
| 207 | +Fetch a specific executed report. |
| 208 | + |
| 209 | +### Example Usage |
| 210 | + |
| 211 | +```php |
| 212 | +declare(strict_types=1); |
| 213 | + |
| 214 | +require 'vendor/autoload.php'; |
| 215 | + |
| 216 | +use Gr4vy; |
| 217 | + |
| 218 | +$sdk = Gr4vy\SDK::builder() |
| 219 | + ->setMerchantAccountId('default') |
| 220 | + ->setSecurity( |
| 221 | + '<YOUR_BEARER_TOKEN_HERE>' |
| 222 | + ) |
| 223 | + ->build(); |
| 224 | + |
| 225 | + |
| 226 | + |
| 227 | +$response = $sdk->reports->executions->get( |
| 228 | + reportExecutionId: '003bc416-f32a-420c-8eb2-062a386e1fb0' |
| 229 | +); |
| 230 | + |
| 231 | +if ($response->reportExecution !== null) { |
| 232 | + // handle response |
| 233 | +} |
| 234 | +``` |
| 235 | + |
| 236 | +### Parameters |
| 237 | + |
| 238 | +| Parameter | Type | Required | Description | Example | |
| 239 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | |
| 240 | +| `reportExecutionId` | *string* | :heavy_check_mark: | The ID of the execution of a report to retrieve details for. | 003bc416-f32a-420c-8eb2-062a386e1fb0 | |
| 241 | +| `merchantAccountId` | *?string* | :heavy_minus_sign: | The ID of the merchant account to use for this request. | default | |
| 242 | + |
| 243 | +### Response |
| 244 | + |
| 245 | +**[?GetReportExecutionResponse](../../GetReportExecutionResponse.md)** |
| 246 | + |
| 247 | +### Errors |
| 248 | + |
125 | 249 | | Error Type | Status Code | Content Type | |
126 | 250 | | -------------------------- | -------------------------- | -------------------------- | |
127 | 251 | | errors\Error400 | 400 | application/json | |
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments