Skip to content

Commit

Permalink
Update to latest Reports API
Browse files Browse the repository at this point in the history
  • Loading branch information
jlevers committed Aug 10, 2021
1 parent 6d236fe commit 50a82e8
Show file tree
Hide file tree
Showing 16 changed files with 343 additions and 773 deletions.
54 changes: 25 additions & 29 deletions docs/Api/ReportsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancelReport()**](ReportsApi.md#cancelReport) | **DELETE** /reports/2020-09-04/reports/{reportId} |
[**cancelReportSchedule()**](ReportsApi.md#cancelReportSchedule) | **DELETE** /reports/2020-09-04/schedules/{reportScheduleId} |
[**createReport()**](ReportsApi.md#createReport) | **POST** /reports/2020-09-04/reports |
[**createReportSchedule()**](ReportsApi.md#createReportSchedule) | **POST** /reports/2020-09-04/schedules |
[**getReport()**](ReportsApi.md#getReport) | **GET** /reports/2020-09-04/reports/{reportId} |
[**getReportDocument()**](ReportsApi.md#getReportDocument) | **GET** /reports/2020-09-04/documents/{reportDocumentId} |
[**getReportSchedule()**](ReportsApi.md#getReportSchedule) | **GET** /reports/2020-09-04/schedules/{reportScheduleId} |
[**getReportSchedules()**](ReportsApi.md#getReportSchedules) | **GET** /reports/2020-09-04/schedules |
[**getReports()**](ReportsApi.md#getReports) | **GET** /reports/2020-09-04/reports |
[**cancelReport()**](ReportsApi.md#cancelReport) | **DELETE** /reports/2021-06-30/reports/{reportId} |
[**cancelReportSchedule()**](ReportsApi.md#cancelReportSchedule) | **DELETE** /reports/2021-06-30/schedules/{reportScheduleId} |
[**createReport()**](ReportsApi.md#createReport) | **POST** /reports/2021-06-30/reports |
[**createReportSchedule()**](ReportsApi.md#createReportSchedule) | **POST** /reports/2021-06-30/schedules |
[**getReport()**](ReportsApi.md#getReport) | **GET** /reports/2021-06-30/reports/{reportId} |
[**getReportDocument()**](ReportsApi.md#getReportDocument) | **GET** /reports/2021-06-30/documents/{reportDocumentId} |
[**getReportSchedule()**](ReportsApi.md#getReportSchedule) | **GET** /reports/2021-06-30/schedules/{reportScheduleId} |
[**getReportSchedules()**](ReportsApi.md#getReportSchedules) | **GET** /reports/2021-06-30/schedules |
[**getReports()**](ReportsApi.md#getReports) | **GET** /reports/2021-06-30/reports |


## `cancelReport()`

```php
cancelReport($report_id): \SellingPartnerApi\Model\Reports\CancelReportResponse
cancelReport($report_id)
```


Expand Down Expand Up @@ -51,8 +51,7 @@ $apiInstance = new SellingPartnerApi\Api\ReportsApi($config);
$report_id = 'report_id_example'; // string | The identifier for the report. This identifier is unique only in combination with a seller ID.

try {
$result = $apiInstance->cancelReport($report_id);
print_r($result);
$apiInstance->cancelReport($report_id);
} catch (Exception $e) {
echo 'Exception when calling ReportsApi->cancelReport: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -66,7 +65,7 @@ Name | Type | Description | Notes

### Return type

[**\SellingPartnerApi\Model\Reports\CancelReportResponse**](../Model/Reports/CancelReportResponse.md)
void (empty response body)

### HTTP request headers

Expand All @@ -80,7 +79,7 @@ Name | Type | Description | Notes
## `cancelReportSchedule()`

```php
cancelReportSchedule($report_schedule_id): \SellingPartnerApi\Model\Reports\CancelReportScheduleResponse
cancelReportSchedule($report_schedule_id)
```


Expand Down Expand Up @@ -115,8 +114,7 @@ $apiInstance = new SellingPartnerApi\Api\ReportsApi($config);
$report_schedule_id = 'report_schedule_id_example'; // string | The identifier for the report schedule. This identifier is unique only in combination with a seller ID.

try {
$result = $apiInstance->cancelReportSchedule($report_schedule_id);
print_r($result);
$apiInstance->cancelReportSchedule($report_schedule_id);
} catch (Exception $e) {
echo 'Exception when calling ReportsApi->cancelReportSchedule: ', $e->getMessage(), PHP_EOL;
}
Expand All @@ -130,7 +128,7 @@ Name | Type | Description | Notes

### Return type

[**\SellingPartnerApi\Model\Reports\CancelReportScheduleResponse**](../Model/Reports/CancelReportScheduleResponse.md)
void (empty response body)

### HTTP request headers

Expand Down Expand Up @@ -272,7 +270,7 @@ Name | Type | Description | Notes
## `getReport()`

```php
getReport($report_id): \SellingPartnerApi\Model\Reports\GetReportResponse
getReport($report_id): \SellingPartnerApi\Model\Reports\Report
```


Expand Down Expand Up @@ -322,7 +320,7 @@ Name | Type | Description | Notes

### Return type

[**\SellingPartnerApi\Model\Reports\GetReportResponse**](../Model/Reports/GetReportResponse.md)
[**\SellingPartnerApi\Model\Reports\Report**](../Model/Reports/Report.md)

### HTTP request headers

Expand All @@ -336,12 +334,12 @@ Name | Type | Description | Notes
## `getReportDocument()`

```php
getReportDocument($report_document_id, $report_type): \SellingPartnerApi\Model\Reports\GetReportDocumentResponse
getReportDocument($report_document_id): \SellingPartnerApi\Model\Reports\ReportDocument
```



Returns the information required for retrieving a report document's contents. This includes a presigned URL for the report document as well as the information required to decrypt the document's contents.
Returns the information required for retrieving a report document's contents.

**Usage Plan:**

Expand Down Expand Up @@ -369,10 +367,9 @@ $config = new SellingPartnerApi\Configuration([

$apiInstance = new SellingPartnerApi\Api\ReportsApi($config);
$report_document_id = 'report_document_id_example'; // string | The identifier for the report document.
$report_type = 'report_type_example'; // string | The name of the document's report type.

try {
$result = $apiInstance->getReportDocument($report_document_id, $report_type);
$result = $apiInstance->getReportDocument($report_document_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ReportsApi->getReportDocument: ', $e->getMessage(), PHP_EOL;
Expand All @@ -384,11 +381,10 @@ try {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**report_document_id** | **string**| The identifier for the report document. |
**report_type** | **string**| The name of the document's report type. | [optional]

### Return type

[**\SellingPartnerApi\Model\Reports\GetReportDocumentResponse**](../Model/Reports/GetReportDocumentResponse.md)
[**\SellingPartnerApi\Model\Reports\ReportDocument**](../Model/Reports/ReportDocument.md)

### HTTP request headers

Expand All @@ -402,7 +398,7 @@ Name | Type | Description | Notes
## `getReportSchedule()`

```php
getReportSchedule($report_schedule_id): \SellingPartnerApi\Model\Reports\GetReportScheduleResponse
getReportSchedule($report_schedule_id): \SellingPartnerApi\Model\Reports\ReportSchedule
```


Expand Down Expand Up @@ -452,7 +448,7 @@ Name | Type | Description | Notes

### Return type

[**\SellingPartnerApi\Model\Reports\GetReportScheduleResponse**](../Model/Reports/GetReportScheduleResponse.md)
[**\SellingPartnerApi\Model\Reports\ReportSchedule**](../Model/Reports/ReportSchedule.md)

### HTTP request headers

Expand All @@ -466,7 +462,7 @@ Name | Type | Description | Notes
## `getReportSchedules()`

```php
getReportSchedules($report_types): \SellingPartnerApi\Model\Reports\GetReportSchedulesResponse
getReportSchedules($report_types): \SellingPartnerApi\Model\Reports\ReportScheduleList
```


Expand Down Expand Up @@ -516,7 +512,7 @@ Name | Type | Description | Notes

### Return type

[**\SellingPartnerApi\Model\Reports\GetReportSchedulesResponse**](../Model/Reports/GetReportSchedulesResponse.md)
[**\SellingPartnerApi\Model\Reports\ReportScheduleList**](../Model/Reports/ReportScheduleList.md)

### HTTP request headers

Expand Down
3 changes: 1 addition & 2 deletions docs/Model/Reports/CreateReportResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**payload** | [**\SellingPartnerApi\Model\Reports\CreateReportResult**](CreateReportResult.md) | | [optional]
**errors** | [**\SellingPartnerApi\Model\Reports\Error[]**](Error.md) | A list of error responses returned when a request is unsuccessful. | [optional]
**report_id** | **string** | The identifier for the report. This identifier is unique only in combination with a seller ID. |

[[Reports Models]](../) [[API list]](../../Api) [[README]](../../../README.md)
3 changes: 1 addition & 2 deletions docs/Model/Reports/CreateReportScheduleResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**payload** | [**\SellingPartnerApi\Model\Reports\CreateReportScheduleResult**](CreateReportScheduleResult.md) | | [optional]
**errors** | [**\SellingPartnerApi\Model\Reports\Error[]**](Error.md) | A list of error responses returned when a request is unsuccessful. | [optional]
**report_schedule_id** | **string** | The identifier for the report schedule. This identifier is unique only in combination with a seller ID. |

[[Reports Models]](../) [[API list]](../../Api) [[README]](../../../README.md)
3 changes: 1 addition & 2 deletions docs/Model/Reports/GetReportsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**payload** | [**\SellingPartnerApi\Model\Reports\Report[]**](Report.md) | | [optional]
**reports** | [**\SellingPartnerApi\Model\Reports\Report[]**](Report.md) | |
**next_token** | **string** | Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter. | [optional]
**errors** | [**\SellingPartnerApi\Model\Reports\Error[]**](Error.md) | A list of error responses returned when a request is unsuccessful. | [optional]

[[Reports Models]](../) [[API list]](../../Api) [[README]](../../../README.md)
2 changes: 1 addition & 1 deletion docs/Model/Reports/Report.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ Name | Type | Description | Notes
**processing_status** | **string** | The processing status of the report. |
**processing_start_time** | [**\DateTime**](\DateTime.md) | The date and time when the report processing started, in ISO 8601 date time format. | [optional]
**processing_end_time** | [**\DateTime**](\DateTime.md) | The date and time when the report processing completed, in ISO 8601 date time format. | [optional]
**report_document_id** | **string** | The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents. | [optional]
**report_document_id** | **string** | The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve the report document's contents. | [optional]

[[Reports Models]](../) [[API list]](../../Api) [[README]](../../../README.md)
1 change: 0 additions & 1 deletion docs/Model/Reports/ReportDocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**report_document_id** | **string** | The identifier for the report document. This identifier is unique only in combination with a seller ID. |
**url** | **string** | A presigned URL for the report document. This URL expires after 5 minutes. |
**encryption_details** | [**\SellingPartnerApi\Model\Reports\ReportDocumentEncryptionDetails**](ReportDocumentEncryptionDetails.md) | |
**compression_algorithm** | **string** | If present, the report document contents have been compressed with the provided algorithm. | [optional]

[[Reports Models]](../) [[API list]](../../Api) [[README]](../../../README.md)
Loading

0 comments on commit 50a82e8

Please sign in to comment.