From 668ac2c65072644aaf383af4762e6f8cbb16c979 Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Fri, 30 Sep 2022 12:35:05 +0000 Subject: [PATCH] [ADD] reference/standard_modules: API reference for the payment engine task-2804999 closes odoo/documentation#2782 Related: odoo/odoo#101756 Signed-off-by: Antoine Vandevenne (anv) --- .../developer/reference/standard_modules.rst | 1 + .../reference/standard_modules/payment.rst | 12 +++++++++ .../payment/payment_provider.rst | 17 ++++++++++++ .../payment/payment_token.rst | 12 +++++++++ .../payment/payment_transaction.rst | 26 +++++++++++++++++++ 5 files changed, 68 insertions(+) create mode 100644 content/developer/reference/standard_modules/payment.rst create mode 100644 content/developer/reference/standard_modules/payment/payment_provider.rst create mode 100644 content/developer/reference/standard_modules/payment/payment_token.rst create mode 100644 content/developer/reference/standard_modules/payment/payment_transaction.rst diff --git a/content/developer/reference/standard_modules.rst b/content/developer/reference/standard_modules.rst index 7eeb3a113..a766111a0 100644 --- a/content/developer/reference/standard_modules.rst +++ b/content/developer/reference/standard_modules.rst @@ -8,3 +8,4 @@ Standard modules :titlesonly: standard_modules/account + standard_modules/payment diff --git a/content/developer/reference/standard_modules/payment.rst b/content/developer/reference/standard_modules/payment.rst new file mode 100644 index 000000000..c5d0591b1 --- /dev/null +++ b/content/developer/reference/standard_modules/payment.rst @@ -0,0 +1,12 @@ +:hide-page-toc: + +======= +Payment +======= + +.. toctree:: + :titlesonly: + + payment/payment_provider + payment/payment_token + payment/payment_transaction diff --git a/content/developer/reference/standard_modules/payment/payment_provider.rst b/content/developer/reference/standard_modules/payment/payment_provider.rst new file mode 100644 index 000000000..9793c6659 --- /dev/null +++ b/content/developer/reference/standard_modules/payment/payment_provider.rst @@ -0,0 +1,17 @@ +:hide-page-toc: + +================ +Payment Provider +================ + +.. autoclass:: odoo.addons.payment.models.payment_provider.PaymentProvider() + + .. automethod:: _compute_feature_support_fields + .. automethod:: _compute_fees + .. automethod:: _compute_view_configuration_fields + .. automethod:: _get_compatible_providers + .. automethod:: _get_redirect_form_view + .. automethod:: _get_validation_amount + .. automethod:: _get_validation_currency + .. automethod:: _is_tokenization_required + .. automethod:: _should_build_inline_form diff --git a/content/developer/reference/standard_modules/payment/payment_token.rst b/content/developer/reference/standard_modules/payment/payment_token.rst new file mode 100644 index 000000000..52eee58ff --- /dev/null +++ b/content/developer/reference/standard_modules/payment/payment_token.rst @@ -0,0 +1,12 @@ +:hide-page-toc: + +============= +Payment Token +============= + +.. autoclass:: odoo.addons.payment.models.payment_token::PaymentToken() + + .. automethod:: _build_display_name + .. automethod:: _get_specific_create_values + .. automethod:: _handle_archiving + .. automethod:: get_linked_records_info diff --git a/content/developer/reference/standard_modules/payment/payment_transaction.rst b/content/developer/reference/standard_modules/payment/payment_transaction.rst new file mode 100644 index 000000000..1be8939af --- /dev/null +++ b/content/developer/reference/standard_modules/payment/payment_transaction.rst @@ -0,0 +1,26 @@ +:hide-page-toc: + +=================== +Payment Transaction +=================== + +.. autoclass:: odoo.addons.payment.models.payment_transaction::PaymentTransaction() + + .. automethod:: _compute_reference + .. automethod:: _compute_reference_prefix + .. automethod:: _get_post_processing_values + .. automethod:: _get_specific_create_values + .. automethod:: _get_specific_processing_values + .. automethod:: _get_specific_rendering_values + .. automethod:: _get_tx_from_notification_data + .. automethod:: _handle_notification_data + .. automethod:: _process_notification_data + .. automethod:: _send_capture_request + .. automethod:: _send_payment_request + .. automethod:: _send_refund_request + .. automethod:: _send_void_request + .. automethod:: _set_authorized + .. automethod:: _set_canceled + .. automethod:: _set_done + .. automethod:: _set_error + .. automethod:: _set_pending