/** * This file was auto-generated by Fern from our API Definition. */ import * as core from "../core"; import { Error_, ErrorCategory as GeneratedErrorCategory, ErrorCode as GeneratedErrorCode } from "../api"; export declare class SquareError extends Error { readonly statusCode?: number; readonly body?: unknown; readonly errors: SquareError.BodyError[]; readonly rawResponse?: core.RawResponse; constructor({ message, statusCode, body, rawResponse, }: { message?: string; statusCode?: number; body?: unknown; rawResponse?: core.RawResponse; }); } export declare namespace SquareError { type BodyError = { /** * The high-level category for the error. * See [ErrorCategory](#type-errorcategory) for possible values */ category: ErrorCategory; /** * The specific code of the error. * See [ErrorCode](#type-errorcode) for possible values */ code: ErrorCode; } & Omit; type ErrorCategory = GeneratedErrorCategory | "V1_ERROR"; const ErrorCategory: { readonly V1Error: "V1_ERROR"; readonly ApiError: "API_ERROR"; readonly AuthenticationError: "AUTHENTICATION_ERROR"; readonly InvalidRequestError: "INVALID_REQUEST_ERROR"; readonly RateLimitError: "RATE_LIMIT_ERROR"; readonly PaymentMethodError: "PAYMENT_METHOD_ERROR"; readonly RefundError: "REFUND_ERROR"; readonly MerchantSubscriptionError: "MERCHANT_SUBSCRIPTION_ERROR"; readonly ExternalVendorError: "EXTERNAL_VENDOR_ERROR"; }; type ErrorCode = GeneratedErrorCode | "Unknown" | string; const ErrorCode: { readonly Unknown: "Unknown"; readonly InternalServerError: "INTERNAL_SERVER_ERROR"; readonly Unauthorized: "UNAUTHORIZED"; readonly AccessTokenExpired: "ACCESS_TOKEN_EXPIRED"; readonly AccessTokenRevoked: "ACCESS_TOKEN_REVOKED"; readonly ClientDisabled: "CLIENT_DISABLED"; readonly Forbidden: "FORBIDDEN"; readonly InsufficientScopes: "INSUFFICIENT_SCOPES"; readonly ApplicationDisabled: "APPLICATION_DISABLED"; readonly V1Application: "V1_APPLICATION"; readonly V1AccessToken: "V1_ACCESS_TOKEN"; readonly CardProcessingNotEnabled: "CARD_PROCESSING_NOT_ENABLED"; readonly MerchantSubscriptionNotFound: "MERCHANT_SUBSCRIPTION_NOT_FOUND"; readonly BadRequest: "BAD_REQUEST"; readonly MissingRequiredParameter: "MISSING_REQUIRED_PARAMETER"; readonly IncorrectType: "INCORRECT_TYPE"; readonly InvalidTime: "INVALID_TIME"; readonly InvalidTimeRange: "INVALID_TIME_RANGE"; readonly InvalidValue: "INVALID_VALUE"; readonly InvalidCursor: "INVALID_CURSOR"; readonly UnknownQueryParameter: "UNKNOWN_QUERY_PARAMETER"; readonly ConflictingParameters: "CONFLICTING_PARAMETERS"; readonly ExpectedJsonBody: "EXPECTED_JSON_BODY"; readonly InvalidSortOrder: "INVALID_SORT_ORDER"; readonly ValueRegexMismatch: "VALUE_REGEX_MISMATCH"; readonly ValueTooShort: "VALUE_TOO_SHORT"; readonly ValueTooLong: "VALUE_TOO_LONG"; readonly ValueTooLow: "VALUE_TOO_LOW"; readonly ValueTooHigh: "VALUE_TOO_HIGH"; readonly ValueEmpty: "VALUE_EMPTY"; readonly ArrayLengthTooLong: "ARRAY_LENGTH_TOO_LONG"; readonly ArrayLengthTooShort: "ARRAY_LENGTH_TOO_SHORT"; readonly ArrayEmpty: "ARRAY_EMPTY"; readonly ExpectedBoolean: "EXPECTED_BOOLEAN"; readonly ExpectedInteger: "EXPECTED_INTEGER"; readonly ExpectedFloat: "EXPECTED_FLOAT"; readonly ExpectedString: "EXPECTED_STRING"; readonly ExpectedObject: "EXPECTED_OBJECT"; readonly ExpectedArray: "EXPECTED_ARRAY"; readonly ExpectedMap: "EXPECTED_MAP"; readonly ExpectedBase64EncodedByteArray: "EXPECTED_BASE64_ENCODED_BYTE_ARRAY"; readonly InvalidArrayValue: "INVALID_ARRAY_VALUE"; readonly InvalidEnumValue: "INVALID_ENUM_VALUE"; readonly InvalidContentType: "INVALID_CONTENT_TYPE"; readonly InvalidFormValue: "INVALID_FORM_VALUE"; readonly CustomerNotFound: "CUSTOMER_NOT_FOUND"; readonly OneInstrumentExpected: "ONE_INSTRUMENT_EXPECTED"; readonly NoFieldsSet: "NO_FIELDS_SET"; readonly TooManyMapEntries: "TOO_MANY_MAP_ENTRIES"; readonly MapKeyLengthTooShort: "MAP_KEY_LENGTH_TOO_SHORT"; readonly MapKeyLengthTooLong: "MAP_KEY_LENGTH_TOO_LONG"; readonly CustomerMissingName: "CUSTOMER_MISSING_NAME"; readonly CustomerMissingEmail: "CUSTOMER_MISSING_EMAIL"; readonly InvalidPauseLength: "INVALID_PAUSE_LENGTH"; readonly InvalidDate: "INVALID_DATE"; readonly UnsupportedCountry: "UNSUPPORTED_COUNTRY"; readonly UnsupportedCurrency: "UNSUPPORTED_CURRENCY"; readonly AppleTtpPinToken: "APPLE_TTP_PIN_TOKEN"; readonly CardExpired: "CARD_EXPIRED"; readonly InvalidExpiration: "INVALID_EXPIRATION"; readonly InvalidExpirationYear: "INVALID_EXPIRATION_YEAR"; readonly InvalidExpirationDate: "INVALID_EXPIRATION_DATE"; readonly UnsupportedCardBrand: "UNSUPPORTED_CARD_BRAND"; readonly UnsupportedEntryMethod: "UNSUPPORTED_ENTRY_METHOD"; readonly InvalidEncryptedCard: "INVALID_ENCRYPTED_CARD"; readonly InvalidCard: "INVALID_CARD"; readonly PaymentAmountMismatch: "PAYMENT_AMOUNT_MISMATCH"; readonly GenericDecline: "GENERIC_DECLINE"; readonly CvvFailure: "CVV_FAILURE"; readonly AddressVerificationFailure: "ADDRESS_VERIFICATION_FAILURE"; readonly InvalidAccount: "INVALID_ACCOUNT"; readonly CurrencyMismatch: "CURRENCY_MISMATCH"; readonly InsufficientFunds: "INSUFFICIENT_FUNDS"; readonly InsufficientPermissions: "INSUFFICIENT_PERMISSIONS"; readonly CardholderInsufficientPermissions: "CARDHOLDER_INSUFFICIENT_PERMISSIONS"; readonly InvalidLocation: "INVALID_LOCATION"; readonly TransactionLimit: "TRANSACTION_LIMIT"; readonly VoiceFailure: "VOICE_FAILURE"; readonly PanFailure: "PAN_FAILURE"; readonly ExpirationFailure: "EXPIRATION_FAILURE"; readonly CardNotSupported: "CARD_NOT_SUPPORTED"; readonly ReaderDeclined: "READER_DECLINED"; readonly InvalidPin: "INVALID_PIN"; readonly MissingPin: "MISSING_PIN"; readonly MissingAccountType: "MISSING_ACCOUNT_TYPE"; readonly InvalidPostalCode: "INVALID_POSTAL_CODE"; readonly InvalidFees: "INVALID_FEES"; readonly ManuallyEnteredPaymentNotSupported: "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED"; readonly PaymentLimitExceeded: "PAYMENT_LIMIT_EXCEEDED"; readonly GiftCardAvailableAmount: "GIFT_CARD_AVAILABLE_AMOUNT"; readonly AccountUnusable: "ACCOUNT_UNUSABLE"; readonly BuyerRefusedPayment: "BUYER_REFUSED_PAYMENT"; readonly DelayedTransactionExpired: "DELAYED_TRANSACTION_EXPIRED"; readonly DelayedTransactionCanceled: "DELAYED_TRANSACTION_CANCELED"; readonly DelayedTransactionCaptured: "DELAYED_TRANSACTION_CAPTURED"; readonly DelayedTransactionFailed: "DELAYED_TRANSACTION_FAILED"; readonly CardTokenExpired: "CARD_TOKEN_EXPIRED"; readonly CardTokenUsed: "CARD_TOKEN_USED"; readonly AmountTooHigh: "AMOUNT_TOO_HIGH"; readonly UnsupportedInstrumentType: "UNSUPPORTED_INSTRUMENT_TYPE"; readonly RefundAmountInvalid: "REFUND_AMOUNT_INVALID"; readonly RefundAlreadyPending: "REFUND_ALREADY_PENDING"; readonly PaymentNotRefundable: "PAYMENT_NOT_REFUNDABLE"; readonly PaymentNotRefundableDueToDispute: "PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE"; readonly RefundErrorPaymentNeedsCompletion: "REFUND_ERROR_PAYMENT_NEEDS_COMPLETION"; readonly RefundDeclined: "REFUND_DECLINED"; readonly InsufficientPermissionsForRefund: "INSUFFICIENT_PERMISSIONS_FOR_REFUND"; readonly InvalidCardData: "INVALID_CARD_DATA"; readonly SourceUsed: "SOURCE_USED"; readonly SourceExpired: "SOURCE_EXPIRED"; readonly UnsupportedLoyaltyRewardTier: "UNSUPPORTED_LOYALTY_REWARD_TIER"; readonly LocationMismatch: "LOCATION_MISMATCH"; readonly OrderUnpaidNotReturnable: "ORDER_UNPAID_NOT_RETURNABLE"; readonly IdempotencyKeyReused: "IDEMPOTENCY_KEY_REUSED"; readonly UnexpectedValue: "UNEXPECTED_VALUE"; readonly SandboxNotSupported: "SANDBOX_NOT_SUPPORTED"; readonly InvalidEmailAddress: "INVALID_EMAIL_ADDRESS"; readonly InvalidPhoneNumber: "INVALID_PHONE_NUMBER"; readonly CheckoutExpired: "CHECKOUT_EXPIRED"; readonly BadCertificate: "BAD_CERTIFICATE"; readonly InvalidSquareVersionFormat: "INVALID_SQUARE_VERSION_FORMAT"; readonly ApiVersionIncompatible: "API_VERSION_INCOMPATIBLE"; readonly CardPresenceRequired: "CARD_PRESENCE_REQUIRED"; readonly UnsupportedSourceType: "UNSUPPORTED_SOURCE_TYPE"; readonly CardMismatch: "CARD_MISMATCH"; readonly PlaidError: "PLAID_ERROR"; readonly PlaidErrorItemLoginRequired: "PLAID_ERROR_ITEM_LOGIN_REQUIRED"; readonly PlaidErrorRateLimit: "PLAID_ERROR_RATE_LIMIT"; readonly CardDeclined: "CARD_DECLINED"; readonly VerifyCvvFailure: "VERIFY_CVV_FAILURE"; readonly VerifyAvsFailure: "VERIFY_AVS_FAILURE"; readonly CardDeclinedCallIssuer: "CARD_DECLINED_CALL_ISSUER"; readonly CardDeclinedVerificationRequired: "CARD_DECLINED_VERIFICATION_REQUIRED"; readonly BadExpiration: "BAD_EXPIRATION"; readonly ChipInsertionRequired: "CHIP_INSERTION_REQUIRED"; readonly AllowablePinTriesExceeded: "ALLOWABLE_PIN_TRIES_EXCEEDED"; readonly ReservationDeclined: "RESERVATION_DECLINED"; readonly UnknownBodyParameter: "UNKNOWN_BODY_PARAMETER"; readonly NotFound: "NOT_FOUND"; readonly ApplePaymentProcessingCertificateHashNotFound: "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND"; readonly MethodNotAllowed: "METHOD_NOT_ALLOWED"; readonly NotAcceptable: "NOT_ACCEPTABLE"; readonly RequestTimeout: "REQUEST_TIMEOUT"; readonly Conflict: "CONFLICT"; readonly Gone: "GONE"; readonly RequestEntityTooLarge: "REQUEST_ENTITY_TOO_LARGE"; readonly UnsupportedMediaType: "UNSUPPORTED_MEDIA_TYPE"; readonly UnprocessableEntity: "UNPROCESSABLE_ENTITY"; readonly RateLimited: "RATE_LIMITED"; readonly NotImplemented: "NOT_IMPLEMENTED"; readonly BadGateway: "BAD_GATEWAY"; readonly ServiceUnavailable: "SERVICE_UNAVAILABLE"; readonly TemporaryError: "TEMPORARY_ERROR"; readonly GatewayTimeout: "GATEWAY_TIMEOUT"; }; }