@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
82 lines (81 loc) • 6 kB
TypeScript
/**
* CyberSource Merged Spec
* All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
*
* OpenAPI spec version: 0.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
/**
* ReportDownloadsApi - axios parameter creator
* @export
*/
export declare const ReportDownloadsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Download a report using the unique report name and date.
* @summary Download a Report
* @param {string} reportDate Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10
* @param {string} reportName Name of the report to download
* @param {string} [organizationId] Valid Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadReport: (reportDate: string, reportName: string, organizationId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
* ReportDownloadsApi - functional programming interface
* @export
*/
export declare const ReportDownloadsApiFp: (configuration?: Configuration) => {
/**
* Download a report using the unique report name and date.
* @summary Download a Report
* @param {string} reportDate Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10
* @param {string} reportName Name of the report to download
* @param {string} [organizationId] Valid Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadReport(reportDate: string, reportName: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
};
/**
* ReportDownloadsApi - factory interface
* @export
*/
export declare const ReportDownloadsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Download a report using the unique report name and date.
* @summary Download a Report
* @param {string} reportDate Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10
* @param {string} reportName Name of the report to download
* @param {string} [organizationId] Valid Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadReport(reportDate: string, reportName: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>;
};
/**
* ReportDownloadsApi - object-oriented interface
* @export
* @class ReportDownloadsApi
* @extends {BaseAPI}
*/
export declare class ReportDownloadsApi extends BaseAPI {
/**
* Download a report using the unique report name and date.
* @summary Download a Report
* @param {string} reportDate Valid date on which to download the report in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** yyyy-mm-dd For reports that span multiple days, this value would be the end date of the report in the time zone of the report subscription. Example 1: If your report start date is 2020-03-06 and the end date is 2020-03-09, the reportDate passed in the query is 2020-03-09. Example 2: If your report runs from midnight to midnight on 2020-03-09, the reportDate passed in the query is 2020-03-10
* @param {string} reportName Name of the report to download
* @param {string} [organizationId] Valid Organization Id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ReportDownloadsApi
*/
downloadReport(reportDate: string, reportName: string, organizationId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>;
}