@paciolan/cybersource-sdk
Version:
CyberSource REST API Typescript SDK
106 lines (105 loc) • 6.22 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 { InvoicingV2InvoiceSettingsGet200Response } from '../models';
import { InvoicingV2InvoiceSettingsPut200Response } from '../models';
import { V2InvoiceSettingsBody } from '../models';
/**
* InvoiceSettingsApi - axios parameter creator
* @export
*/
export declare const InvoiceSettingsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Allows you to retrieve the invoice settings for the payment page.
* @summary Get Invoice Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInvoiceSettings: (options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
/**
* Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.
* @summary Update Invoice Settings
* @param {V2InvoiceSettingsBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateInvoiceSettings: (body: V2InvoiceSettingsBody, options?: AxiosRequestConfig & Configuration) => Promise<RequestArgs>;
};
/**
* InvoiceSettingsApi - functional programming interface
* @export
*/
export declare const InvoiceSettingsApiFp: (configuration?: Configuration) => {
/**
* Allows you to retrieve the invoice settings for the payment page.
* @summary Get Invoice Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInvoiceSettings(options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InvoicingV2InvoiceSettingsGet200Response>>>;
/**
* Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.
* @summary Update Invoice Settings
* @param {V2InvoiceSettingsBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateInvoiceSettings(body: V2InvoiceSettingsBody, options?: AxiosRequestConfig & Configuration): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InvoicingV2InvoiceSettingsPut200Response>>>;
};
/**
* InvoiceSettingsApi - factory interface
* @export
*/
export declare const InvoiceSettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Allows you to retrieve the invoice settings for the payment page.
* @summary Get Invoice Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getInvoiceSettings(options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InvoicingV2InvoiceSettingsGet200Response>>;
/**
* Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.
* @summary Update Invoice Settings
* @param {V2InvoiceSettingsBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateInvoiceSettings(body: V2InvoiceSettingsBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InvoicingV2InvoiceSettingsPut200Response>>;
};
/**
* InvoiceSettingsApi - object-oriented interface
* @export
* @class InvoiceSettingsApi
* @extends {BaseAPI}
*/
export declare class InvoiceSettingsApi extends BaseAPI {
/**
* Allows you to retrieve the invoice settings for the payment page.
* @summary Get Invoice Settings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InvoiceSettingsApi
*/
getInvoiceSettings(options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InvoicingV2InvoiceSettingsGet200Response>>;
/**
* Allows you to customize the payment page, the checkout experience, email communication and payer authentication. You can customize the invoice to match your brand with your business name, logo and brand colors, and a VAT Tax number. You can choose to capture the payers shipping details, phone number and email during the checkout process. You can add a custom message to all invoice emails and enable or disable payer authentication for invoice payments.
* @summary Update Invoice Settings
* @param {V2InvoiceSettingsBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InvoiceSettingsApi
*/
updateInvoiceSettings(body: V2InvoiceSettingsBody, options?: AxiosRequestConfig & Configuration): Promise<AxiosResponse<InvoicingV2InvoiceSettingsPut200Response>>;
}