@paciolan/cybersource-sdk/dist/apis/merchant-boarding-api.d.ts

CyberSource REST API Typescript SDK

/**
 * 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 { InlineResponse2004 } from '../models';
import { InlineResponse2013 } from '../models';
import { V1RegistrationsBody } from '../models';
/**
 * MerchantBoardingApi - axios parameter creator
 * @export
 */
export declare const MerchantBoardingApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * This end point will get all information of a boarding registration
     * @summary Gets all the information on a boarding registration
     * @param {string} registrationId Identifies the boarding registration to be updated
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRegistration: (registrationId: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
    /**
     * Create a registration to board merchant  If you have  Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request. You may unselect attributes from the Request Builder tree which you do not need in the request. For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt;
     * @summary Create a boarding registration
     * @param {V1RegistrationsBody} body Boarding registration data
     * @param {string} [vCIdempotencyId] defines idempotency of the request
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postRegistration: (body: V1RegistrationsBody, vCIdempotencyId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
 * MerchantBoardingApi - functional programming interface
 * @export
 */
export declare const MerchantBoardingApiFp: (configuration?: Configuration) => {
    /**
     * This end point will get all information of a boarding registration
     * @summary Gets all the information on a boarding registration
     * @param {string} registrationId Identifies the boarding registration to be updated
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRegistration(registrationId: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2004>>>;
    /**
     * Create a registration to board merchant  If you have  Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request. You may unselect attributes from the Request Builder tree which you do not need in the request. For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt;
     * @summary Create a boarding registration
     * @param {V1RegistrationsBody} body Boarding registration data
     * @param {string} [vCIdempotencyId] defines idempotency of the request
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postRegistration(body: V1RegistrationsBody, vCIdempotencyId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2013>>>;
};
/**
 * MerchantBoardingApi - factory interface
 * @export
 */
export declare const MerchantBoardingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * This end point will get all information of a boarding registration
     * @summary Gets all the information on a boarding registration
     * @param {string} registrationId Identifies the boarding registration to be updated
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRegistration(registrationId: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2004>>;
    /**
     * Create a registration to board merchant  If you have  Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request. You may unselect attributes from the Request Builder tree which you do not need in the request. For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt;
     * @summary Create a boarding registration
     * @param {V1RegistrationsBody} body Boarding registration data
     * @param {string} [vCIdempotencyId] defines idempotency of the request
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postRegistration(body: V1RegistrationsBody, vCIdempotencyId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2013>>;
};
/**
 * MerchantBoardingApi - object-oriented interface
 * @export
 * @class MerchantBoardingApi
 * @extends {BaseAPI}
 */
export declare class MerchantBoardingApi extends BaseAPI {
    /**
     * This end point will get all information of a boarding registration
     * @summary Gets all the information on a boarding registration
     * @param {string} registrationId Identifies the boarding registration to be updated
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MerchantBoardingApi
     */
    getRegistration(registrationId: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2004>>;
    /**
     * Create a registration to board merchant  If you have  Card Processing product enabled in your boarding request, select payment processor from Configuration -> Sample Request. You may unselect attributes from the Request Builder tree which you do not need in the request. For VPC, CUP and EFTPOS processors, replace the processor name from VPC or CUP or EFTPOS to the actual processor name in the sample request. e.g. replace VPC with &lt;your vpc processor&gt;
     * @summary Create a boarding registration
     * @param {V1RegistrationsBody} body Boarding registration data
     * @param {string} [vCIdempotencyId] defines idempotency of the request
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof MerchantBoardingApi
     */
    postRegistration(body: V1RegistrationsBody, vCIdempotencyId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InlineResponse2013>>;
}