Variable defaultConst

Type Declaration

• getBillsByParcelNumber: {
      failure: PayloadAC<
          "GET_BILLS_BY_PARCEL_NUMBER_FAILURE",
          { error: string; parcelNumber: string },
      >;
      request: PayloadAC<
          "GET_BILLS_BY_PARCEL_NUMBER_REQUEST",
          { parcelNumber: string },
      >;
      success: PayloadAC<
          "GET_BILLS_BY_PARCEL_NUMBER_SUCCESS",
          { data: TaxBill[]; parcelNumber: string },
      >;
  }

  Dispatch to fetch tax bills by parcel number.

  Example

  {
    type: "GET_BILLS_BY_PARCEL_NUMBER_REQUEST",
    payload: {
      parcelNumber: "123-456-789"
    }
  }
  Copy

  {
    type: "GET_BILLS_BY_PARCEL_NUMBER_SUCCESS",
    payload: {
      parcelNumber: "123-456-789",
      data: []
    }
  }
  Copy

  {
    type: "GET_BILLS_BY_PARCEL_NUMBER_FAILURE",
    payload: {
      parcelNumber: "123-456-789",
      error: "Not found"
    }
  }
  Copy

  See

  "module-payit-integration/lib/browser/reducers/search.reducer".billsByParcel

• getTaxAccountByParcelNumber: {
      failure: PayloadAC<
          "GET_TAX_ACCOUNT_BY_PARCEL_NUMBER_FAILURE",
          { error: string; parcelNumber: string },
      >;
      request: PayloadAC<
          "GET_TAX_ACCOUNT_BY_PARCEL_NUMBER_REQUEST",
          { parcelNumber: string },
      >;
      success: PayloadAC<
          "GET_TAX_ACCOUNT_BY_PARCEL_NUMBER_SUCCESS",
          { data: TaxAccount; parcelNumber: string },
      >;
  }

  Dispatch to fetch a tax account by parcel number.

  Example

  {
    type: "GET_TAX_ACCOUNT_BY_PARCEL_NUMBER_REQUEST",
    payload: {
      parcelNumber: "123-456-789"
    }
  }
  Copy

  {
    type: "GET_TAX_ACCOUNT_BY_PARCEL_NUMBER_SUCCESS",
    payload: {
      parcelNumber: "123-456-789",
      data: {
        parcelNumber: "123-456-789"
      }
    }
  }
  Copy

  {
    type: "GET_TAX_ACCOUNT_BY_PARCEL_NUMBER_FAILURE",
    payload: {
      parcelNumber: "123-456-789",
      error: "Not found"
    }
  }
  Copy

  See

  "module-payit-integration/lib/browser/reducers/search.reducer".taxAccountByParcel

• payBill: {
      failure: PayloadAC<"PAY_BILL_FAILURE", { error: string }>;
      request: PayloadAC<"PAY_BILL_REQUEST", CardBillPaymentRequest>;
      success: PayloadAC<"PAY_BILL_SUCCESS", BillPaymentResponse>;
  }

  Dispatch to submit a bill payment request.

  Example

  {
    type: "PAY_BILL_REQUEST",
    payload: {
      billId: "bill-id"
    }
  }
  Copy

  {
    type: "PAY_BILL_SUCCESS",
    payload: {
      id: "payment-id"
    }
  }
  Copy

  {
    type: "PAY_BILL_FAILURE",
    payload: {
      error: "Payment failed"
    }
  }
  Copy

  See

  "module-payit-integration/lib/browser/reducers/client.reducer".isClientInitiated

• recordPaymentPostLog: PayloadAC<
      "RECORD_PAYMENT_POST_LOG",
      { detail: PayItPaymentPostLogDetail; id: string },
  >

  Dispatch to record PayIt payment post-log details.

  Example

  {
    type: "RECORD_PAYMENT_POST_LOG",
    payload: {
      id: "payment-id",
      detail: {
        status: "success"
      }
    }
  }
  Copy

• searchAccountsByBusinessName: {
      failure: PayloadAC<
          "SEARCH_ACCOUNTS_BY_BUSINESS_NAME_FAILURE",
          { businessName: string; error: string },
      >;
      request: PayloadAC<
          "SEARCH_ACCOUNTS_BY_BUSINESS_NAME_REQUEST",
          { businessName: string },
      >;
      success: PayloadAC<
          "SEARCH_ACCOUNTS_BY_BUSINESS_NAME_SUCCESS",
          { businessName: string; data: TaxAccount[] },
      >;
  }

  Dispatch to search tax accounts by business name.

  Example

  {
    type: "SEARCH_ACCOUNTS_BY_BUSINESS_NAME_REQUEST",
    payload: {
      businessName: "Acme LLC"
    }
  }
  Copy

  {
    type: "SEARCH_ACCOUNTS_BY_BUSINESS_NAME_SUCCESS",
    payload: {
      businessName: "Acme LLC",
      data: []
    }
  }
  Copy

  {
    type: "SEARCH_ACCOUNTS_BY_BUSINESS_NAME_FAILURE",
    payload: {
      businessName: "Acme LLC",
      error: "Search failed"
    }
  }
  Copy

  See

  "module-payit-integration/lib/browser/reducers/search.reducer".accountsByBusinessName

• searchAccountsByOwnerName: {
      failure: PayloadAC<
          "SEARCH_ACCOUNTS_BY_OWNER_NAME_FAILURE",
          { error: string; ownerFirstName: string; ownerLastName: string },
      >;
      request: PayloadAC<
          "SEARCH_ACCOUNTS_BY_OWNER_NAME_REQUEST",
          { ownerFirstName: string; ownerLastName: string },
      >;
      success: PayloadAC<
          "SEARCH_ACCOUNTS_BY_OWNER_NAME_SUCCESS",
          { data: TaxAccount[]; ownerFirstName: string; ownerLastName: string },
      >;
  }

  Dispatch to search tax accounts by owner name.

  Example

  {
    type: "SEARCH_ACCOUNTS_BY_OWNER_NAME_REQUEST",
    payload: {
      ownerFirstName: "Jane",
      ownerLastName: "Doe"
    }
  }
  Copy

  {
    type: "SEARCH_ACCOUNTS_BY_OWNER_NAME_SUCCESS",
    payload: {
      ownerFirstName: "Jane",
      ownerLastName: "Doe",
      data: []
    }
  }
  Copy

  {
    type: "SEARCH_ACCOUNTS_BY_OWNER_NAME_FAILURE",
    payload: {
      ownerFirstName: "Jane",
      ownerLastName: "Doe",
      error: "Search failed"
    }
  }
  Copy

  See

  "module-payit-integration/lib/browser/reducers/search.reducer".accountsByOwnerName

• searchAccountsByStreetAddress: {
      failure: PayloadAC<
          "SEARCH_ACCOUNTS_BY_STREET_ADDRESS_FAILURE",
          { error: string; streetName: string; streetNumber: string },
      >;
      request: PayloadAC<
          "SEARCH_ACCOUNTS_BY_STREET_ADDRESS_REQUEST",
          { streetName: string; streetNumber: string },
      >;
      success: PayloadAC<
          "SEARCH_ACCOUNTS_BY_STREET_ADDRESS_SUCCESS",
          { data: TaxAccount[]; streetName: string; streetNumber: string },
      >;
  }

  Dispatch to search tax accounts by street address.

  Example

  {
    type: "SEARCH_ACCOUNTS_BY_STREET_ADDRESS_REQUEST",
    payload: {
      streetNumber: "123",
      streetName: "Main St"
    }
  }
  Copy

  {
    type: "SEARCH_ACCOUNTS_BY_STREET_ADDRESS_SUCCESS",
    payload: {
      streetNumber: "123",
      streetName: "Main St",
      data: []
    }
  }
  Copy

  {
    type: "SEARCH_ACCOUNTS_BY_STREET_ADDRESS_FAILURE",
    payload: {
      streetNumber: "123",
      streetName: "Main St",
      error: "Search failed"
    }
  }
  Copy

  See

  "module-payit-integration/lib/browser/reducers/search.reducer".accountsByStreetAddress

• setClientInitiated: PayloadAC<"CLIENT_INITIATED", boolean>

  Dispatch to set whether the payment flow is client-initiated.

  Example

  {
    type: "CLIENT_INITIATED",
    payload: true
  }
  Copy

  See

  "module-payit-integration/lib/browser/reducers/client.reducer".isClientInitiated