payme-pkg 3.3.0__cp312-cp312-macosx_10_13_universal2.whl

payme/__init__.py

@@ -0,0 +1 @@
+from payme.classes.client import Payme # noqa

payme/classes/client.py

@@ -0,0 +1,313 @@
+import typing as t
+
+from payme.const import Networks
+
+from payme.licensing import validate_api_key
+
+from payme.classes.cards import Cards
+from payme.classes.receipts import Receipts
+from payme.classes.initializer import Initializer
+from payme.types.response import cards as card_response
+from payme.types.response import receipts as receipt_response
+
+
+class Payme:
+    """
+    The payme class provides a simple interface
+    """
+
+    def __init__(
+        self,
+        payme_id: str,
+        fallback_id: t.Optional[str] = None,
+        payme_key: t.Optional[str] = None,
+        is_test_mode: bool = False,
+        license_api_key: t.Optional[str] = None,
+    ) -> None:
+        validate_api_key(license_api_key)
+
+        url = Networks.PROD_NET.value
+
+        if is_test_mode is True:
+            url = Networks.TEST_NET.value
+
+        self.cards = Cards(url=url, payme_id=payme_id)
+        self.initializer = Initializer(
+            payme_id=payme_id, fallback_id=fallback_id, is_test_mode=is_test_mode
+        )
+        if payme_key:
+            self.receipts = Receipts(url=url, payme_id=payme_id, payme_key=payme_key)
+
+    def cards_create(
+        self,
+        number: str,
+        expire: str,
+        save: bool = False,
+        timeout: int = 10
+    ) -> card_response.CardsCreateResponse:
+        """
+        Create a new card.
+
+        :param number: The card number.
+        :param expire: The expiration date of the card in MMYY format.
+        :param save: A boolean indicating whether to save the card for future
+            use (default is False).
+        :param timeout: The request timeout duration in seconds (default is
+            10 seconds).
+        :return: A CardsCreateResponse object containing the response data.
+        """
+        return self.cards.create(number=number, expire=expire, save=save, timeout=timeout)
+
+    def cards_get_verify_code(
+        self,
+        token: str,
+        timeout: int = 10
+    ) -> card_response.GetVerifyResponse:
+        """
+        Retrieve a verification code for a specified token.
+
+        :param token: The token associated with the card.
+        :param timeout: The request timeout duration in seconds (default is
+            10 seconds).
+        :return: A GetVerifyResponse object containing the response data.
+        """
+        return self.cards.get_verify_code(token=token, timeout=timeout)
+
+    def cards_verify(
+        self,
+        token: str,
+        code: str,
+        timeout: int = 10
+    ) -> card_response.VerifyResponse:
+        """
+        Verify a verification code for a specified token.
+
+        :param token: The token associated with the card.
+        :param code: The verification code to be verified.
+        :param timeout: The request timeout duration in seconds (default is
+            10 seconds).
+        :return: A VerifyResponse object containing the response data.
+        """
+        return self.cards.verify(token=token, code=code, timeout=timeout)
+
+    def cards_remove(
+        self,
+        token: str,
+        timeout: int = 10
+    ) -> card_response.RemoveResponse:
+        """
+        Remove a card from the Paycom system.
+
+        :param token: The token associated with the card.
+        :param timeout: The request timeout duration in seconds (default is
+            10 seconds).
+        :return: A RemoveResponse object containing the response data.
+        """
+        return self.cards.remove(token=token, timeout=timeout)
+
+    def cards_check(
+        self,
+        token: str,
+        timeout: int = 10
+    ) -> card_response.CheckResponse:
+        """
+        Check the status of a card.
+
+        :param token: The token associated with the card.
+        :param timeout: The request timeout duration in seconds (default is
+            10 seconds).
+        :return: A CheckResponse object containing the response data.
+        """
+        return self.cards.check(token=token, timeout=timeout)
+
+    def cards_test(self) -> None:
+        """
+        Run a comprehensive test suite for card functionalities including
+        creation, verification, status check, and removal.
+        """
+        return self.cards.test()
+
+    def receipts_create(
+        self,
+        account: dict,
+        amount: t.Union[float, int],
+        description: t.Optional[str] = None,
+        detail: t.Optional[t.Dict] = None,
+        timeout: int = 10,
+    ) -> receipt_response.CreateResponse:
+        """
+        Create a new receipt.
+
+        :param account: The account details for the receipt.
+        :param amount: The amount of the receipt.
+        :param description: Optional description for the receipt.
+        :param detail: Optional additional details for the receipt.
+        :param timeout: The request timeout duration in seconds (default 10).
+        """
+        return self.receipts.create(
+            account=account,
+            amount=amount,
+            description=description,
+            detail=detail,
+            timeout=timeout
+        )
+
+    def receipts_pay(
+        self,
+        receipts_id: str,
+        token: str,
+        timeout: int = 10
+    ) -> receipt_response.PayResponse:
+        """
+        Pay the receipt using a token.
+
+        :param receipts_id: The ID of the receipt used for payment.
+        :param token: The token associated with the card.
+        :param timeout: The request timeout duration in seconds (default is 10).
+        """
+        return self.receipts.pay(receipts_id=receipts_id, token=token, timeout=timeout)
+
+    def receipts_send(
+        self,
+        receipts_id: str,
+        phone: str,
+        timeout: int = 10
+    ) -> receipt_response.SendResponse:
+        """
+        Send the receipt to a mobile phone.
+
+        :param receipts_id: The ID of the receipt used for payment.
+        :param phone: The phone number to send the receipt to.
+        :param timeout: The request timeout duration in seconds (default 10).
+        """
+        return self.receipts.send(receipts_id=receipts_id, phone=phone, timeout=timeout)
+
+    def receipts_cancel(
+        self,
+        receipts_id: str,
+        timeout: int = 10
+    ) -> receipt_response.CancelResponse:
+        """
+        Cancel the receipt.
+
+        :param receipts_id: The ID of the receipt used for payment.
+        :param timeout: The request timeout duration in seconds (default 10).
+        """
+        return self.receipts.cancel(receipts_id=receipts_id, timeout=timeout)
+
+    def receipts_check(
+        self,
+        receipts_id: str,
+        timeout: int = 10
+    ) -> receipt_response.CheckResponse:
+        """
+        Check the status of a receipt.
+
+        :param receipts_id: The ID of the receipt used for payment.
+        :param timeout: The request timeout duration in seconds (default 10).
+        """
+        return self.receipts.check(receipts_id=receipts_id, timeout=timeout)
+
+    def receipts_get(
+        self,
+        receipts_id: str,
+        timeout: int = 10
+    ) -> receipt_response.GetResponse:
+        """
+        Get the details of a specific receipt.
+
+        :param receipts_id: The ID of the receipt used for payment.
+        :param timeout: The request timeout duration in seconds (default 10).
+        """
+        return self.receipts.get(receipts_id=receipts_id, timeout=timeout)
+
+    def receipts_get_all(
+        self,
+        count: int,
+        from_: int,
+        to: int,
+        offset: int,
+        timeout: int = 10
+    ) -> receipt_response.GetAllResponse:
+        """
+        Get all receipts for a specific account.
+
+        :param count: The number of receipts to retrieve.
+        :param from_: The start index of the receipts to retrieve.
+        :param to: The end index of the receipts to retrieve.
+        :param offset: The offset for pagination.
+        :param timeout: The request timeout duration in seconds (default 10).
+        """
+        return self.receipts.get_all(
+            count=count,
+            from_=from_,
+            to=to,
+            offset=offset,
+            timeout=timeout
+        )
+
+    def receipts_set_fiscal_data(
+        self,
+        receipt_id: str,
+        qr_code_url: str,
+        timeout: int = 10
+    ) -> receipt_response.SetFiscalDataResponse:
+        """
+        Set fiscal data for a receipt.
+
+        :param receipt_id: The ID of the receipt used for payment.
+        :param qr_code_url: URL of the fiscal check from the ofd.uz.
+        :param timeout: The request timeout duration in seconds (default 10).
+        """
+        return self.receipts.set_fiscal_data(
+            receipt_id=receipt_id,
+            qr_code_url=qr_code_url,
+            timeout=timeout
+        )
+
+    def receipts_test(self) -> None:
+        """
+        Run a comprehensive test suite for receipts functionalities.
+        """
+        if not hasattr(self, 'receipts'):
+            raise AttributeError("Receipts not initialized. Provide payme_key in constructor.")
+        return self.receipts.test()
+
+    def generate_pay_link(
+        self,
+        id: int,
+        amount: int,
+        return_url: str
+    ) -> str:
+        """
+        Generate a payment link for a specific order.
+
+        This method encodes the payment parameters into a base64 string and
+        constructs a URL for the Payme checkout.
+
+        :param id: Unique identifier for the account.
+        :param amount: The amount associated with the order in currency units.
+        :param return_url: The URL to which the user will be redirected after
+            the payment is processed.
+        :return: A payment link formatted as a URL, ready to be used in the
+            payment process.
+        """
+        return self.initializer.generate_pay_link(
+            id=id,
+            amount=amount,
+            return_url=return_url
+        )
+
+    def generate_fallback_link(
+        self,
+        form_fields: dict = None
+    ) -> str:
+        """
+        Generate a fallback URL for the Payme checkout.
+
+        :param form_fields: Additional query parameters to be appended to the
+            fallback URL.
+        :return: A fallback URL formatted as a URL, ready to be used in the
+            payment process.
+        """
+        return self.initializer.generate_fallback_link(form_fields=form_fields)

payme/exceptions/__init__.py

@@ -0,0 +1,5 @@
+"""
+init all payme exceptions
+"""
+from .general import * # noqa
+from .webhook import * # noqa

payme/migrations/0001_initial.py

@@ -0,0 +1,60 @@
+# Generated by Django 5.1.2 on 2024-12-22 05:15
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="PaymeTransactions",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("transaction_id", models.CharField(max_length=50)),
+                ("account_id", models.BigIntegerField()),
+                ("amount", models.DecimalField(decimal_places=2, max_digits=10)),
+                (
+                    "state",
+                    models.IntegerField(
+                        choices=[
+                            (0, "Created"),
+                            (1, "Initiating"),
+                            (2, "Successfully"),
+                            (-2, "Canceled after successful performed"),
+                            (-1, "Canceled during initiation"),
+                        ],
+                        default=0,
+                    ),
+                ),
+                ("cancel_reason", models.IntegerField(blank=True, null=True)),
+                ("created_at", models.DateTimeField(auto_now_add=True, db_index=True)),
+                ("updated_at", models.DateTimeField(auto_now=True, db_index=True)),
+                (
+                    "performed_at",
+                    models.DateTimeField(blank=True, db_index=True, null=True),
+                ),
+                (
+                    "cancelled_at",
+                    models.DateTimeField(blank=True, db_index=True, null=True),
+                ),
+            ],
+            options={
+                "verbose_name": "Payme Transaction",
+                "verbose_name_plural": "Payme Transactions",
+                "db_table": "payme_transactions",
+                "ordering": ["-created_at"],
+            },
+        ),
+    ]

payme/migrations/0002_paymetransactions_fiscal_data.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-03-14 08:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("payme", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="paymetransactions",
+            name="fiscal_data",
+            field=models.JSONField(blank=True, null=True),
+        ),
+    ]

payme/migrations/0003_alter_paymetransactions_fiscal_data.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-03-14 08:20
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("payme", "0002_paymetransactions_fiscal_data"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="paymetransactions",
+            name="fiscal_data",
+            field=models.JSONField(default=dict),
+        ),
+    ]

payme/migrations/0004_alter_paymetransactions_account_id.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.5 on 2025-08-25 19:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("payme", "0003_alter_paymetransactions_fiscal_data"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="paymetransactions",
+            name="account_id",
+            field=models.CharField(max_length=256),
+        ),
+    ]

payme/migrations/0005_alter_paymetransactions_amount.py

@@ -0,0 +1,19 @@
+# Generated migration to increase amount field precision
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("payme", "0004_alter_paymetransactions_account_id"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="paymetransactions",
+            name="amount",
+            field=models.DecimalField(decimal_places=2, max_digits=15),
+        ),
+    ]
+

payme/types/response/__init__.py

@@ -0,0 +1,4 @@
+"""
+init all response typing of payme provider
+"""
+from .webhook import * # noqa

payme/types/response/cards.py

@@ -0,0 +1,122 @@
+import typing as t
+import inspect
+from dataclasses import dataclass
+
+
+@dataclass
+class Common:
+    """
+    The common response structure.
+    """
+
+    @classmethod
+    def from_dict(cls, data: t.Dict):
+        """
+        Prepare fields for nested dataclasses
+        """
+        field_values = {}
+        for field in cls.__dataclass_fields__:
+            field_type = cls.__dataclass_fields__[field].type
+            field_data = data.get(field)
+
+            # Check if field_type is a class and subclass of Common
+            if isinstance(field_data, dict) and inspect.isclass(field_type) and issubclass(field_type, Common):
+                field_values[field] = field_type.from_dict(field_data)
+            else:
+                field_values[field] = field_data
+
+        return cls(**field_values)
+
+
+@dataclass
+class Card(Common):
+    """
+    The card object represents a credit card.
+    """
+
+    number: str
+    expire: str
+    token: str
+    recurrent: bool
+    verify: bool
+    type: str
+    number_hash: t.Optional[str] = None
+
+
+@dataclass
+class Result(Common):
+    """
+    The result object contains the created card.
+    """
+
+    card: Card
+
+
+@dataclass
+class CardsCreateResponse(Common):
+    """
+    The cards.create response.
+    """
+
+    jsonrpc: str
+    result: Result
+
+
+@dataclass
+class VerifyResult(Common):
+    """
+    The result object for the verification response.
+    """
+
+    sent: bool
+    phone: str
+    wait: int
+
+
+@dataclass
+class GetVerifyResponse(Common):
+    """
+    The verification response structure.
+    """
+
+    jsonrpc: str
+    result: VerifyResult
+
+
+@dataclass
+class VerifyResponse(Common):
+    """
+    The verification response structure.
+    """
+
+    jsonrpc: str
+    result: Result
+
+
+@dataclass
+class RemoveCardResult(Common):
+    """
+    The result object for the removal response.
+    """
+
+    success: bool
+
+
+@dataclass
+class RemoveResponse(Common):
+    """
+    The remove response structure.
+    """
+
+    jsonrpc: str
+    result: RemoveCardResult
+
+
+@dataclass
+class CheckResponse(Common):
+    """
+    The check response structure.
+    """
+
+    jsonrpc: str
+    result: Result