@raisenow/tamaro-core
    Preparing search index...

    Class WidgetApi

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    Properties

    abTesting: AbTesting
    analyticsEventTracker: AnalyticsEventTracker
    config: WidgetConfig
    configEnv: ProductConfigEnv
    cssVarsOverrider: CssVarsOverrider
    customerInfo?: CustomerInfo
    datatransSecureFieldsHandler: DatatransSecureFieldsHandler
    dynamicFieldsHandler: DynamicFieldsHandler
    embedIframeChildHandler: EmbedIframeChildHandler
    embedMode: boolean
    epmsPaymentAgreementInfo?: EpmsPaymentAgreementInfo
    epmsPaymentInfo?: EpmsPaymentInfo
    epmsPaymentRequestData?: EpmsPaymentObject
    epmsPaymentRequestError?: any
    epmsPaymentRequestHandler: EpmsPaymentRequestHandler
    epmsPaymentResponseData?: EpmsPaymentResponseData
    epmsPaymentResponseError?: any
    epmsPaymentSourceInfo?: EpmsPaymentSourceInfo
    epmsPaymentStatusPoll: PollHandler
    epmsSubscriptionInfo?: EpmsSubscriptionInfo
    epmsSubscriptionStatusPoll: PollHandler
    epmsSubscriptionUpdateHandler: EpmsSubscriptionUpdateHandler
    epmsSupporterInfo?: EpmsSupporterInfo
    eppCardIframeChildHandler: EppCardIframeChildHandler
    eppCardIframeParentHandler: EppCardIframeParentHandler
    eppPaymentRequestHandler: EppPaymentRequestHandler
    eppPaymentStatusPoll: PollHandler
    events: WidgetEvents
    hasEpmsPaymentError: boolean = false
    hasEpmsSubscriptionUpdateError: boolean = false
    i18n?: i18n
    isCustomerInfoNotFound: boolean = false
    isEpmsPaymentAgreementNotFound: boolean = false
    isEpmsPaymentNotFound: boolean = false
    isEpmsPaymentSourceNotFound: boolean = false
    isEpmsSubscriptionNotFound: boolean = false
    isEpmsSupporterNotFound: boolean = false
    isInsideEppCardIframe: boolean = false
    isOverlayDataProtectionPolicyShown: boolean = false
    isPaymentAborted: boolean = false
    isSpinnerInnerShown: boolean = false
    isSpinnerOuterShown: boolean = false
    isSubscriptionNotFound: boolean = false
    isTransactionNotFound: boolean = false
    localStorageService: LocalStorageService
    monitoringHandler: MonitoringHandler
    navigationEventType?: NavigationLocationchangeEventType
    navigationSearch: Record<string, any>
    parser: Parser
    paymentForm: PaymentForm
    paymentFormDataCacheHandler: PaymentFormDataCacheHandler
    paymentMethodAmountLimits: PaymentMethodAmountLimits
    paypalSecureFieldsHandler: PaypalSecureFieldsHandler
    pgwProxyIframeParentHandler: PgwProxyIframeParentHandler
    preventPaymentValidateAndSend: boolean = false
    recaptcha?: WidgetRecaptcha
    resolvers: Partial<Resolvers>
    sessionService: SessionService
    sessionStorageService: SessionStorageService
    southKoreanCardHandler: SouthKoreanCardHandler
    spreedlySecureFieldsHandler: SpreedlySecureFieldsHandler
    stripeSdkProvider: StripeSdkProvider
    stripeWalletHandler: StripeWalletHandler
    subscriptionInfo?: SubscriptionInfo
    transactionInfo?: TransactionInfo
    validator: Validator
    widgetApiProxy: WidgetApiProxy

    Accessors

    • get compiler(): Parser

      Returns Parser

      The method should not be used

    • get coverFee(): {
          adjustmentEnabled: boolean;
          legacyFixed: number;
          legacyPercentage: number;
          organisationCostsFixed: number;
          organisationCostsPercentage: number;
          platformFixed: number;
          platformPercentage: number;
          processingFixed: number;
          processingPercentage: number;
      }

      Returns {
          adjustmentEnabled: boolean;
          legacyFixed: number;
          legacyPercentage: number;
          organisationCostsFixed: number;
          organisationCostsPercentage: number;
          platformFixed: number;
          platformPercentage: number;
          processingFixed: number;
          processingPercentage: number;
      }

    • get epmsConfig(): {
          accountUuid: string
          | undefined;
          apiUrl: string;
          awsWafCaptchaApiKey: string;
          awsWafCaptchaScriptUrl: string;
          datatransSecureFieldsMerchantId: string;
          datatransSecureFieldsScriptUrl: string;
          env: EpmsEnv;
          paymentMethodProfile: EpmsPaymentMethodProfileConfigResolved;
          paypalClientId: string | undefined;
          paypalMerchantId: string | undefined;
          paypalPartnerAttributionId: string;
          proxyUrl: string;
          secureFieldsHandler: SecureFieldHandlerName | undefined;
          spreedlyEnvKey: string | undefined;
          spreedlyScaTestScenario: string | undefined;
          spreedlySignatureEnabled: boolean | ConfigCondition<boolean>[] | undefined;
          stripeAccount: string | undefined;
          stripePublicKey: string | undefined;
          stripeRadarEnabled: boolean | undefined;
          testMode: boolean;
          twintCheckoutUrl: string;
          worldline: boolean;
      }

      Compute the EPMS config to retrive based on the environment.

      Use this accessor to retrieve the EMPS configuration options, which are correctly resolved based on environment and test mode.

      Avoid accessing properties directly from the epms or epmsDemo properties as these are not dynamic, unless there is a specific reason to do so.

      Returns {
          accountUuid: string | undefined;
          apiUrl: string;
          awsWafCaptchaApiKey: string;
          awsWafCaptchaScriptUrl: string;
          datatransSecureFieldsMerchantId: string;
          datatransSecureFieldsScriptUrl: string;
          env: EpmsEnv;
          paymentMethodProfile: EpmsPaymentMethodProfileConfigResolved;
          paypalClientId: string | undefined;
          paypalMerchantId: string | undefined;
          paypalPartnerAttributionId: string;
          proxyUrl: string;
          secureFieldsHandler: SecureFieldHandlerName | undefined;
          spreedlyEnvKey: string | undefined;
          spreedlyScaTestScenario: string | undefined;
          spreedlySignatureEnabled: boolean | ConfigCondition<boolean>[] | undefined;
          stripeAccount: string | undefined;
          stripePublicKey: string | undefined;
          stripeRadarEnabled: boolean | undefined;
          testMode: boolean;
          twintCheckoutUrl: string;
          worldline: boolean;
      }

      • accountUuid: string | undefined
      • apiUrl: string
      • awsWafCaptchaApiKey: string
      • awsWafCaptchaScriptUrl: string
      • datatransSecureFieldsMerchantId: string
      • datatransSecureFieldsScriptUrl: string
      • env: EpmsEnv
      • paymentMethodProfile: EpmsPaymentMethodProfileConfigResolved
      • paypalClientId: string | undefined
      • paypalMerchantId: string | undefined
      • paypalPartnerAttributionId: string
      • proxyUrl: string

        URL for endpoints defined in the Widget API project.

      • secureFieldsHandler: SecureFieldHandlerName | undefined
      • spreedlyEnvKey: string | undefined
      • spreedlyScaTestScenario: string | undefined
      • spreedlySignatureEnabled: boolean | ConfigCondition<boolean>[] | undefined
      • stripeAccount: string | undefined
      • stripePublicKey: string | undefined
      • stripeRadarEnabled: boolean | undefined
      • testMode: boolean
      • twintCheckoutUrl: string
      • worldline: boolean
    • get epmsTestMode(): boolean

      Returns boolean

    • get eppConfig(): {
          apiKey: string
          | undefined;
          apiUrl: string;
          cancelUrl: string | undefined;
          cardIframeUrl: string;
          env: EppEnv;
          errorUrl: string | undefined;
          immediateExecution: boolean;
          merchantId: string | undefined;
          proxyUrl: string;
          successUrl: string | undefined;
          testMode: boolean;
          useCardIframe: boolean;
      }

      Returns {
          apiKey: string | undefined;
          apiUrl: string;
          cancelUrl: string | undefined;
          cardIframeUrl: string;
          env: EppEnv;
          errorUrl: string | undefined;
          immediateExecution: boolean;
          merchantId: string | undefined;
          proxyUrl: string;
          successUrl: string | undefined;
          testMode: boolean;
          useCardIframe: boolean;
      }

    • get eppTestMode(): boolean

      Returns boolean

    • get isCoverFeeForced(): boolean

      Returns boolean

    • get isEmailPermissionFieldShownInSeparateBlock(): boolean

      Returns boolean

    • get isLegacyCoverFeeUsed(): boolean

      Returns boolean

    • get isModernCoverFeeUsed(): boolean

      Here we check for the presence of raw values in the config, we do not resolve them (they may be specified with conditions). If any of "modern" config options are truthy (undefined by default), then we know that the "modern" cover fees are used instead of the "legacy" ones.

      Returns boolean

    • get isPaymentResultPage(): boolean

      Returns boolean

    • get isSubscriptionPaymentMethodUpdateResultPage(): boolean

      Returns boolean

    • get productConfigName(): string

      Returns the name of the customer widget config. Falls back to "tamaro-core" if "configEnv.WIDGET_UUID" is not specified.

      Returns string

    • get resultUrlParamsToRemap(): Record<string, any> | undefined

      In case non-standard "payment_uuid" or "subscription_uuid" params are present, we need to redirect to the same url, but with "epms_payment_uuid" and "epms_subscription_uuid" params instead. This happens after redirect from 3D Secure confirmation page using Stripe payment provider with EPMS flow. We also clear other not needed params. This computed getter returns params to remap or undefined if no remapping is needed.

      Card numbers for testing 3D Secure is here: https://stripe.com/docs/testing?testing-method=card-numbers#regulatory-cards

      Returns Record<string, any> | undefined

    • get rnwQueryParams(): Record<string, any>

      Returns Record<string, any>

    Methods

    • Returns Promise<void>

    • Returns void

    • Parameters

      • value: any

      Returns void

    • Returns void

    • Parameters

      • field:
            | "stored_is_company_donation"
            | "stored_customer_company"
            | "stored_customer_salutation"
            | "stored_customer_firstname"
            | "stored_customer_lastname"
            | "stored_customer_raw_name"
            | "stored_customer_phone"
            | "stored_customer_email"
            | "stored_customer_birthdate"
            | "stored_customer_pan"
            | "stored_customer_fiscal_code"
            | "stored_customer_email_permission"
            | "stored_customer_message"
            | "stored_customer_donation_receipt"
            | "stored_customer_street"
            | "stored_customer_street_number"
            | "stored_customer_street2"
            | "stored_customer_pobox"
            | "stored_customer_zip_code"
            | "stored_customer_city"
            | "stored_customer_country"
            | "stored_customer_state"
            | "stored_customer_raw_address"
            | "bic"

      Returns boolean

    • Parameters

      • url: string
      • replace: boolean = false

      Returns Promise<void>

    • Returns void

    • Parameters

      • field: string

      Returns boolean

    • Parameters

      Returns string

    • Returns void