Function ReportsApiFactory

ReportsApi - factory interface

Export

ReportsApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    cancelReport(
        requestParameters: ReportsApiCancelReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReportResponse>;
    cancelReportSchedule(
        requestParameters: ReportsApiCancelReportScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReportScheduleResponse>;
    createReport(
        requestParameters: ReportsApiCreateReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReportResponse>;
    createReportSchedule(
        requestParameters: ReportsApiCreateReportScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReportScheduleResponse>;
    getReport(
        requestParameters: ReportsApiGetReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportResponse>;
    getReportDocument(
        requestParameters: ReportsApiGetReportDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportDocumentResponse>;
    getReports(
        requestParameters?: ReportsApiGetReportsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportsResponse>;
    getReportSchedule(
        requestParameters: ReportsApiGetReportScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportScheduleResponse>;
    getReportSchedules(
        requestParameters: ReportsApiGetReportSchedulesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportSchedulesResponse>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    cancelReport(
        requestParameters: ReportsApiCancelReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReportResponse>;
    cancelReportSchedule(
        requestParameters: ReportsApiCancelReportScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReportScheduleResponse>;
    createReport(
        requestParameters: ReportsApiCreateReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReportResponse>;
    createReportSchedule(
        requestParameters: ReportsApiCreateReportScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReportScheduleResponse>;
    getReport(
        requestParameters: ReportsApiGetReportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportResponse>;
    getReportDocument(
        requestParameters: ReportsApiGetReportDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportDocumentResponse>;
    getReports(
        requestParameters?: ReportsApiGetReportsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportsResponse>;
    getReportSchedule(
        requestParameters: ReportsApiGetReportScheduleRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportScheduleResponse>;
    getReportSchedules(
        requestParameters: ReportsApiGetReportSchedulesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportSchedulesResponse>;
}
- cancelReport:function
  - cancelReport(
    requestParameters: ReportsApiCancelReportRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReportResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiCancelReportRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CancelReportResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:550
- cancelReportSchedule:function
  - cancelReportSchedule(
    requestParameters: ReportsApiCancelReportScheduleRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CancelReportScheduleResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiCancelReportScheduleRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CancelReportScheduleResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:560
- createReport:function
  - createReport(
    requestParameters: ReportsApiCreateReportRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReportResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiCreateReportRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateReportResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:570
- createReportSchedule:function
  - createReportSchedule(
    requestParameters: ReportsApiCreateReportScheduleRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateReportScheduleResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiCreateReportScheduleRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateReportScheduleResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:580
- getReport:function
  - getReport(
    requestParameters: ReportsApiGetReportRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiGetReportRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetReportResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:590
- getReportDocument:function
  - getReportDocument(
    requestParameters: ReportsApiGetReportDocumentRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportDocumentResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiGetReportDocumentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetReportDocumentResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:600
- getReports:function
  - getReports(
    requestParameters?: ReportsApiGetReportsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportsResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiGetReportsRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetReportsResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:630
- getReportSchedule:function
  - getReportSchedule(
    requestParameters: ReportsApiGetReportScheduleRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportScheduleResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiGetReportScheduleRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetReportScheduleResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:610
- getReportSchedules:function
  - getReportSchedules(
    requestParameters: ReportsApiGetReportSchedulesRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetReportSchedulesResponse>
  - 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 to avoid service disruption.
    Parameters
    - requestParameters: ReportsApiGetReportSchedulesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetReportSchedulesResponse>
    Deprecated
    Throws
    - Defined in api-model/api/reports-api.ts:620
- Defined in api-model/api/reports-api.ts:540

Function ReportsApiFactory

Export

Parameters

cancelReport:function

Parameters

Returns AxiosPromise<CancelReportResponse>

Deprecated

Throws

cancelReportSchedule:function

Parameters

Returns AxiosPromise<CancelReportScheduleResponse>

Deprecated

Throws

createReport:function

Parameters

Returns AxiosPromise<CreateReportResponse>

Deprecated

Throws

createReportSchedule:function

Parameters

Returns AxiosPromise<CreateReportScheduleResponse>

Deprecated

Throws

getReport:function

Parameters

Returns AxiosPromise<GetReportResponse>

Deprecated

Throws

getReportDocument:function

Parameters

Returns AxiosPromise<GetReportDocumentResponse>

Deprecated

Throws

getReports:function

Parameters

Returns AxiosPromise<GetReportsResponse>

Deprecated

Throws

getReportSchedule:function

Parameters

Returns AxiosPromise<GetReportScheduleResponse>

Deprecated

Throws

getReportSchedules:function

Parameters

Returns AxiosPromise<GetReportSchedulesResponse>

Deprecated

Throws

Settings