@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
154 lines (153 loc) • 11 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 { PtsV1TransactionBatchesGet200Response } from '../models';
import { PtsV1TransactionBatchesIdGet200Response } from '../models';
/**
* TransactionBatchesApi - axios parameter creator
* @export
*/
export declare const TransactionBatchesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
* @summary Get Transaction Details for a given Batch Id
* @param {string} id The batch id assigned for the template.
* @param {string} [uploadDate] Date in which the original batch file was uploaded. Date must be 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
* @param {string} [status] Allows you to filter by rejected response. Valid values: - Rejected
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatchDetails: (id: string, uploadDate?: string, status?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
/**
* Provide the search range
* @summary Get Individual Batch File
* @param {string} id The batch id assigned for the template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatchId: (id: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
/**
* Provide the search range
* @summary Get a List of Batch Files
* @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.SSSZZ
* @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.SSSZZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatches: (startTime: Date, endTime: Date, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
* TransactionBatchesApi - functional programming interface
* @export
*/
export declare const TransactionBatchesApiFp: (configuration?: Configuration) => {
/**
* Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
* @summary Get Transaction Details for a given Batch Id
* @param {string} id The batch id assigned for the template.
* @param {string} [uploadDate] Date in which the original batch file was uploaded. Date must be 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
* @param {string} [status] Allows you to filter by rejected response. Valid values: - Rejected
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatchDetails(id: string, uploadDate?: string, status?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>;
/**
* Provide the search range
* @summary Get Individual Batch File
* @param {string} id The batch id assigned for the template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatchId(id: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PtsV1TransactionBatchesIdGet200Response>>>;
/**
* Provide the search range
* @summary Get a List of Batch Files
* @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.SSSZZ
* @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.SSSZZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatches(startTime: Date, endTime: Date, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PtsV1TransactionBatchesGet200Response>>>;
};
/**
* TransactionBatchesApi - factory interface
* @export
*/
export declare const TransactionBatchesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
* @summary Get Transaction Details for a given Batch Id
* @param {string} id The batch id assigned for the template.
* @param {string} [uploadDate] Date in which the original batch file was uploaded. Date must be 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
* @param {string} [status] Allows you to filter by rejected response. Valid values: - Rejected
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatchDetails(id: string, uploadDate?: string, status?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>;
/**
* Provide the search range
* @summary Get Individual Batch File
* @param {string} id The batch id assigned for the template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatchId(id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV1TransactionBatchesIdGet200Response>>;
/**
* Provide the search range
* @summary Get a List of Batch Files
* @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.SSSZZ
* @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.SSSZZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTransactionBatches(startTime: Date, endTime: Date, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV1TransactionBatchesGet200Response>>;
};
/**
* TransactionBatchesApi - object-oriented interface
* @export
* @class TransactionBatchesApi
* @extends {BaseAPI}
*/
export declare class TransactionBatchesApi extends BaseAPI {
/**
* Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service.
* @summary Get Transaction Details for a given Batch Id
* @param {string} id The batch id assigned for the template.
* @param {string} [uploadDate] Date in which the original batch file was uploaded. Date must be 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
* @param {string} [status] Allows you to filter by rejected response. Valid values: - Rejected
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TransactionBatchesApi
*/
getTransactionBatchDetails(id: string, uploadDate?: string, status?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<void>>;
/**
* Provide the search range
* @summary Get Individual Batch File
* @param {string} id The batch id assigned for the template.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TransactionBatchesApi
*/
getTransactionBatchId(id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV1TransactionBatchesIdGet200Response>>;
/**
* Provide the search range
* @summary Get a List of Batch Files
* @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.SSSZZ
* @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.SSSZZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TransactionBatchesApi
*/
getTransactionBatches(startTime: Date, endTime: Date, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<PtsV1TransactionBatchesGet200Response>>;
}