@paciolan/cybersource-sdk/dist/apis/token-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 { TokenIdPaymentcredentialsBody } from '../models';
/**
 * TokenApi - axios parameter creator
 * @export
 */
export declare const TokenApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * |  |  |  |     | --- | --- | --- |     |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.
     * @summary Generate Payment Credentials for a TMS Token
     * @param {TokenIdPaymentcredentialsBody} body
     * @param {string} tokenId The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
     * @param {string} [profileId] The Id of a profile containing user specific TMS configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postTokenPaymentCredentials: (body: TokenIdPaymentcredentialsBody, tokenId: string, profileId?: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
 * TokenApi - functional programming interface
 * @export
 */
export declare const TokenApiFp: (configuration?: Configuration) => {
    /**
     * |  |  |  |     | --- | --- | --- |     |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.
     * @summary Generate Payment Credentials for a TMS Token
     * @param {TokenIdPaymentcredentialsBody} body
     * @param {string} tokenId The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
     * @param {string} [profileId] The Id of a profile containing user specific TMS configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postTokenPaymentCredentials(body: TokenIdPaymentcredentialsBody, tokenId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<string>>>;
};
/**
 * TokenApi - factory interface
 * @export
 */
export declare const TokenApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * |  |  |  |     | --- | --- | --- |     |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.
     * @summary Generate Payment Credentials for a TMS Token
     * @param {TokenIdPaymentcredentialsBody} body
     * @param {string} tokenId The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
     * @param {string} [profileId] The Id of a profile containing user specific TMS configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postTokenPaymentCredentials(body: TokenIdPaymentcredentialsBody, tokenId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<string>>;
};
/**
 * TokenApi - object-oriented interface
 * @export
 * @class TokenApi
 * @extends {BaseAPI}
 */
export declare class TokenApi extends BaseAPI {
    /**
     * |  |  |  |     | --- | --- | --- |     |**Token**<br>A Token can represent your tokenized Customer, Payment Instrument or Instrument Identifier information.|&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|**Payment Credentials**<br>Contains payment information such as the network token, generated cryptogram for Visa & MasterCard or dynamic CVV for Amex in a JSON Web Encryption (JWE) response.<br>Your system can use this API to retrieve the Payment Credentials for an existing Customer, Payment Instrument or Instrument Identifier.
     * @summary Generate Payment Credentials for a TMS Token
     * @param {TokenIdPaymentcredentialsBody} body
     * @param {string} tokenId The Id of a token representing a Customer, Payment Instrument or Instrument Identifier.
     * @param {string} [profileId] The Id of a profile containing user specific TMS configuration.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TokenApi
     */
    postTokenPaymentCredentials(body: TokenIdPaymentcredentialsBody, tokenId: string, profileId?: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<string>>;
}