Function ReportsApiAxiosParamCreator

ReportsApi - axios parameter creator

Export

  • ReportsApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        cancelReport: (
            reportId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        cancelReportSchedule: (
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createReport: (
            body: CreateReportSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createReportSchedule: (
            body: CreateReportScheduleSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReport: (
            reportId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReportDocument: (
            reportDocumentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReports: (
            reportTypes?: string[],
            processingStatuses?: GetReportsProcessingStatusesEnum[],
            marketplaceIds?: string[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReportSchedule: (
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReportSchedules: (
            reportTypes: string[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelReport: (
            reportId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        cancelReportSchedule: (
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createReport: (
            body: CreateReportSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createReportSchedule: (
            body: CreateReportScheduleSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReport: (
            reportId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReportDocument: (
            reportDocumentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReports: (
            reportTypes?: string[],
            processingStatuses?: GetReportsProcessingStatusesEnum[],
            marketplaceIds?: string[],
            pageSize?: number,
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReportSchedule: (
            reportScheduleId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getReportSchedules: (
            reportTypes: string[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • cancelReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • cancelReportSchedule: (
          reportScheduleId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • createReport: (
          body: CreateReportSpecification,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • createReportSchedule: (
          body: CreateReportScheduleSpecification,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • getReport: (reportId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • getReportDocument: (
          reportDocumentId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • getReports: (
          reportTypes?: string[],
          processingStatuses?: GetReportsProcessingStatusesEnum[],
          marketplaceIds?: string[],
          pageSize?: number,
          createdSince?: string,
          createdUntil?: string,
          nextToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • getReportSchedule: (
          reportScheduleId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

    • getReportSchedules: (reportTypes: string[], options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      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.

      Deprecated

      Throws

Settings

Member Visibility