@square/web-payments-sdk-types
Version:
Types for Square's Web Payments SDK
51 lines (50 loc) • 1.83 kB
TypeScript
import { SqError } from './types';
/**
* Occurs when the developer passes an invalid type in the Cash App Pay button options
*/
declare class InvalidCashAppPayOptionsFieldTypes extends SqError {
/**
* @param {string[][]} invalidFields - an array of string tuples describing the missing property and its type
*/
constructor(invalidFields: [string, string][]);
}
/**
* Occurs when the developer passes an invalid value in the Cash App Pay button options
*/
declare class InvalidCashAppPayOptionsFieldValues extends SqError {
/**
* @param {string[][]} invalidFields - an array of string tuples describing the missing property and its type
*/
constructor(invalidFields: [string, string][]);
}
/**
* Exception thrown when a Payment Request is invalid for Cash App Pay.
* This can happen when an unsupported currency code is provided or an invalid payment request is used.
*/
declare class CashAppPayInvalidPaymentRequestError extends SqError {
/**
* @inheritdoc
*/
constructor(message: string);
}
/**
* Exception thrown when a redirect url is not provided on initialization.
* This can happen when the user calls `cashAppPay` without the necessary options.
*/
declare class CashAppPayMissingRedirectUrlError extends SqError {
/**
* @inheritdoc
*/
constructor();
}
/**
* Exception thrown when a tokenize validator is not a function.
* This can happen when a user passes a non-function to the cashAppPay shouldTokenize option.
*/
declare class CashAppPayInvalidShouldTokenizeError extends SqError {
/**
* @inheritdoc
*/
constructor();
}
export { InvalidCashAppPayOptionsFieldTypes, InvalidCashAppPayOptionsFieldValues, CashAppPayInvalidPaymentRequestError, CashAppPayMissingRedirectUrlError, CashAppPayInvalidShouldTokenizeError, };