SP-754 Code Examples: Python

Author: mwarzybok-sumoheavy

examples/General/use_logger.py

@@ -0,0 +1,12 @@
+from bitpay.client import Client
+from bitpay.logger.bitpay_logger import BitPayLogger
+from bitpay.logger.logger_provider import LoggerProvider
+
+
+class UseLogger:
+
+    def execute(self) -> None:
+        LoggerProvider.set_logger(BitPayLogger())
+        client = Client.create_pos_client(self, "someToken")
+
+        client.get_invoice(self, "someId")

examples/Merchant/bill_requests.py

@@ -0,0 +1,38 @@
+from bitpay.models.bill.bill import Bill
+from bitpay.models.facade import Facade
+from examples.client_provider import ClientProvider
+
+
+class BillRequests:
+
+    def create_bill(self) -> None:
+        client = ClientProvider.create()
+
+        bill = Bill()
+        bill.name = 'someName'
+        bill.email = '[email protected]'
+        bill.address1 = 'SomeAddress'
+        bill.city = 'MyCity'
+        # ...
+
+        client.create_bill(bill, Facade.MERCHANT)
+
+    def get_bill(self) -> None:
+        client = ClientProvider.create()
+
+        bill = client.get_bill('someBillId', Facade.MERCHANT)
+
+        bills = client.get_bills('draft')
+
+    def update_bill(self) -> None:
+        client = ClientProvider.create()
+
+        bill = Bill()
+        bill.email = '[email protected]'
+
+        result = client.update_bill(bill, 'someBillId')
+
+    def deliver_bill_via_email(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.deliver_bill('someBillId', 'someBillToken')

examples/Merchant/invoice_requests.py

@@ -0,0 +1,57 @@
+from bitpay.models.facade import Facade
+from bitpay.models.invoice.buyer import Buyer
+from bitpay.models.invoice.invoice import Invoice
+from examples.client_provider import ClientProvider
+
+
+class InvoiceRequests:
+    def create_invoice(self) -> None:
+        invoice = Invoice()
+        invoice.full_notifications = True
+        invoice.extended_notifications = True
+        invoice.notification_url = "https://test/lJnJg9WW7MtG9GZlPVdj"
+        invoice.redirect_url = "https://test/lJnJg9WW7MtG9GZlPVdj"
+        invoice.notification_email = "[email protected]"
+
+        buyer = Buyer()
+        buyer.name = "Test"
+        buyer.email = "[email protected]"
+        buyer.address1 = "168 General Grove"
+        buyer.country = "AD"
+        buyer.locality = "Port Horizon"
+        buyer.notify = True
+        buyer.phone = "+990123456789"
+        buyer.postal_code = "KY7 1TH"
+        buyer.region = "New Port"
+
+        invoice.buyer = buyer
+
+        client = ClientProvider.create()
+
+        result = client.create_invoice(invoice, Facade.MERCHANT)
+
+    def get_invoice(self) -> None:
+        client = ClientProvider.create()
+
+        invoice_by_id = client.get_invoice('someInvoiceId')
+
+        invoice_by_guid = client.get_invoice_by_guid('someGuid')
+
+        invoices = client.get_invoices('2023-04-14', '2023-04-17')
+
+    def update_invoice(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.update_invoice('someInvoiceId', None, '123123213')
+
+    def cancel_invoice(self) -> None:
+        client = ClientProvider.create()
+
+        client.cancel_invoice('someInvoiceId')
+
+        client.cancel_invoice_by_guid('someGuid')
+
+    def request_invoice_webhook_to_be_resent(self) -> None:
+        client = ClientProvider.create()
+
+        client.request_invoice_notifications('someInvoiceId')

examples/Merchant/ledger_requests.py

@@ -0,0 +1,13 @@
+from examples.client_provider import ClientProvider
+
+
+class LedgerRequests:
+    def get_ledgers(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.get_ledgers()
+
+    def get_ledger_entries(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.get_ledger_entries('USD', '2023-08-14', '2023-08-22')

examples/Merchant/refund_requests.py

@@ -0,0 +1,32 @@
+from examples.client_provider import ClientProvider
+
+
+class RefundRequests:
+    def create_refund(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.create_refund('invoiceId', 12.34)
+
+    def update_refund(self) -> None:
+        client = ClientProvider.create()
+
+        client.update_refund('refundId', 'created')
+
+        client.update_refund_by_guid('someGuid', 'created')
+
+    def get_refund(self) -> None:
+        client = ClientProvider.create()
+
+        client.get_refund('refundId')
+
+        client.get_refund_by_guid('someGuid')
+
+    def cancel_refund(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.cancel_refund('someRefundId')
+
+    def request_refund_notification_to_be_resent(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.request_refund_notification('someRefundId')

examples/Merchant/settlement_requests.py

@@ -0,0 +1,15 @@
+from examples.client_provider import ClientProvider
+
+
+class SettlementRequests:
+    def get_settlement(self) -> None:
+        client = ClientProvider.create()
+
+        settlement = client.get_settlement('someSettlementId')
+
+        settlements = client.get_settlements('USD', '2023-08-14', '2023-08-22')
+
+    def fetch_reconciliation_report(self) -> None:
+        client = ClientProvider.create()
+
+        client.get_settlement_reconciliation_report('settlementId', 'settlementToken')

examples/Payout/payout_requests.py

@@ -0,0 +1,35 @@
+from bitpay.models.payout.payout import Payout
+from examples.client_provider import ClientProvider
+
+
+class PayoutRequests:
+    def createPayout(self) -> None:
+        client = ClientProvider.create()
+
+        payout = Payout()
+        payout.notification_email = '[email protected]'
+        payout.notification_url = 'https://my-url.com'
+
+        result = client.submit_payout(payout)
+
+        payouts = client.create_payout_group([payout])
+
+    def get_payout(self) -> None:
+        client = ClientProvider.create()
+
+        payout = client.get_payout('myPayoutId')
+
+        payouts = client.get_payouts('2023-08-14', '2023-08-22')
+
+    def cancel_payout(self) -> None:
+        client = ClientProvider.create()
+
+        client.cancel_payout('payoutId')
+
+        # payout_group = payout.group_id
+        client.cancel_payout_group('payoutGroupId')
+
+    def request_payout_webhook_to_be_resent(self) -> None:
+        client = ClientProvider.create()
+
+        client.request_payout_notification('somePayoutId')

examples/Payout/recipient_requests.py

@@ -0,0 +1,33 @@
+from bitpay.models.payout.payout_recipient import PayoutRecipient
+from bitpay.models.payout.payout_recipients import PayoutRecipients
+from examples.client_provider import ClientProvider
+
+
+class RecipientRequests:
+    def invite_recipients(self) -> None:
+        client = ClientProvider.create()
+
+        recipient = PayoutRecipient()
+        recipient.email = '[email protected]'
+
+        result = client.submit_payout_recipients(
+            PayoutRecipients(**{"recipients": [recipient]})
+        )
+
+    def get_recipient(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.get_payout_recipient('recipientId')
+
+    def update_recipient(self) -> None:
+        client = ClientProvider.create()
+
+        recipient = PayoutRecipient()
+        recipient.email = '[email protected]'
+
+        result = client.update_payout_recipient('recipientId', recipient)
+
+    def remove_recipient(self) -> None:
+        client = ClientProvider.create()
+
+        result = client.delete_payout_recipient('recipientId')

examples/Pos/bill_requests.py

@@ -0,0 +1,28 @@
+from bitpay.client import Client
+from bitpay.environment import Environment
+from bitpay.models.bill.bill import Bill
+from bitpay.models.facade import Facade
+
+
+class BillRequests:
+    def create_bill(self) -> None:
+        client = Client.create_pos_client('somePosToken', Environment.TEST.value)
+
+        bill = Bill()
+        bill.name = 'someName'
+        bill.email = '[email protected]'
+        bill.address1 = 'SomeAddress'
+        bill.city = 'MyCity'
+        # ...
+
+        result = client.create_bill(bill, Facade.POS, False)
+
+    def get_bill(self) -> None:
+        client = Client.create_pos_client('somePosToken', Environment.TEST.value)
+
+        result = client.get_bill('someBillId', Facade.POS, False)
+
+    def deliver_bill_via_email(self) -> None:
+        client = Client.create_pos_client('somePosToken', Environment.TEST.value)
+
+        result = client.deliver_bill('someBillId', 'token')

examples/Pos/invoice_requests.py

@@ -0,0 +1,37 @@
+from bitpay.client import Client
+from bitpay.environment import Environment
+from bitpay.models.facade import Facade
+from bitpay.models.invoice.buyer import Buyer
+from bitpay.models.invoice.invoice import Invoice
+
+
+class InvoiceRequests:
+    def create_invoice(self) -> None:
+        invoice = Invoice()
+        invoice.full_notifications = True
+        invoice.extended_notifications = True
+        invoice.notification_url = "https://test/lJnJg9WW7MtG9GZlPVdj"
+        invoice.redirect_url = "https://test/lJnJg9WW7MtG9GZlPVdj"
+        invoice.notification_email = "[email protected]"
+
+        buyer = Buyer()
+        buyer.name = "Test"
+        buyer.email = "[email protected]"
+        buyer.address1 = "168 General Grove"
+        buyer.country = "AD"
+        buyer.locality = "Port Horizon"
+        buyer.notify = True
+        buyer.phone = "+990123456789"
+        buyer.postal_code = "KY7 1TH"
+        buyer.region = "New Port"
+
+        invoice.buyer = buyer
+
+        client = Client.create_pos_client('somePosToken', Environment.TEST.value)
+
+        result = client.create_invoice(invoice, Facade.POS, False)
+
+    def get_invoice(self) -> None:
+        client = Client.create_pos_client('somePosToken', Environment.TEST.value)
+
+        invoice_by_id = client.get_invoice('someInvoiceId', Facade.POS, False)

examples/Public/rate_requests.py

@@ -0,0 +1,12 @@
+from examples.client_provider import ClientProvider
+
+
+class RateRequests:
+    def get_rate(self) -> None:
+        client = ClientProvider.create()
+
+        rates = client.get_rates()
+
+        currency_rates = client.get_currency_rates('BTC')
+
+        currency_pair_rate = client.get_currency_pair_rate('BTC', 'USD')

examples/Public/wallet_requests.py

@@ -0,0 +1,8 @@
+from examples.client_provider import ClientProvider
+
+
+class WalletRequests:
+    def get_supported_wallets(self) -> None:
+        client = ClientProvider.create()
+
+        rates = client.get_supported_wallets()

examples/client_provider.py

@@ -0,0 +1,8 @@
+from bitpay.client import Client
+
+
+class ClientProvider:
+
+    @staticmethod
+    def create() -> Client:
+        return Client.create_client_by_config_file_path("some/path")