@adyen/api-library
Version:
The Adyen API Library for NodeJS enables you to work with Adyen APIs.
30 lines (29 loc) • 1.18 kB
TypeScript
import { SaleData } from "../../typings/tapi/saleData";
import { SaleToAcquirerData } from "./saleToAcquirerData";
/**
* A helper class to work with `SaleData` from the TAPI (Cloud device API) model.
*
* The `SaleToAcquirerData` field supports two formats:
* - Base64-encoded JSON: a JSON object encoded as a Base64 string.
* - Key-value pairs: form-encoded pairs using `&` as separator
* (e.g. `shopperEmail=foo@bar.com&tenderOption=AskGratuity`).
*
* This helper auto-detects the format and parses it into a {@link SaleToAcquirerData} object.
*/
export declare class SaleDataHelper {
private saleData;
/**
* Constructs a helper instance wrapping the provided {@link SaleData}.
*
* @param saleData The {@link SaleData} instance to wrap.
*/
constructor(saleData: SaleData);
/**
* Parses the `SaleToAcquirerData` field into a {@link SaleToAcquirerData} object.
* Supports both Base64-encoded JSON and form-encoded key-value pair formats.
*
* @returns The parsed {@link SaleToAcquirerData}, or `null` if the field is absent
* or cannot be parsed.
*/
getSaleToAcquirerData(): SaleToAcquirerData | null;
}