Python (#4)

LuboZ · lubos.zlatohlavek · web-flow · commit 3b1fedcedebf · 2025-05-07T14:51:11.000+02:00
* triv: #23799 wip: python documentation

* triv: #23799 wip: python documentation - added chargeback and save card section

* triv: #23799 wip: python documentation - added preuthorization, updated create payment code

* triv: #23799 wip: python documentation - added direct payment section

* triv: #23799 added cancel payment section

* triv: #23799 code samples and appearance section

* triv: #23799 added logger section

* triv: #23799 moved redirect uri parameter from client initialization, changed indent in python code

* triv: #23799 moved redirect uri parameter from client initialization, changed indent in python code

* triv: #23799 added error handling section

* triv: #23799 added error handling section

* triv: #23799 added full payment to create payment code example

* triv: #23799 added ip_address as parameter to create_payment

* triv: #23799 renamed simple statuses

* triv: #23799 moved base_url from client initialization added mode parameter

* triv: #23799 added node logging documentation

* triv: #23799 install command

* triv: #23799 renamed client to TBPlusSDK

* triv: #23799 added simple status mapping info

* triv: #23799 added simple status mapping info

---------

Co-authored-by: lubos.zlatohlavek &lt;lubos.zlatohlavek@smartbase.sk&gt;
diff --git a/code_samples/python/v1.0.0/cancel_payment.py b/code_samples/python/v1.0.0/cancel_payment.py
@@ -1,6 +1,6 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret"
 )
diff --git a/code_samples/python/v1.0.0/chargeback.py b/code_samples/python/v1.0.0/chargeback.py
@@ -1,7 +1,7 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.models import *
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret"
 )
diff --git a/code_samples/python/v1.0.0/confirm_cancel_pre_authorization.py b/code_samples/python/v1.0.0/confirm_cancel_pre_authorization.py
@@ -1,7 +1,7 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.models import *
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret"
 )
diff --git a/code_samples/python/v1.0.0/create_payment.py b/code_samples/python/v1.0.0/create_payment.py
@@ -1,7 +1,7 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.models import *
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret",
 )
diff --git a/code_samples/python/v1.0.0/create_payment_pre_authorization.py b/code_samples/python/v1.0.0/create_payment_pre_authorization.py
@@ -1,7 +1,7 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.models import *
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret",
 )
diff --git a/code_samples/python/v1.0.0/get_access_token.py b/code_samples/python/v1.0.0/get_access_token.py
@@ -1,6 +1,6 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret",
 )
diff --git a/code_samples/python/v1.0.0/get_available_payment_methods.py b/code_samples/python/v1.0.0/get_available_payment_methods.py
@@ -1,6 +1,6 @@
-from tatrapayplus import TatrapayPlusClient, PaymentMethod
+from tatrapayplus import TBPlusSDK, PaymentMethod
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret",
 )
diff --git a/code_samples/python/v1.0.0/get_payment_status.py b/code_samples/python/v1.0.0/get_payment_status.py
@@ -1,6 +1,6 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret",
 )
diff --git a/code_samples/python/v1.0.0/set_colors.py b/code_samples/python/v1.0.0/set_colors.py
@@ -1,7 +1,7 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.models import *
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret"
 )
diff --git a/code_samples/python/v1.0.0/set_logo.py b/code_samples/python/v1.0.0/set_logo.py
@@ -1,7 +1,7 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.models import *
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret"
 )
diff --git a/code_samples/python/v1.0.0/update_payment.py b/code_samples/python/v1.0.0/update_payment.py
@@ -1,7 +1,7 @@
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.models import *
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",
     "your-client-secret"
 )
diff --git a/docs/libraries/node/v1.0.0/process_payment.mdx b/docs/libraries/node/v1.0.0/process_payment.mdx
@@ -41,7 +41,16 @@ import getPaymentStatus from '!!raw-loader!@site/code_samples/node/v1.0.0/getPay
 
 <CodeBlock language="jsx">{getPaymentStatus}</CodeBlock>
 
-Result includes a `simpleStatus` attribute that can have one of three values: `AUTHORIZED`,`CAPTURE`,`PENDING` or `REJECTED`.
+Result includes a `simpleStatus` attribute that can have one of three values: `AUTHORIZED`, `CAPTURE` or `REJECTED`.
+
+| Payment Method | CAPTURE                      | REJECTED   | AUTHORIZED |
+|----------------|-----------------------------------------|----------------------|----------------------|
+| QR_PAY         | ACSC, ACCC                              | CANC, RJCT           |                      |
+| BANK_TRANSFER  | ACSC, ACCC                              | CANC, RJCT           |                      |
+| PAY_LATER      | LOAN_APPLICATION_FINISHED, LOAN_DISBURSED | CANCELED, EXPIRED    |                      |
+| CARD_PAY       | OK, CB                                  | FAIL                 | PA                   |
+| DIRECT_API     | OK, CB                                  | FAIL                 |                      |
+
 Your implementation should take the appropriate action based on the value of `simpleStatus`.
 
 `data` attribute contains all the information based on structure described in [API reference](/docs/api/get-payment-intent-status).
diff --git a/docs/libraries/python/v1.0.0/create_payment.mdx b/docs/libraries/python/v1.0.0/create_payment.mdx
@@ -4,7 +4,7 @@ import createPayment from '!!raw-loader!@site/code_samples/python/v1.0.0/create_
 
 # Create Payment
 
-To create a payment using the Python SDK, call the `TatrapayPlusClient.create_payment()` method.
+To create a payment using the Python SDK, call the `TBPlusSDK.create_payment()` method.
 
 <details>
   <summary>Click to see example for all payment methods</summary>
diff --git a/docs/libraries/python/v1.0.0/errors_handling.mdx b/docs/libraries/python/v1.0.0/errors_handling.mdx
@@ -1,7 +1,7 @@
 
 # Handling errors
 
-When using the `TatrapayPlusClient`, all API requests are wrapped with internal error handling logic. If the API returns an error, a custom exception **`TatrapayPlusApiException`** is raised. This allows you to catch and respond to failures in a structured way.
+When using the `TBPlusSDK`, all API requests are wrapped with internal error handling logic. If the API returns an error, a custom exception **`TatrapayPlusApiException`** is raised. This allows you to catch and respond to failures in a structured way.
 
 ## Basic usage
 
diff --git a/docs/libraries/python/v1.0.0/index.mdx b/docs/libraries/python/v1.0.0/index.mdx
@@ -9,13 +9,13 @@ pip install tatrapayplus-python
 ```
 # Client Initialization
 
-To start working with the API, you need to initialize the `TatrapayPlusClient` with the following parameters:
+To start working with the API, you need to initialize the `TBPlusSDK` with the following parameters:
 
 ```python
-from tatrapayplus import TatrapayPlusClient
+from tatrapayplus import TBPlusSDK
 from tatrapayplus.enums import Mode
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     "your-client-id",                                  # Client ID
     "your-client-secret",                              # Client secret
     mode=Mode.SANDBOX,                                 # Mode you are working with: SANDBOX or PRODUCTION
diff --git a/docs/libraries/python/v1.0.0/logging.mdx b/docs/libraries/python/v1.0.0/logging.mdx
@@ -5,7 +5,7 @@ import TabItem from '@theme/TabItem';
 
 # TatrapayPlusLogger
 
-The `TatrapayPlusLogger` is a simple and customizable HTTP logger for the `TatrapayPlusClient`.
+The `TatrapayPlusLogger` is a simple and customizable HTTP logger for the `TBPlusSDK`.
 It helps you debug API calls by logging outgoing requests and incoming responses, while safely masking sensitive data.
 
 ---
@@ -54,11 +54,11 @@ class FileLogger(TatrapayPlusLogger):
 ### Step 2: Inject the Logger into the Client
 
 ```python
-from tatrapayplus.client import TatrapayPlusClient
+from tatrapayplus.client import TBPlusSDK
 
 logger = ConsoleLogger()
 
-client = TatrapayPlusClient(
+client = TBPlusSDK(
     client_id="your-client-id",
     client_secret="your-client-secret",
     redirect_uri="https://yourapp.com/redirect",
diff --git a/docs/libraries/python/v1.0.0/process_payment.mdx b/docs/libraries/python/v1.0.0/process_payment.mdx
@@ -41,7 +41,15 @@ import getPaymentStatus from '!!raw-loader!@site/code_samples/python/v1.0.0/get_
 
 <CodeBlock language="python">{getPaymentStatus}</CodeBlock>
 
-Result includes a `simple_status` attribute that can have one of three values: `ACCEPTED`, `PENDING`, or `REJECTED`.
+Result includes a `simple_status` attribute that can have one of three values: `CAPTURE`, `AUTHORIZED`, or `REJECTED`.
+| Payment Method | CAPTURE                      | REJECTED   | AUTHORIZED |
+|----------------|-----------------------------------------|----------------------|----------------------|
+| QR_PAY         | ACSC, ACCC                              | CANC, RJCT           |                      |
+| BANK_TRANSFER  | ACSC, ACCC                              | CANC, RJCT           |                      |
+| PAY_LATER      | LOAN_APPLICATION_FINISHED, LOAN_DISBURSED | CANCELED, EXPIRED    |                      |
+| CARD_PAY       | OK, CB                                  | FAIL                 | PA                   |
+| DIRECT_API     | OK, CB                                  | FAIL                 |                      |
+
 Your implementation should take the appropriate action based on the value of `simple_status`.
 
 `data` attribute contains all the information based on structure described in [API reference](/docs/api/get-payment-intent-status).

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-from tatrapayplus import TatrapayPlusClient`
	`1`	`+from tatrapayplus import TBPlusSDK`
`2`	`2`
`3`		`-client = TatrapayPlusClient(`
	`3`	`+client = TBPlusSDK(`
`4`	`4`	`"your-client-id",`
`5`	`5`	`"your-client-secret"`
`6`	`6`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`		`-from tatrapayplus import TatrapayPlusClient`
	`1`	`+from tatrapayplus import TBPlusSDK`
`2`	`2`	`from tatrapayplus.models import *`
`3`	`3`
`4`		`-client = TatrapayPlusClient(`
	`4`	`+client = TBPlusSDK(`
`5`	`5`	`"your-client-id",`
`6`	`6`	`"your-client-secret"`
`7`	`7`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-from tatrapayplus import TatrapayPlusClient, PaymentMethod`
	`1`	`+from tatrapayplus import TBPlusSDK, PaymentMethod`
`2`	`2`
`3`		`-client = TatrapayPlusClient(`
	`3`	`+client = TBPlusSDK(`
`4`	`4`	`"your-client-id",`
`5`	`5`	`"your-client-secret",`
`6`	`6`	`)`