Fix indentation

Author: jonasborges-stark

CHANGELOG.md

@@ -14,7 +14,7 @@ Given a version number MAJOR.MINOR.PATCH, increment:
 
 ## [Unreleased]
 ### Added
-- merchantSession and merchantSessionPurchase resources
+- MerchantSession and MerchantSessionPurchase resources
 
 ## [2.26.1] - 2025-02-18
 ### Fixed

README.md

@@ -49,8 +49,10 @@ is as easy as sending a text message to your client!
     - [CorporateBalance](#get-your-corporatebalance): View your corporate balance
     - [CorporateTransactions](#query-corporatetransactions): View the transactions that have affected your corporate balance
     - [CorporateEnums](#corporate-enums): Query enums related to the corporate purchases, such as merchant categories, countries and card purchase methods
-    - [MerchantSession](#merchant-session): The Merchant Session allows you to create a session prior to a purchase. Sessions are essential for defining the parameters of a purchase, including funding type, expiration, 3DS, and more.
-    - [MerchantPurchase](#merchant-purchase): The Merchant Purchase resource can be used to charge customers with credit or debit cards. If a card hasn't been used before, a Merchant Session Purchase must be created and approved with that specific card before it can be used directly in a Merchant Purchase.
+    - [MerchantCard](#query-merchantcard): The Merchant Card resource stores information about cards used in approved purchases. These cards can be used in new purchases without the need to create a new session.
+    - [MerchantSession](#create-a-merchantsession): The Merchant Session allows you to create a session prior to a purchase. Sessions are essential for defining the parameters of a purchase, including funding type, expiration, 3DS, and more.
+    - [MerchantPurchase](#create-a-merchantpurchase): The Merchant Purchase resource can be used to charge customers with credit or debit cards. If a card hasn't been used before, a Merchant Session Purchase must be created and approved with that specific card before it can be used directly in a Merchant Purchase.
+    - [MerchantInstallment](#query-merchantinstallment): Merchant Installments are created for every installment in a purchase. These resources will track its own due payment date and settlement lifecycle.
     - [Split](#query-splits): Split received Invoice payments between different receivers
     - [SplitReceiver](#create-splitreceivers): Receiver of an Invoice split
     - [Webhooks](#create-a-webhook-subscription): Configure your webhook endpoints and subscriptions
@@ -2334,13 +2336,36 @@ log = starkbank.splitreceiver.log.get("5155165527080960")
 
 print(log)
 ```
-## Merchant Session
 
-The Merchant Session allows you to create a session prior to a purchase.
-Sessions are essential for defining the parameters of a purchase, including funding type, expiration, 3DS, and more.
+## Merchant Card
+
+The Merchant Card resource stores information about cards used in approved purchases.
+These cards can be used in new purchases without the need to create a new session.
+
+## Query MerchantCard
+
+```python
+import starkbank
+
+merchant_cards = starkbank.merchantcard.query(limit=3)
+for merchant_card in merchant_cards:
+    print(merchant_card)
+```
+
+## Get a MerchantCard
+
+```python
+import starkbank
+
+merchantcard = starkbank.merchantcard.get('5950134772826112')
+print(merchantcard)
+```
 
 ## Create a MerchantSession
 
+The Merchant Session allows you to create a session prior to a purchase.
+Sessions are essential for defining the parameters of a purchase, including funding type, expiration, 3DS, and more.
+
 ```python
 import starkbank
 
@@ -2355,18 +2380,18 @@ merchant_session = starkbank.merchantsession.create({
             "count": 1
         },
         {
-            "totalAmount": 120,
+            "totalAmount": 12000,
             "count": 2
         },
         {
-            "totalAmount": 180,
+            "totalAmount": 18000,
             "count": 12
         }
     ],
     "expiration": 3600,
     "challengeMode": "disabled",
     "tags": [
-        "yourTags"
+        "your-tags"
     ]
 })
 
@@ -2376,105 +2401,132 @@ print(merchant_session)
 You can create a MerchantPurchase through a MerchantSession by passing its UUID.
 **Note**: This method must be implemented in your front-end to ensure that sensitive card data does not pass through the back-end of the integration.
 
-### Create a MerchantSession Purchase
+## Create a MerchantSession Purchase
 
 ```python
 import starkbank
 
 merchant_session_purchase = starkbank.merchantsession.purchase(
-  uuid="0bb894a2697d41d99fe02cad2c00c9bc",
-  amount=180,
-  installment_count=12,
-  card_expiration="2035-01",
-  card_number="5448280000000007",
-  card_security_code="123",
-  holder_name="Margaery Tyrell",
-  holder_email="[email protected]",
-  holder_phone="11998663456",
-  funding_type="credit",
-  billing_country_code="BRA",
-  billing_city="São Paulo",
-  billing_state_code="SP",
-  billing_street_line1="Rua do Jardim de cima, 123",
-  billing_street_line2="1 andar",
-  billing_zip_code="11111-111",
-  metadata={
-    "extraData": "extraData",
-    "language": "pt-BR",
-    "timezoneOffset": 3,
-    "userAgent": "Mozilla",
-    "userIp": "255.255.255.255"
-  }
-)
+      uuid="0bb894a2697d41d99fe02cad2c00c9bc",
+      amount=18000,
+      installment_count=12,
+      card_expiration="2035-01",
+      card_number="5448280000000007",
+      card_security_code="123",
+      holder_name="Margaery Tyrell",
+      holder_email="[email protected]",
+      holder_phone="11998663456",
+      funding_type="credit",
+      billing_country_code="BRA",
+      billing_city="São Paulo",
+      billing_state_code="SP",
+      billing_street_line1="Rua do Jardim de cima, 123",
+      billing_street_line2="1 andar",
+      billing_zip_code="11111-111",
+      metadata={
+        "extraData": "extraData",
+        "language": "pt-BR",
+        "timezoneOffset": 3,
+        "userAgent": "Mozilla",
+        "userIp": "255.255.255.255"
+      }
+    )
 
 print(merchant_session_purchase)
 ```
-### Query MerchantSessions
+
+## Query MerchantSessions
+
 ```python
 import starkbank
 
 merchant_sessions = starkbank.merchantsession.query(limit=3)
 for merchant_session in merchant_sessions:
     print(merchant_session)
 ```
-### Get a MerchantSession
+
+## Get a MerchantSession
+
 ```python
 import starkbank
 
 merchant_session = starkbank.merchantsession.get('5950134772826112')
 print(merchant_session)
 ```
-## Merchant Purchase
+
+## Create a MerchantPurchase
+
 The Merchant Purchase resource can be used to charge customers with credit or debit cards.
 If a card hasn't been used before, a Merchant Session Purchase must be created and approved with that specific card before it can be used directly in a Merchant Purchase.
 
-### Create a MerchantPurchases
 ```python
 import starkbank
 
 merchant_purchase = starkbank.merchantpurchase.create(
-            starkbank.MerchantPurchase(
-                amount=10000,
-                installment_count=5,
-                card_id="6295415968235520",
-                funding_type="credit",
-                challenge_mode="disabled",
-                billing_city="Sao Paulo",
-                billing_country_code="BRA",
-                billing_state_code="SP",
-                billing_street_line_1="Rua Casterly Rock, 2000",
-                billing_street_line_2="1 andar",
-                billing_zip_code="11111-111",
-                holder_email="[email protected]",
-                holder_phone="11985923451",
-                metadata={
-                    "userAgent": "userAgent",
-                    "userIp": "255.255.255.255",
-                    "language": "pt-BR",
-                    "timezoneOffset": 3,
-                    "extraData": "extraData"
-                },
-                tags=["teste"]
-            )
-        )
-```
-
-### Query MerchantPurchases
+    starkbank.MerchantPurchase(
+        amount=10000,
+        installment_count=5,
+        card_id="6295415968235520",
+        funding_type="credit",
+        challenge_mode="disabled",
+        billing_city="Sao Paulo",
+        billing_country_code="BRA",
+        billing_state_code="SP",
+        billing_street_line_1="Rua Casterly Rock, 2000",
+        billing_street_line_2="1 andar",
+        billing_zip_code="11111-111",
+        holder_email="[email protected]",
+        holder_phone="11985923451",
+        metadata={
+            "userAgent": "userAgent",
+            "userIp": "255.255.255.255",
+            "language": "pt-BR",
+            "timezoneOffset": 3,
+            "extraData": "extraData"
+        },
+        tags=["teste"]
+    )
+)
+```
+
+## Query MerchantPurchases
+
 ```python
 import starkbank
 
 merchant_purchases = starkbank.merchantpurchase.query(limit=3)
 for merchant_purchase in merchant_purchases:
     print(merchant_purchase)
 ```
-### Get a MerchantPurchase
+
+## Get a MerchantPurchase
+
 ```python
 import starkbank
 
 merchant_purchase = starkbank.merchantpurchase.get('5950134772826112')
 print(merchant_purchase)
 ```
 
+## Query MerchantInstallment
+
+```python
+import starkbank
+
+merchant_installments = starkbank.merchantinstallment.query(limit=3)
+for merchant_installment in merchant_installments:
+    print(merchant_installment)
+```
+
+## Get a MerchantInstallment
+
+```python
+import starkbank
+
+merchant_installment = starkbank.merchantinstallment.get('5950134772826112')
+print(merchant_installment)
+```
+
 ## Create a webhook subscription
 
 To create a webhook subscription and be notified whenever an event occurs, run:

starkbank/merchantcard/__merchantcard.py

@@ -1,13 +1,14 @@
-from starkcore.utils.resource import Resource
 from ..utils import rest
+from starkcore.utils.resource import Resource
 from starkcore.utils.checks import check_date, check_datetime, check_datetime_or_date
 
 class MerchantCard(Resource):
     """# MerchantCard object
     Check out our API Documentation at https://starkbank.com/docs/api#merchant-card
     """
 
-    def __init__(self, id=None, ending=None , funding_type=None, holder_name=None, network=None, status=None, tags=None, expiration=None, created=None, updated=None):
+    def __init__(self, id=None, ending=None , funding_type=None, holder_name=None, network=None, status=None, tags=None,
+                 expiration=None, created=None, updated=None):
         Resource.__init__(self, id=id)
         self.ending = ending
         self.funding_type = funding_type
@@ -19,8 +20,10 @@ def __init__(self, id=None, ending=None , funding_type=None, holder_name=None, n
         self.created = check_datetime(created)
         self.updated = check_datetime(updated)
 
+
 _resource = {"class": MerchantCard, "name": "MerchantCard"}
 
+
 def get(id, user=None):
     return rest.get_id(resource=_resource, id=id, user=user)
 

starkbank/merchantcard/log/__init__.py

@@ -1 +1 @@
-from .__log import query, page, get
+from .__log import query, page, get

starkbank/merchantcard/log/__log.py

@@ -1,23 +1,24 @@
-from starkcore.utils.resource import Resource
 from ...utils import rest
+from starkcore.utils.resource import Resource
 from starkcore.utils.api import from_api_json
-from starkcore.utils.checks import check_date
+from starkcore.utils.checks import check_date, check_datetime
 from ..__merchantcard import _resource as _merchant_card_resource
 
 
 class Log(Resource):
-    """# MerchantCard object
+    """# MerchantCard.Log object
     Check out our API Documentation at https://starkbank.com/docs/api#merchant-card
     """
 
     def __init__(self, id, created, updated, type, errors, card):
         Resource.__init__(self, id=id)
-        self.created = check_date(created)
-        self.updated = check_date(updated)
+        self.created = check_datetime(created)
+        self.updated = check_datetime(updated)
         self.type = type
         self.errors = errors
         self.card = from_api_json(_merchant_card_resource, card)
 
+
 _resource = {"class": Log, "name": "MerchantCardLog"}
 
 

starkbank/merchantinstallment/__merchantinstallment.py

@@ -1,5 +1,5 @@
-from starkcore.utils.resource import Resource
 from ..utils import rest
+from starkcore.utils.resource import Resource
 from starkcore.utils.checks import check_date, check_datetime, check_datetime_or_date
 
 
@@ -8,7 +8,8 @@ class MerchantInstallment(Resource):
     Check out our API Documentation at https://starkbank.com/docs/api#merchant-installment
     """
 
-    def __init__(self, id=None, amount=None, created=None, due=None, fee=None, funding_type=None, network=None, purchase_id=None, status=None, tags=None, transaction_ids=None, updated=None):
+    def __init__(self, id=None, amount=None, created=None, due=None, fee=None, funding_type=None, network=None,
+                 purchase_id=None, status=None, tags=None, transaction_ids=None, updated=None):
         Resource.__init__(self, id=id)
 
         self.amount = amount
@@ -23,8 +24,10 @@ def __init__(self, id=None, amount=None, created=None, due=None, fee=None, fundi
         self.created = check_datetime(created)
         self.updated = check_datetime(updated)
 
+
 _resource = {"class": MerchantInstallment, "name": "MerchantInstallment"}
 
+
 def get(id, user=None):
     return rest.get_id(resource=_resource, id=id, user=user)
 

starkbank/merchantinstallment/log/__log.py

@@ -1,23 +1,24 @@
-from starkcore.utils.resource import Resource
 from ...utils import rest
+from starkcore.utils.resource import Resource
 from starkcore.utils.api import from_api_json
-from starkcore.utils.checks import check_date
+from starkcore.utils.checks import check_date, check_datetime
 from ..__merchantinstallment import _resource as _merchant_installment_resource
 
 
 class Log(Resource):
-    """# MerchantInstallment object
+    """# MerchantInstallment.Log object
     Check out our API Documentation at https://starkbank.com/docs/api#merchant-installment
     """
 
     def __init__(self, id, created, updated, type, errors, installment):
         Resource.__init__(self, id=id)
-        self.created = check_date(created)
-        self.updated = check_date(updated)
+        self.created = check_datetime(created)
+        self.updated = check_datetime(updated)
         self.type = type
         self.errors = errors
         self.installment = from_api_json(_merchant_installment_resource, installment)
 
+
 _resource = {"class": Log, "name": "MerchantInstallmentLog"}