@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
190 lines (189 loc) • 15.9 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 { InlineResponse20010 } from '../models';
import { InlineResponse2008 } from '../models';
import { InlineResponse2009 } from '../models';
import { InlineResponse202 } from '../models';
import { V1BatchesBody } from '../models';
/**
* BatchesApi - axios parameter creator
* @export
*/
export declare const BatchesApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.
* @summary Retrieve a Batch Report
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchReport: (batchId: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
/**
* **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)
* @summary Retrieve a Batch Status
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchStatus: (batchId: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
/**
* **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.
* @summary List Batches
* @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the array.
* @param {number} [limit] The maximum number that can be returned in the array starting from the offset record in zero-based dataset.
* @param {string} [fromDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {string} [toDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchesList: (offset?: number, limit?: number, fromDate?: string, toDate?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
/**
* **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
* @summary Create a Batch
* @param {V1BatchesBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postBatch: (body: V1BatchesBody, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
* BatchesApi - functional programming interface
* @export
*/
export declare const BatchesApiFp: (configuration?: Configuration) => {
/**
* **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.
* @summary Retrieve a Batch Report
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchReport(batchId: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse20010>>>;
/**
* **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)
* @summary Retrieve a Batch Status
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchStatus(batchId: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2009>>>;
/**
* **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.
* @summary List Batches
* @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the array.
* @param {number} [limit] The maximum number that can be returned in the array starting from the offset record in zero-based dataset.
* @param {string} [fromDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {string} [toDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchesList(offset?: number, limit?: number, fromDate?: string, toDate?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2008>>>;
/**
* **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
* @summary Create a Batch
* @param {V1BatchesBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postBatch(body: V1BatchesBody, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse202>>>;
};
/**
* BatchesApi - factory interface
* @export
*/
export declare const BatchesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.
* @summary Retrieve a Batch Report
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchReport(batchId: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse20010>>;
/**
* **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)
* @summary Retrieve a Batch Status
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchStatus(batchId: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2009>>;
/**
* **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.
* @summary List Batches
* @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the array.
* @param {number} [limit] The maximum number that can be returned in the array starting from the offset record in zero-based dataset.
* @param {string} [fromDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {string} [toDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getBatchesList(offset?: number, limit?: number, fromDate?: string, toDate?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2008>>;
/**
* **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
* @summary Create a Batch
* @param {V1BatchesBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postBatch(body: V1BatchesBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse202>>;
};
/**
* BatchesApi - object-oriented interface
* @export
* @class BatchesApi
* @extends {BaseAPI}
*/
export declare class BatchesApi extends BaseAPI {
/**
* **Get Batch Report**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH) - Source record information including token ids, masked card number, expiration dates & card type. - Response record information including response code, reason, token ids, masked card number, expiration dates & card type.
* @summary Retrieve a Batch Report
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchesApi
*/
getBatchReport(batchId: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse20010>>;
/**
* **Get Batch Status**<br>This resource accepts a batch id and returns: - The batch status. - The total number of accepted, rejected, updated records. - The total number of card association responses. - The billable quantities of: - New Account Numbers (NAN) - New Expiry Dates (NED) - Account Closures (ACL) - Contact Card Holders (CCH)
* @summary Retrieve a Batch Status
* @param {string} batchId Unique identification number assigned to the submitted request.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchesApi
*/
getBatchStatus(batchId: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2009>>;
/**
* **List Batches**<br>This resource accepts a optional date range, record offset and limit, returning a paginated response of batches containing: - The batch id. - The batch status. - The batch created / modified dates. - The total number of accepted, rejected, updated records. - The total number of card association responses.
* @summary List Batches
* @param {number} [offset] Starting record in zero-based dataset that should be returned as the first object in the array.
* @param {number} [limit] The maximum number that can be returned in the array starting from the offset record in zero-based dataset.
* @param {string} [fromDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {string} [toDate] ISO-8601 format: yyyyMMddTHHmmssZ
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchesApi
*/
getBatchesList(offset?: number, limit?: number, fromDate?: string, toDate?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2008>>;
/**
* **Create a Batch**<br>This resource accepts TMS tokens ids of a Customer, Payment Instrument or Instrument Identifier. <br> The card numbers for the supplied tokens ids are then sent to the relevant card associations to check for updates.<br>The following type of batches can be submitted: - **oneOff** batch containing tokens id for Visa or MasterCard card numbers. - **amexRegistration** batch containing tokens id for Amex card numbers. A batch id will be returned on a successful response which can be used to get the batch status and the batch report.
* @summary Create a Batch
* @param {V1BatchesBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BatchesApi
*/
postBatch(body: V1BatchesBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse202>>;
}