18099 - PAY API - endpoint to add EFT Allowed flag to an account

pay-api/migrations/versions/2023_10_26_2ef58b39cafc_add_eft_enable_to_payment_accounts.py

@@ -0,0 +1,26 @@
+"""18099-eft allowed flag
+
+Revision ID: 2ef58b39cafc
+Revises: 194cdd7cf986
+Create Date: 2023-10-26 13:31:50.959562
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '2ef58b39cafc'
+down_revision = '194cdd7cf986'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.execute("set statement_timeout=20000;")
+    op.add_column('payment_accounts', sa.Column('eft_enable', sa.Boolean, nullable=True))
+
+
+def downgrade():
+    op.execute("set statement_timeout=20000;")
+    op.drop_column('payment_accounts', 'eft_enable')

pay-api/migrations/versions/2023_10_26_7d5231f2b9ac_update_eft_enable_payment_accounts.py

@@ -0,0 +1,33 @@
+"""18099-eft allowed flag
+
+Revision ID: 7d5231f2b9ac
+Revises: 2ef58b39cafc
+Create Date: 2023-10-26 13:55:46.291450
+
+"""
+from alembic import op
+
+
+# revision identifiers, used by Alembic.
+revision = '7d5231f2b9ac'
+down_revision = '2ef58b39cafc'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    """Update eft_enable in payment_accounts table."""
+    # eft_enable set to true when it has invoices paid with EFT/DIRECT_PAY payment method historically
+    op.execute("set statement_timeout=20000;")
+    conn = op.get_bind()
+    conn.execute('UPDATE payment_accounts \
+                            SET eft_enable = true \
+                            WHERE id IN ( \
+                                SELECT pa.id \
+                                FROM payment_accounts pa \
+                                RIGHT JOIN invoices i ON i.payment_account_id = pa.id \
+                                WHERE i.payment_method_code IN (\'EFT\', \'DIRECT_PAY\') \
+                            )')
+
+def downgrade():
+    pass

pay-api/src/pay_api/models/invoice.py

@@ -32,7 +32,7 @@
 from .base_schema import BaseSchema
 from .db import db, ma
 from .invoice_reference import InvoiceReferenceSchema
-from .payment_account import PaymentAccountSchema, PaymentAccountSearchModel
+from .payment_account import PaymentAccount, PaymentAccountSchema, PaymentAccountSearchModel
 from .payment_line_item import PaymentLineItem, PaymentLineItemSchema
 from .receipt import ReceiptSchema
 from ..utils.util import current_local_time

pay-api/src/pay_api/models/payment_account.py

@@ -47,6 +47,7 @@ class PaymentAccount(VersionedModel):  # pylint: disable=too-many-instance-attri
             'created_name',
             'created_on',
             'credit',
+            'eft_enable',
             'name',
             'pad_activation_date',
             'pad_tos_accepted_by',
@@ -77,6 +78,7 @@ class PaymentAccount(VersionedModel):  # pylint: disable=too-many-instance-attri
 
     credit = db.Column(db.Numeric(19, 2), nullable=True)
     billable = db.Column(Boolean(), default=True)
+    eft_enable = db.Column(Boolean(), default=False)
 
     # before this date , the account shouldn't get used
     pad_activation_date = db.Column(db.DateTime, nullable=True)

pay-api/src/pay_api/services/payment_account.py

@@ -29,6 +29,7 @@
 from pay_api.models import PaymentAccount as PaymentAccountModel
 from pay_api.models import PaymentAccountSchema
 from pay_api.models import StatementSettings as StatementSettingsModel
+from pay_api.models.invoice import Invoice
 from pay_api.services.cfs_service import CFSService
 from pay_api.services.distribution_code import DistributionCode
 from pay_api.services.queue_publisher import publish_response
@@ -68,6 +69,7 @@ def __init__(self):
         self._cfs_account_id: Optional[int] = None
         self._cfs_account_status: Optional[str] = None
         self._billable: Optional[bool] = None
+        self._eft_enable: Optional[bool] = None
 
     @property
     def _dao(self):
@@ -89,6 +91,7 @@ def _dao(self, value: PaymentAccountModel):
         self.pad_tos_accepted_date: datetime = self._dao.pad_tos_accepted_date
         self.credit: Decimal = self._dao.credit
         self.billable: bool = self._dao.billable
+        self.eft_enable: bool = self._dao.eft_enable
 
         cfs_account: CfsAccountModel = CfsAccountModel.find_effective_by_account_id(self.id)
         if cfs_account:
@@ -305,6 +308,17 @@ def billable(self, value: bool):
         self._billable = value
         self._dao.billable = value
 
+    @property
+    def eft_enable(self):
+        """Return the eft_enable."""
+        return self._eft_enable
+
+    @eft_enable.setter
+    def eft_enable(self, value: bool):
+        """Set the eft_enable."""
+        self._eft_enable = value
+        self._dao.eft_enable = value
+
     def save(self):
         """Save the information to the DB."""
         return self._dao.save()

queue_services/events-listener/src/events_listener/config.py

@@ -58,6 +58,7 @@ class _Config():  # pylint: disable=too-few-public-methods
     Used as the base for all the other configurations.
     """
 
+    LEGISLATIVE_TIMEZONE = os.getenv('LEGISLATIVE_TIMEZONE', 'America/Vancouver')
     PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__))
     PAY_LD_SDK_KEY = os.getenv('PAY_LD_SDK_KEY', None)