PTHMINT-38: Fix ruff problems code ANN001

examples/category_manager/get_categories.py

@@ -1,4 +1,5 @@
 import os
+from typing import List
 
 from dotenv import load_dotenv
 
@@ -27,6 +28,6 @@
     # print(get_categories_response)
 
     # Print the API response containing the categories
-    categories: list[Category] = get_categories_response.get_data()
+    categories: List[Category] = get_categories_response.get_data()
 
     print(categories)

examples/gateway_manager/get_gateways.py

@@ -1,4 +1,5 @@
 import os
+from typing import List
 
 from dotenv import load_dotenv
 
@@ -28,6 +29,6 @@
     # print(get_gateways_response)
 
     # Extract the listing of gateways from the response
-    gatewayListing: list[Gateway] = get_gateways_response.get_data()
+    gatewayListing: List[Gateway] = get_gateways_response.get_data()
 
     print(gatewayListing)

pyproject.toml

@@ -98,7 +98,6 @@ extend-safe-fixes = [
     "D415", # docstrings should end with a period, question mark, or exclamation point
 ]
 ignore = [
-    "ANN001",
     "ANN003",
     "ANN101", # missing type annotation for self
     "ANN102", # missing type annotation for cls

src/multisafepay/api/base/abstract_manager.py

@@ -5,6 +5,7 @@
 
 # See the DISCLAIMER.md file for disclaimer details.
 
+
 from multisafepay.client.client import Client
 
 

src/multisafepay/api/base/decorator.py

@@ -281,7 +281,7 @@ def adapt_brands(
 
         Parameters
         ----------
-        brands (Optional[list[Optional[dict]]]): A list of dictionaries containing brand information, by default None.
+        brands (Optional[List[Optional[dict]]]): A list of dictionaries containing brand information, by default None.
 
         Returns
         -------

src/multisafepay/api/base/listings/listing.py

@@ -30,7 +30,7 @@ def __init__(self, data: List[Any], class_type: type, **kwargs):
 
         Parameters
         ----------
-        data (list[Any]): A list of data to be converted into items of type T.
+        data (List[Any]): A list of data to be converted into items of type T.
         class_type (type): The class type to convert the data into.
         **kwargs: Additional keyword arguments to pass to the class type constructor.
 
@@ -59,7 +59,7 @@ def __iter__(self):
         """
         return iter(self.data)
 
-    def __getitem__(self, index):
+    def __getitem__(self: "Listing", index: int) -> T:
         """
         Get an item by index.
 

src/multisafepay/api/base/response/custom_api_response.py

@@ -22,7 +22,7 @@ class CustomApiResponse(ApiResponse):
 
     data: Optional[Any]
 
-    def __init__(self, data, **kwargs):
+    def __init__(self: "CustomApiResponse", data: Optional[Any], **kwargs):
         """
         Initialize the CustomApiResponse with optional data and additional keyword arguments.
 

src/multisafepay/api/paths/auth/auth_manager.py

@@ -12,6 +12,7 @@
     CustomApiResponse,
 )
 from multisafepay.api.paths.auth.api_token.response.api_token import ApiToken
+from multisafepay.client.client import Client
 from multisafepay.util.dict_utils import dict_empty
 from multisafepay.util.message import MessageList, gen_could_not_created_msg
 
@@ -21,13 +22,13 @@ class AuthManager(AbstractManager):
     A manager class for handling authentication-related operations.
     """
 
-    def __init__(self, client):
+    def __init__(self: "AuthManager", client: Client):
         """
         Initialize the CaptureManager with a client.
 
         Parameters
         ----------
-            client: The client used to make API requests.
+            client (Client): The client used to make API requests.
 
         """
         super().__init__(client)

src/multisafepay/api/paths/capture/capture_manager.py

@@ -16,6 +16,7 @@
     CaptureRequest,
 )
 from multisafepay.api.paths.capture.response.capture import CancelReservation
+from multisafepay.client.client import Client
 from multisafepay.util.dict_utils import dict_empty
 from multisafepay.util.message import MessageList, gen_could_not_created_msg
 
@@ -25,13 +26,13 @@ class CaptureManager(AbstractManager):
     A class to manage capture operations.
     """
 
-    def __init__(self, client):
+    def __init__(self: "CaptureManager", client: Client):
         """
         Initialize the CaptureManager with a client.
 
         Parameters
         ----------
-        client: The client used to make API requests.
+        client (Client): The client used to make API requests.
 
         """
         super().__init__(client)

src/multisafepay/api/paths/categories/category_manager.py

@@ -11,6 +11,7 @@
     CustomApiResponse,
 )
 from multisafepay.api.paths.categories.response.category import Category
+from multisafepay.client.client import Client
 from multisafepay.util.message import MessageList, gen_could_not_created_msg
 
 
@@ -19,13 +20,13 @@ class CategoryManager(AbstractManager):
     A manager class for handling category-related API requests.
     """
 
-    def __init__(self, client):
+    def __init__(self: "CategoryManager", client: Client):
         """
         Initialize the CategoryManager with a client.
 
         Parameters
         ----------
-        client: The client used to make API requests.
+        client (Client): The client used to make API requests.
 
         """
         super().__init__(client)

src/multisafepay/api/paths/gateways/gateway_manager.py

@@ -11,6 +11,7 @@
     CustomApiResponse,
 )
 from multisafepay.api.paths.gateways.response.gateway import Gateway
+from multisafepay.client.client import Client
 from multisafepay.util.dict_utils import dict_empty
 from multisafepay.util.message import MessageList, gen_could_not_created_msg
 
@@ -27,7 +28,21 @@ class GatewayManager(AbstractManager):
     Manages gateway-related operations.
     """
 
-    def get_gateways(self, include_coupons: bool = True) -> CustomApiResponse:
+    def __init__(self: "GatewayManager", client: Client):
+        """
+        Initialize the CategoryManager with a client.
+
+        Parameters
+        ----------
+        client (Client): The client used to make API requests.
+
+        """
+        super().__init__(client)
+
+    def get_gateways(
+        self: "GatewayManager",
+        include_coupons: bool = True,
+    ) -> CustomApiResponse:
         """
         Retrieve a list of gateways.
 

src/multisafepay/api/paths/issuers/issuer_manager.py

@@ -14,6 +14,7 @@
     ALLOWED_GATEWAY_CODES,
     Issuer,
 )
+from multisafepay.client.client import Client
 from multisafepay.exception.invalid_argument import InvalidArgumentException
 from multisafepay.util.message import MessageList, gen_could_not_created_msg
 
@@ -23,13 +24,13 @@ class IssuerManager(AbstractManager):
     Manager class for handling issuer-related operations.
     """
 
-    def __init__(self, client):
+    def __init__(self: "IssuerManager", client: Client):
         """
         Initialize the IssuerManager with a client.
 
         Parameters
         ----------
-        client: The client used to make API requests.
+        client (Client): The client used to make API requests.
 
         """
         super().__init__(client)

src/multisafepay/api/paths/me/me_manager.py

@@ -11,6 +11,7 @@
     CustomApiResponse,
 )
 from multisafepay.api.paths.me.response.me import Me
+from multisafepay.client.client import Client
 from multisafepay.util.dict_utils import dict_empty
 from multisafepay.util.message import MessageList, gen_could_not_created_msg
 
@@ -20,13 +21,13 @@ class MeManager(AbstractManager):
     A manager class for handling 'me' related API requests.
     """
 
-    def __init__(self, client):
+    def __init__(self, client: Client):
         """
         Initialize the MeManager with a client.
 
         Parameters
         ----------
-        client: The client used to make API requests.
+        client (Client): The client used to make API requests.
 
         """
         super().__init__(client)

src/multisafepay/api/paths/orders/order_id/refund/request/components/checkout_data.py

@@ -20,19 +20,19 @@ class CheckoutData(RequestModel):
 
     Attributes
     ----------
-    items (Optional[list[CartItem]]): The list of cart items.
+    items (Optional[List[CartItem]]): The list of cart items.
 
     """
 
     items: Optional[List[CartItem]]
 
-    def add_items(self, items=[]):
+    def add_items(self, items: List[CartItem] = ()):
         """
         Adds multiple items to the checkout data.
 
         Parameters
         ----------
-        items (list[CartItem]): The list of items to add.
+        items (List[CartItem]): The list of items to add.
 
         Returns
         -------
@@ -45,7 +45,7 @@ def add_items(self, items=[]):
             self.add_item(item)
         return self
 
-    def add_item(self, item):
+    def add_item(self, item: CartItem):
         """
         Adds a single item to the checkout data.
 
@@ -69,7 +69,7 @@ def get_items(self):
 
         Returns
         -------
-        list[CartItem]: The list of items.
+        List[CartItem]: The list of items.
 
         """
         return self.items
@@ -92,7 +92,7 @@ def get_item(self, index: int):
     def generate_from_shopping_cart(
         self,
         shopping_cart: ShoppingCart,
-        tax_table_selector="",
+        tax_table_selector: str = "",
     ):
         """
         Generates checkout data from a shopping cart.
@@ -110,13 +110,17 @@ def generate_from_shopping_cart(
                 shopping_cart_item.add_tax_table_selector(tax_table_selector)
             self.add_item(shopping_cart_item)
 
-    def refund_by_merchant_item_id(self, merchant_item_id, quantity=0):
+    def refund_by_merchant_item_id(
+        self,
+        merchant_item_id: str,
+        quantity: int = 0,
+    ):
         """
         Processes a refund by merchant item ID.
 
         Parameters
         ----------
-        merchant_item_id: The merchant item ID to refund.
+        merchant_item_id (str): The merchant item ID to refund.
         quantity (int): The quantity to refund.
 
         Raises
@@ -139,13 +143,13 @@ def refund_by_merchant_item_id(self, merchant_item_id, quantity=0):
 
         self.add_item(refund_item)
 
-    def get_item_by_merchant_item_id(self, merchant_item_id):
+    def get_item_by_merchant_item_id(self, merchant_item_id: str):
         """
         Retrieves an item by its merchant item ID.
 
         Parameters
         ----------
-        merchant_item_id: The merchant item ID to search for.
+        merchant_item_id (str): The merchant item ID to search for.
 
         Returns
         -------

src/multisafepay/api/paths/orders/order_manager.py

@@ -36,6 +36,7 @@
 from multisafepay.api.paths.orders.response.order_response import Order
 from multisafepay.api.shared.cart.shopping_cart import ShoppingCart
 from multisafepay.api.shared.description import Description
+from multisafepay.client.client import Client
 from multisafepay.util.dict_utils import dict_empty
 from multisafepay.util.message import MessageList, gen_could_not_created_msg
 from multisafepay.value_object.amount import Amount
@@ -47,13 +48,13 @@ class OrderManager(AbstractManager):
     Manages operations related to orders, such as creating, updating, capturing, and refunding orders.
     """
 
-    def __init__(self, client):
+    def __init__(self, client: Client):
         """
         Initialize the OrderManager with a client.
 
         Parameters
         ----------
-        client: The client used to make API requests.
+        client (Client): The client used to make API requests.
 
         """
         super().__init__(client)

src/multisafepay/api/paths/orders/request/order_request.py

@@ -257,13 +257,13 @@ def add_customer(self, customer: Customer) -> "OrderRequest":
         self.customer = customer
         return self
 
-    def add_gateway(self, gateway) -> "OrderRequest":
+    def add_gateway(self, gateway: str) -> "OrderRequest":
         """
         Adds the gateway to the order request.
 
         Parameters
         ----------
-        gateway: The gateway.
+        gateway (str): The gateway.
 
         Returns
         -------

src/multisafepay/api/paths/orders/response/order_response.py

@@ -36,7 +36,7 @@ class Order(ResponseModel):
     amount (Optional[int]): The amount of the order.
     amount_refunded (Optional[int]): The amount refunded.
     checkout_options (Optional[CheckoutOptions]): The checkout options.
-    costs (Optional[list[Costs]]): The costs of the order.
+    costs (Optional[List[Costs]]): The costs of the order.
     created (Optional[str]): The creation date of the order.
     modified (Optional[str]): The modification date of the order.
     currency (Optional[str]): The currency of the order.
@@ -50,10 +50,10 @@ class Order(ResponseModel):
     order_id (Optional[str]): The ID of the order.
     order_total (Optional[float]): The total amount of the order.
     payment_details (Optional[PaymentDetails]): The payment details.
-    payment_method (Optional[list[PaymentMethod]]): The payment methods.
+    payment_method (Optional[List[PaymentMethod]]): The payment methods.
     reason (Optional[str]): The reason for the order.
     reason_code (Optional[str]): The reason code for the order.
-    related_transactions (Optional[list[Transaction]]): The related transactions.
+    related_transactions (Optional[List[Transaction]]): The related transactions.
     shopping_cart (Optional[ShoppingCart]): The shopping cart.
     status (Optional[str]): The status of the order.
     transaction_id (Optional[str]): The ID of the transaction.