@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
103 lines (102 loc) • 9.84 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 { ReportingV3PurchaseRefundDetailsGet200Response } from '../models';
/**
* PurchaseAndRefundDetailsApi - axios parameter creator
* @export
*/
export declare const PurchaseAndRefundDetailsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @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} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPurchaseAndRefundDetails: (startTime: Date, endTime: Date, organizationId?: string, paymentSubtype?: string, viewBy?: string, groupName?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
* PurchaseAndRefundDetailsApi - functional programming interface
* @export
*/
export declare const PurchaseAndRefundDetailsApiFp: (configuration?: Configuration) => {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @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} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPurchaseAndRefundDetails(startTime: Date, endTime: Date, organizationId?: string, paymentSubtype?: string, viewBy?: string, groupName?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ReportingV3PurchaseRefundDetailsGet200Response>>>;
};
/**
* PurchaseAndRefundDetailsApi - factory interface
* @export
*/
export declare const PurchaseAndRefundDetailsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @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} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getPurchaseAndRefundDetails(startTime: Date, endTime: Date, organizationId?: string, paymentSubtype?: string, viewBy?: string, groupName?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3PurchaseRefundDetailsGet200Response>>;
};
/**
* PurchaseAndRefundDetailsApi - object-oriented interface
* @export
* @class PurchaseAndRefundDetailsApi
* @extends {BaseAPI}
*/
export declare class PurchaseAndRefundDetailsApi extends BaseAPI {
/**
* Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.
* @summary Get Purchase and Refund Details
* @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} [paymentSubtype] Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit
* @param {string} [viewBy] View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date
* @param {string} [groupName] Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds
* @param {number} [offset] Offset of the Purchase and Refund Results.
* @param {number} [limit] Results count per page. Range(1-2000)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PurchaseAndRefundDetailsApi
*/
getPurchaseAndRefundDetails(startTime: Date, endTime: Date, organizationId?: string, paymentSubtype?: string, viewBy?: string, groupName?: string, offset?: number, limit?: number, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<ReportingV3PurchaseRefundDetailsGet200Response>>;
}