/** * Selling Partner API for Reports * Effective **June 27, 2024**, the Selling Partner API for Reports v2020-09-04 will no longer be available and all calls to it will fail. Integrations that rely on the Reports API must migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * * The version of the OpenAPI document: 2020-09-04 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * The response for the cancelReport operation. * @export * @interface CancelReportResponse */ export interface CancelReportResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CancelReportResponse */ errors?: Array; } /** * The response for the cancelReportSchedule operation. * @export * @interface CancelReportScheduleResponse */ export interface CancelReportScheduleResponse { /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CancelReportScheduleResponse */ errors?: Array; } /** * The response for the createReport operation. * @export * @interface CreateReportResponse */ export interface CreateReportResponse { /** * * @type {CreateReportResult} * @memberof CreateReportResponse */ payload?: CreateReportResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateReportResponse */ errors?: Array; } /** * * @export * @interface CreateReportResult */ export interface CreateReportResult { /** * The identifier for the report. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof CreateReportResult */ reportId: string; } /** * The response for the createReportSchedule operation. * @export * @interface CreateReportScheduleResponse */ export interface CreateReportScheduleResponse { /** * * @type {CreateReportScheduleResult} * @memberof CreateReportScheduleResponse */ payload?: CreateReportScheduleResult; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof CreateReportScheduleResponse */ errors?: Array; } /** * * @export * @interface CreateReportScheduleResult */ export interface CreateReportScheduleResult { /** * The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof CreateReportScheduleResult */ reportScheduleId: string; } /** * * @export * @interface CreateReportScheduleSpecification */ export interface CreateReportScheduleSpecification { /** * The report type. * @type {string} * @memberof CreateReportScheduleSpecification */ reportType: string; /** * A list of marketplace identifiers for the report schedule. * @type {Array} * @memberof CreateReportScheduleSpecification */ marketplaceIds: Array; /** * Additional information passed to reports. This varies by report type. * @type {{ [key: string]: string; }} * @memberof CreateReportScheduleSpecification */ reportOptions?: { [key: string]: string; }; /** * One of a set of predefined ISO 8601 periods that specifies how often a report should be created. * @type {string} * @memberof CreateReportScheduleSpecification */ period: CreateReportScheduleSpecificationPeriodEnum | 'PT5M' | 'PT15M' | 'PT30M' | 'PT1H' | 'PT2H' | 'PT4H' | 'PT8H' | 'PT12H' | 'P1D' | 'P2D' | 'P3D' | 'PT84H' | 'P7D' | 'P14D' | 'P15D' | 'P18D' | 'P30D' | 'P1M'; /** * The date and time when the schedule will create its next report, in ISO 8601 date time format. * @type {string} * @memberof CreateReportScheduleSpecification */ nextReportCreationTime?: string; } /** * @export * @enum {string} */ export declare enum CreateReportScheduleSpecificationPeriodEnum { Pt5M = "PT5M", Pt15M = "PT15M", Pt30M = "PT30M", Pt1H = "PT1H", Pt2H = "PT2H", Pt4H = "PT4H", Pt8H = "PT8H", Pt12H = "PT12H", P1D = "P1D", P2D = "P2D", P3D = "P3D", Pt84H = "PT84H", P7D = "P7D", P14D = "P14D", P15D = "P15D", P18D = "P18D", P30D = "P30D", P1M = "P1M" } /** * * @export * @interface CreateReportSpecification */ export interface CreateReportSpecification { /** * Additional information passed to reports. This varies by report type. * @type {{ [key: string]: string; }} * @memberof CreateReportSpecification */ reportOptions?: { [key: string]: string; }; /** * The report type. * @type {string} * @memberof CreateReportSpecification */ reportType: string; /** * The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this. * @type {string} * @memberof CreateReportSpecification */ dataStartTime?: string; /** * The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this. * @type {string} * @memberof CreateReportSpecification */ dataEndTime?: string; /** * A list of marketplace identifiers. The report document\'s contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise. * @type {Array} * @memberof CreateReportSpecification */ marketplaceIds: Array; } /** * Response schema. * @export * @interface GetReportDocumentResponse */ export interface GetReportDocumentResponse { /** * * @type {ReportDocument} * @memberof GetReportDocumentResponse */ payload?: ReportDocument; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetReportDocumentResponse */ errors?: Array; } /** * The response for the getReport operation. * @export * @interface GetReportResponse */ export interface GetReportResponse { /** * * @type {Report} * @memberof GetReportResponse */ payload?: Report; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetReportResponse */ errors?: Array; } /** * The response for the getReportSchedule operation. * @export * @interface GetReportScheduleResponse */ export interface GetReportScheduleResponse { /** * * @type {ReportSchedule} * @memberof GetReportScheduleResponse */ payload?: ReportSchedule; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetReportScheduleResponse */ errors?: Array; } /** * The response for the getReportSchedules operation. * @export * @interface GetReportSchedulesResponse */ export interface GetReportSchedulesResponse { /** * * @type {Array} * @memberof GetReportSchedulesResponse */ payload?: Array; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetReportSchedulesResponse */ errors?: Array; } /** * The response for the getReports operation. * @export * @interface GetReportsResponse */ export interface GetReportsResponse { /** * * @type {Array} * @memberof GetReportsResponse */ payload?: Array; /** * Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter. * @type {string} * @memberof GetReportsResponse */ nextToken?: string; /** * A list of error responses returned when a request is unsuccessful. * @type {Array} * @memberof GetReportsResponse */ errors?: Array; } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition in a human-readable form. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * * @export * @interface Report */ export interface Report { /** * A list of marketplace identifiers for the report. * @type {Array} * @memberof Report */ marketplaceIds?: Array; /** * The identifier for the report. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof Report */ reportId: string; /** * The report type. * @type {string} * @memberof Report */ reportType: string; /** * The start of a date and time range used for selecting the data to report. * @type {string} * @memberof Report */ dataStartTime?: string; /** * The end of a date and time range used for selecting the data to report. * @type {string} * @memberof Report */ dataEndTime?: string; /** * The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID. * @type {string} * @memberof Report */ reportScheduleId?: string; /** * The date and time when the report was created. * @type {string} * @memberof Report */ createdTime: string; /** * The processing status of the report. * @type {string} * @memberof Report */ processingStatus: ReportProcessingStatusEnum | 'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'; /** * The date and time when the report processing started, in ISO 8601 date time format. * @type {string} * @memberof Report */ processingStartTime?: string; /** * The date and time when the report processing completed, in ISO 8601 date time format. * @type {string} * @memberof Report */ processingEndTime?: 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. * @type {string} * @memberof Report */ reportDocumentId?: string; } /** * @export * @enum {string} */ export declare enum ReportProcessingStatusEnum { Cancelled = "CANCELLED", Done = "DONE", Fatal = "FATAL", InProgress = "IN_PROGRESS", InQueue = "IN_QUEUE" } /** * * @export * @interface ReportDocument */ export interface ReportDocument { /** * The identifier for the report document. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof ReportDocument */ reportDocumentId: string; /** * A presigned URL for the report document. If `compressionAlgorithm` is not returned, you can download the report directly from this URL. This URL expires after 5 minutes. * @type {string} * @memberof ReportDocument */ url: string; /** * * @type {ReportDocumentEncryptionDetails} * @memberof ReportDocument */ encryptionDetails: ReportDocumentEncryptionDetails; /** * If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to [Step 2. Download and decrypt the report](doc:reports-api-v2020-09-04-use-case-guide#step-2-download-and-decrypt-the-report) in the use case guide, where sample code is provided. * @type {string} * @memberof ReportDocument */ compressionAlgorithm?: ReportDocumentCompressionAlgorithmEnum | 'GZIP'; } /** * @export * @enum {string} */ export declare enum ReportDocumentCompressionAlgorithmEnum { Gzip = "GZIP" } /** * Encryption details required for decryption of a report document\'s contents. * @export * @interface ReportDocumentEncryptionDetails */ export interface ReportDocumentEncryptionDetails { /** * The encryption standard required to decrypt the document contents. * @type {string} * @memberof ReportDocumentEncryptionDetails */ standard: ReportDocumentEncryptionDetailsStandardEnum | 'AES'; /** * The vector to decrypt the document contents using Cipher Block Chaining (CBC). * @type {string} * @memberof ReportDocumentEncryptionDetails */ initializationVector: string; /** * The encryption key used to decrypt the document contents. * @type {string} * @memberof ReportDocumentEncryptionDetails */ key: string; } /** * @export * @enum {string} */ export declare enum ReportDocumentEncryptionDetailsStandardEnum { Aes = "AES" } /** * Detailed information about a report schedule. * @export * @interface ReportSchedule */ export interface ReportSchedule { /** * The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof ReportSchedule */ reportScheduleId: string; /** * The report type. * @type {string} * @memberof ReportSchedule */ reportType: string; /** * A list of marketplace identifiers. The report document\'s contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise. * @type {Array} * @memberof ReportSchedule */ marketplaceIds?: Array; /** * Additional information passed to reports. This varies by report type. * @type {{ [key: string]: string; }} * @memberof ReportSchedule */ reportOptions?: { [key: string]: string; }; /** * An ISO 8601 period value that indicates how often a report should be created. * @type {string} * @memberof ReportSchedule */ period: string; /** * The date and time when the schedule will create its next report, in ISO 8601 date time format. * @type {string} * @memberof ReportSchedule */ nextReportCreationTime?: string; } /** * ReportsApi - axios parameter creator * @export */ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Effective **June 27, 2023**, the `cancelReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReport: (reportId: string, options?: any) => Promise; /** * Effective **June 27, 2023**, the `cancelReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReportSchedule: (reportScheduleId: string, options?: any) => Promise; /** * Effective **June 27, 2023**, the `createReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {CreateReportSpecification} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReport: (body: CreateReportSpecification, options?: any) => Promise; /** * Effective **June 27, 2023**, the `createReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {CreateReportScheduleSpecification} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReportSchedule: (body: CreateReportScheduleSpecification, options?: any) => Promise; /** * Effective **June 27, 2023**, the `getReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReport: (reportId: string, options?: any) => Promise; /** * Effective **June 27, 2023**, the `getReportDocument` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportDocumentId The identifier for the report document. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportDocument: (reportDocumentId: string, options?: any) => Promise; /** * Effective **June 27, 2023**, the `getReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportSchedule: (reportScheduleId: string, options?: any) => Promise; /** * Effective **June 27, 2023**, the `getReportSchedules` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {Array} reportTypes A list of report types used to filter report schedules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportSchedules: (reportTypes: Array, options?: any) => Promise; /** * Effective **June 27, 2023**, the `getReports` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {Array} [reportTypes] A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. * @param {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>} [processingStatuses] A list of processing statuses used to filter reports. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of reports to return in a single call. * @param {string} [createdSince] The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. * @param {string} [createdUntil] The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. * @param {string} [nextToken] A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReports: (reportTypes?: Array, processingStatuses?: Array<"CANCELLED" | "DONE" | "FATAL" | "IN_PROGRESS" | "IN_QUEUE">, marketplaceIds?: Array, pageSize?: number, createdSince?: string, createdUntil?: string, nextToken?: string, options?: any) => Promise; }; /** * ReportsApi - functional programming interface * @export */ export declare const ReportsApiFp: (configuration?: Configuration) => { /** * Effective **June 27, 2023**, the `cancelReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReport(reportId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `cancelReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReportSchedule(reportScheduleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `createReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {CreateReportSpecification} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReport(body: CreateReportSpecification, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `createReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {CreateReportScheduleSpecification} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReportSchedule(body: CreateReportScheduleSpecification, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `getReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReport(reportId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `getReportDocument` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportDocumentId The identifier for the report document. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportDocument(reportDocumentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `getReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportSchedule(reportScheduleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `getReportSchedules` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {Array} reportTypes A list of report types used to filter report schedules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportSchedules(reportTypes: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Effective **June 27, 2023**, the `getReports` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {Array} [reportTypes] A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. * @param {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>} [processingStatuses] A list of processing statuses used to filter reports. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of reports to return in a single call. * @param {string} [createdSince] The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. * @param {string} [createdUntil] The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. * @param {string} [nextToken] A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReports(reportTypes?: Array, processingStatuses?: Array<"CANCELLED" | "DONE" | "FATAL" | "IN_PROGRESS" | "IN_QUEUE">, marketplaceIds?: Array, pageSize?: number, createdSince?: string, createdUntil?: string, nextToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReportsApi - factory interface * @export */ export declare const ReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Effective **June 27, 2023**, the `cancelReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReport(reportId: string, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `cancelReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelReportSchedule(reportScheduleId: string, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `createReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {CreateReportSpecification} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReport(body: CreateReportSpecification, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `createReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {CreateReportScheduleSpecification} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createReportSchedule(body: CreateReportScheduleSpecification, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `getReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportId The identifier for the report. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReport(reportId: string, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `getReportDocument` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportDocumentId The identifier for the report document. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportDocument(reportDocumentId: string, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `getReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {string} reportScheduleId The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportSchedule(reportScheduleId: string, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `getReportSchedules` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {Array} reportTypes A list of report types used to filter report schedules. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReportSchedules(reportTypes: Array, options?: any): AxiosPromise; /** * Effective **June 27, 2023**, the `getReports` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {Array} [reportTypes] A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. * @param {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>} [processingStatuses] A list of processing statuses used to filter reports. * @param {Array} [marketplaceIds] A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. * @param {number} [pageSize] The maximum number of reports to return in a single call. * @param {string} [createdSince] The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. * @param {string} [createdUntil] The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. * @param {string} [nextToken] A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReports(reportTypes?: Array, processingStatuses?: Array<"CANCELLED" | "DONE" | "FATAL" | "IN_PROGRESS" | "IN_QUEUE">, marketplaceIds?: Array, pageSize?: number, createdSince?: string, createdUntil?: string, nextToken?: string, options?: any): AxiosPromise; }; /** * Request parameters for cancelReport operation in ReportsApi. * @export * @interface ReportsApiCancelReportRequest */ export interface ReportsApiCancelReportRequest { /** * The identifier for the report. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof ReportsApiCancelReport */ readonly reportId: string; } /** * Request parameters for cancelReportSchedule operation in ReportsApi. * @export * @interface ReportsApiCancelReportScheduleRequest */ export interface ReportsApiCancelReportScheduleRequest { /** * The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof ReportsApiCancelReportSchedule */ readonly reportScheduleId: string; } /** * Request parameters for createReport operation in ReportsApi. * @export * @interface ReportsApiCreateReportRequest */ export interface ReportsApiCreateReportRequest { /** * * @type {CreateReportSpecification} * @memberof ReportsApiCreateReport */ readonly body: CreateReportSpecification; } /** * Request parameters for createReportSchedule operation in ReportsApi. * @export * @interface ReportsApiCreateReportScheduleRequest */ export interface ReportsApiCreateReportScheduleRequest { /** * * @type {CreateReportScheduleSpecification} * @memberof ReportsApiCreateReportSchedule */ readonly body: CreateReportScheduleSpecification; } /** * Request parameters for getReport operation in ReportsApi. * @export * @interface ReportsApiGetReportRequest */ export interface ReportsApiGetReportRequest { /** * The identifier for the report. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof ReportsApiGetReport */ readonly reportId: string; } /** * Request parameters for getReportDocument operation in ReportsApi. * @export * @interface ReportsApiGetReportDocumentRequest */ export interface ReportsApiGetReportDocumentRequest { /** * The identifier for the report document. * @type {string} * @memberof ReportsApiGetReportDocument */ readonly reportDocumentId: string; } /** * Request parameters for getReportSchedule operation in ReportsApi. * @export * @interface ReportsApiGetReportScheduleRequest */ export interface ReportsApiGetReportScheduleRequest { /** * The identifier for the report schedule. This identifier is unique only in combination with a seller ID. * @type {string} * @memberof ReportsApiGetReportSchedule */ readonly reportScheduleId: string; } /** * Request parameters for getReportSchedules operation in ReportsApi. * @export * @interface ReportsApiGetReportSchedulesRequest */ export interface ReportsApiGetReportSchedulesRequest { /** * A list of report types used to filter report schedules. * @type {Array} * @memberof ReportsApiGetReportSchedules */ readonly reportTypes: Array; } /** * Request parameters for getReports operation in ReportsApi. * @export * @interface ReportsApiGetReportsRequest */ export interface ReportsApiGetReportsRequest { /** * A list of report types used to filter reports. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required. * @type {Array} * @memberof ReportsApiGetReports */ readonly reportTypes?: Array; /** * A list of processing statuses used to filter reports. * @type {Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>} * @memberof ReportsApiGetReports */ readonly processingStatuses?: Array<'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE'>; /** * A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify. * @type {Array} * @memberof ReportsApiGetReports */ readonly marketplaceIds?: Array; /** * The maximum number of reports to return in a single call. * @type {number} * @memberof ReportsApiGetReports */ readonly pageSize?: number; /** * The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days. * @type {string} * @memberof ReportsApiGetReports */ readonly createdSince?: string; /** * The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now. * @type {string} * @memberof ReportsApiGetReports */ readonly createdUntil?: string; /** * A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. * @type {string} * @memberof ReportsApiGetReports */ readonly nextToken?: string; } /** * ReportsApi - object-oriented interface * @export * @class ReportsApi * @extends {BaseAPI} */ export declare class ReportsApi extends BaseAPI { /** * Effective **June 27, 2023**, the `cancelReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiCancelReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ cancelReport(requestParameters: ReportsApiCancelReportRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `cancelReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiCancelReportScheduleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ cancelReportSchedule(requestParameters: ReportsApiCancelReportScheduleRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `createReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiCreateReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ createReport(requestParameters: ReportsApiCreateReportRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `createReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiCreateReportScheduleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ createReportSchedule(requestParameters: ReportsApiCreateReportScheduleRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `getReport` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiGetReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ getReport(requestParameters: ReportsApiGetReportRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `getReportDocument` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiGetReportDocumentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ getReportDocument(requestParameters: ReportsApiGetReportDocumentRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `getReportSchedule` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiGetReportScheduleRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ getReportSchedule(requestParameters: ReportsApiGetReportScheduleRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `getReportSchedules` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiGetReportSchedulesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ getReportSchedules(requestParameters: ReportsApiGetReportSchedulesRequest, options?: any): Promise>; /** * Effective **June 27, 2023**, the `getReports` operation will no longer be available in the Selling Partner API for Reports v2020-09-04 and all calls to it will fail. Integrations that rely on this operation should migrate to [Reports v2021-06-30](https://developer-docs.amazon.com/sp-api/docs/reports-api-v2021-06-30-reference) to avoid service disruption. * @param {ReportsApiGetReportsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ getReports(requestParameters?: ReportsApiGetReportsRequest, options?: any): Promise>; }