@paciolan/cybersource-sdk/dist/apis/taxes-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 { TaxIdBody } from '../models';
import { V2TaxBody } from '../models';
import { VasV2PaymentsPost201Response } from '../models';
import { VasV2TaxVoid200Response } from '../models';
/**
 * TaxesApi - axios parameter creator
 * @export
 */
export declare const TaxesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide.  It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation.  The service supports product-based tax rules and exemptions for goods and services.  The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).
     * @summary Calculate Taxes
     * @param {V2TaxBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    calculateTax: (body: V2TaxBody, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
    /**
     * Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
     * @summary Void Taxes
     * @param {TaxIdBody} body
     * @param {string} id The tax ID returned from a previous request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    voidTax: (body: TaxIdBody, id: string, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
 * TaxesApi - functional programming interface
 * @export
 */
export declare const TaxesApiFp: (configuration?: Configuration) => {
    /**
     * The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide.  It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation.  The service supports product-based tax rules and exemptions for goods and services.  The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).
     * @summary Calculate Taxes
     * @param {V2TaxBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    calculateTax(body: V2TaxBody, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<VasV2PaymentsPost201Response>>>;
    /**
     * Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
     * @summary Void Taxes
     * @param {TaxIdBody} body
     * @param {string} id The tax ID returned from a previous request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    voidTax(body: TaxIdBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<VasV2TaxVoid200Response>>>;
};
/**
 * TaxesApi - factory interface
 * @export
 */
export declare const TaxesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide.  It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation.  The service supports product-based tax rules and exemptions for goods and services.  The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).
     * @summary Calculate Taxes
     * @param {V2TaxBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    calculateTax(body: V2TaxBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<VasV2PaymentsPost201Response>>;
    /**
     * Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
     * @summary Void Taxes
     * @param {TaxIdBody} body
     * @param {string} id The tax ID returned from a previous request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    voidTax(body: TaxIdBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<VasV2TaxVoid200Response>>;
};
/**
 * TaxesApi - object-oriented interface
 * @export
 * @class TaxesApi
 * @extends {BaseAPI}
 */
export declare class TaxesApi extends BaseAPI {
    /**
     * The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide.  It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation.  The service supports product-based tax rules and exemptions for goods and services.  The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html).
     * @summary Calculate Taxes
     * @param {V2TaxBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TaxesApi
     */
    calculateTax(body: V2TaxBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<VasV2PaymentsPost201Response>>;
    /**
     * Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
     * @summary Void Taxes
     * @param {TaxIdBody} body
     * @param {string} id The tax ID returned from a previous request.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof TaxesApi
     */
    voidTax(body: TaxIdBody, id: string, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<VasV2TaxVoid200Response>>;
}