update: uz and ru langs

PayTechUz · Nov 23, 2023 · 3377387 · 3377387
1 parent 8f18939
commit 3377387
Show file tree

Hide file tree

Showing 12 changed files with 1,904 additions and 7 deletions.
diff --git a/docs/src/en/payme-pkg/initializing-payments.md b/docs/src/en/payme-pkg/initializing-payments.md
@@ -5,7 +5,7 @@ description: Initializing payments
 
 # [Generate pay link](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/generate_link.py){:target="_blank"}
 
-- Example
+> Example
 ```python
 from pprint import pprint
 
@@ -19,7 +19,7 @@ pay_link = GeneratePayLink(
 
 pprint(pay_link)
 ```
-- Output
+> Output
 ```shell
 https://checkout.paycom.uz/bT01ZTczMGU4ZTBiODUyYTQxN2FhNDljZWI7YWMub3JkZXItaWQ9OTk5O2E9OTk5OTtjPXlvdXItY2FsbGJhY2stdXJs
 ```
@@ -34,7 +34,8 @@ https://checkout.paycom.uz/bT01ZTczMGU4ZTBiODUyYTQxN2FhNDljZWI7YWMub3JkZXItaWQ9O
 
 ### Methods
 - generate_link() -> to generate payment link.
-> Does not take any arguments
+> **Does not take any arguments**
+
 - to_tiyin() -> convert from sum to tiyin.
 
 | Argument | Type    | Description                  |

diff --git a/docs/src/en/payme-pkg/setup.md b/docs/src/en/payme-pkg/setup.md
@@ -14,6 +14,7 @@ Unix-based OS
 pip3 install payme-pkg
 ```
 <br/>
+
 # Setup (django)
 1. Add `'payme'` to your installed apps
 ```python

diff --git a/docs/src/ru/payme-pkg/index.md b/docs/src/ru/payme-pkg/index.md
@@ -2,4 +2,8 @@
 title: Введение
 ---
 
-# **Добро пожаловать!**
+# **Введение**
+
+Добро пожаловать в документацию нашего пакета [payme-pkg](https://github.com/PayTechUz/payme-pkg/tree/master){:target="_blank"}.
+
+Продолжайте читать документацию. Смотреть [раздел настройки](setup/).
diff --git a/docs/src/ru/payme-pkg/initializing-payments.md b/docs/src/ru/payme-pkg/initializing-payments.md
@@ -0,0 +1,49 @@
+---
+title: Инициализация платежей
+description: Инициализация платежей
+---
+
+# [Generate pay link](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/generate_link.py){:target="_blank"}
+
+> Пример
+```python
+from pprint import pprint
+
+from payme.methods.generate_link import GeneratePayLink
+
+pay_link = GeneratePayLink(
+  order_id="999",
+  amount=9999,
+  callback_url="callback-url"
+).generate_link()
+
+pprint(pay_link)
+```
+> Результат
+```shell
+https://checkout.paycom.uz/bT01ZTczMGU4ZTBiODUyYTQxN2FhNDljZWI7YWMub3JkZXItaWQ9OTk5O2E9OTk5OTtjPXlvdXItY2FsbGJhY2stdXJs
+```
+
+- Параметры
+
+| Аргумент     | Тип     | Описание                                                                                                                                                     |
+|--------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| order_id     | str     | _Oбязательный_. ID заказа для оплаты                                                                                                                         |
+| amount       | Decimal | _Oбязательный_. Сумма принадлежит заказу                                                                                                                     |
+| callback_url | str     | _Необязательный_. URL обратного вызова API продавца, который будет перенаправлен после оплаты. По умолчанию требуется PAYME_CALL_BACK_URL из ваших настроек. |
+
+### Методы
+- generate_link() -> создать ссылку для оплаты.
+> **Не принимает никаких аргументов**
+
+- to_tiyin() -> перевести сум в тийин.
+
+| Аргумент | Тип     | Описание                     |
+|----------|---------|------------------------------|
+| amount   | Decimal | _Oбязательный_. Сумма заказа |
+
+- to_sum() -> convert from tiyin to sum.
+
+| Аргумент | Тип     | Описание                     |
+|----------|---------|------------------------------|
+| amount   | Decimal | _Oбязательный_. Сумма заказа |
diff --git a/docs/src/ru/payme-pkg/merchant-api.md b/docs/src/ru/payme-pkg/merchant-api.md
@@ -4,3 +4,39 @@ description: Методы Merchant API
 ---
 
 # Методы Merchant API
+
+### [CheckPerformTransaction](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/check_perform_transaction.py){:target="_blank"}
+_Это используется для проверки выполнения транзакции_
+> **Не имеет методов**
+
+
+### [CreateTransaction](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/create_transaction.py){:target="_blank"}
+_Это используется для создания транзакции_
+
+
+#### Методы
+- _convert_ms_to_datetime() -> конвертировать время из мс в формат даты и времени
+
+| Аргумент | Тип  | Описание                               |
+|----------|------|----------------------------------------|
+| time_ms  | int  | _Oбязательный_. Время конвертации в мс |
+
+
+### [PerformTransaction](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/perform_transaction.py){:target="_blank"}
+_Это используется для выполнения транзакции_
+> **Не имеет методов**
+
+
+### [CancelTransaction](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/cancel_transaction.py){:target="_blank"}
+_Используется для отмены транзакции_
+> **Не имеет методов**
+
+
+### [CheckTransaction](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/check_transaction.py){:target="_blank"}
+_Это используется для проверки транзакции_
+> **Не имеет методов**
+
+
+### [GetStatement](https://github.com/PayTechUz/payme-pkg/blob/master/lib/payme/methods/get_statement.py){:target="_blank"}
+_Информация о транзакциях используется для сверки транзакций продавца и Payme Business._
+> **Не имеет методов**
diff --git a/docs/src/ru/payme-pkg/setup.md b/docs/src/ru/payme-pkg/setup.md
@@ -3,4 +3,74 @@ title: Настройка
 description: Настройка
 ---
 
-# Настройка
+# Установка
+Windows
+```shell
+pip install payme-pkg
+```
+
+Unix-based OS
+```shell
+pip3 install payme-pkg
+```
+<br/>
+
+# Настройка (Джанго)
+1. Добавьте `'payme'` в установленные приложения.
+```python
+INSTALLED_APPS = [
+    ...
+    'payme',
+    ...
+]
+```
+
+2. Добавьте учетные данные `'payme'` в свои настройки.
+```python
+PAYME: dict = {
+    'PAYME_ID': 'payme-id',
+    'PAYME_KEY': 'payme-key',
+    'PAYME_URL': 'payme-checkout-url',
+    'PAYME_CALL_BACK_URL': 'your-callback-url', # merchant api callback url
+    'PAYME_MIN_AMOUNT': 'payme-min-amount', # integer field
+    'PAYME_ACCOUNT': 'order-id',
+}
+
+ORDER_MODEL = 'your_app.models.Your_Order_Model'
+```
+
+3. Создайте новое представление об обработке обратных вызовов.
+```python
+from payme.views import MerchantAPIView
+
+
+class PaymeCallBackAPIView(MerchantAPIView):
+    def create_transaction(self, order_id, action, *args, **kwargs) -> None:
+        print(f"create_transaction for order_id: {order_id}, response: {action}")
+
+    def perform_transaction(self, order_id, action, *args, **kwargs) -> None:
+        print(f"perform_transaction for order_id: {order_id}, response: {action}")
+
+    def cancel_transaction(self, order_id, action, *args, **kwargs) -> None:
+        print(f"cancel_transaction for order_id: {order_id}, response: {action}")
+```
+
+4. Добавьте путь `payme` в ядро URL-шаблонов.
+```python
+from django.urls import path
+
+from your_app.views import PaymeCallBackAPIView
+
+urlpatterns = [
+    ...
+    path("payments/merchant/", PaymeCallBackAPIView.as_view()),
+    ...
+]
+```
+
+5. Запуск миграции
+```shell
+python manage.py makemigrations
+```
+
+> 🎉 Поздравляем, вы интегрировали методы торгового API с Django, продолжайте читать документацию. После успешной миграции проверьте панель администратора и посмотрите, что произошло.