@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
95 lines (94 loc) • 7.83 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';
import { ReportingV3PaymentBatchSummariesGet200Response } from '../models';
/**
* PaymentBatchSummariesApi - axios parameter creator
* @export
*/
export declare const PaymentBatchSummariesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Scope can be either account/merchant or reseller.
* @summary Get Payment Batch Summary Data
* @param {Date} startTime Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [rollUp] Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant
* @param {string} [breakdown] Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.
* @param {number} [startDayOfWeek] Optional - Start day of week to breakdown data for weeks in a month
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPaymentBatchSummary: (startTime: Date, endTime: Date, organizationId?: string, rollUp?: string, breakdown?: string, startDayOfWeek?: number, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
* PaymentBatchSummariesApi - functional programming interface
* @export
*/
export declare const PaymentBatchSummariesApiFp: (configuration?: Configuration) => {
/**
* Scope can be either account/merchant or reseller.
* @summary Get Payment Batch Summary Data
* @param {Date} startTime Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [rollUp] Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant
* @param {string} [breakdown] Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.
* @param {number} [startDayOfWeek] Optional - Start day of week to breakdown data for weeks in a month
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPaymentBatchSummary(startTime: Date, endTime: Date, organizationId?: string, rollUp?: string, breakdown?: string, startDayOfWeek?: number, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ReportingV3PaymentBatchSummariesGet200Response>>>;
};
/**
* PaymentBatchSummariesApi - factory interface
* @export
*/
export declare const PaymentBatchSummariesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Scope can be either account/merchant or reseller.
* @summary Get Payment Batch Summary Data
* @param {Date} startTime Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [rollUp] Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant
* @param {string} [breakdown] Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.
* @param {number} [startDayOfWeek] Optional - Start day of week to breakdown data for weeks in a month
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPaymentBatchSummary(startTime: Date, endTime: Date, organizationId?: string, rollUp?: string, breakdown?: string, startDayOfWeek?: number, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3PaymentBatchSummariesGet200Response>>;
};
/**
* PaymentBatchSummariesApi - object-oriented interface
* @export
* @class PaymentBatchSummariesApi
* @extends {BaseAPI}
*/
export declare class PaymentBatchSummariesApi extends BaseAPI {
/**
* Scope can be either account/merchant or reseller.
* @summary Get Payment Batch Summary Data
* @param {Date} startTime Valid report Start Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {Date} endTime Valid report End Time 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'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)
* @param {string} [organizationId] Valid Organization Id
* @param {string} [rollUp] Conditional - RollUp for data for day/week/month. Required while getting breakdown data for a Merchant
* @param {string} [breakdown] Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.
* @param {number} [startDayOfWeek] Optional - Start day of week to breakdown data for weeks in a month
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PaymentBatchSummariesApi
*/
getPaymentBatchSummary(startTime: Date, endTime: Date, organizationId?: string, rollUp?: string, breakdown?: string, startDayOfWeek?: number, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3PaymentBatchSummariesGet200Response>>;
}