[ADD] developer: tutorial for integrating with a payment provider

task-2804999

Makefile

@@ -26,7 +26,7 @@ SOURCE_DIR     = content
 
 HTML_BUILD_DIR = $(BUILD_DIR)/html
 ifdef VERSIONS
-  HTML_BUILD_DIR := $(HTML_BUILD_DIR)/master
+  HTML_BUILD_DIR := $(HTML_BUILD_DIR)/16.0
 endif
 ifneq ($(CURRENT_LANG),en)
   HTML_BUILD_DIR := $(HTML_BUILD_DIR)/$(CURRENT_LANG)

README.md

@@ -4,11 +4,11 @@
 
 ### Requirements
 
-- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git)
-- [Python 3.7 or 3.8](https://www.odoo.com/documentation/master/contributing/documentation.html#python)
-- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/master/requirements.txt).
-- [Make](https://www.odoo.com/documentation/master/contributing/documentation.html#make)
-- A local copy of the [odoo/odoo repository in master](https://github.com/odoo/odoo/tree/master) (Optional)
+- [Git](https://www.odoo.com/documentation/16.0/contributing/documentation.html#install-git)
+- [Python 3.7 or 3.8](https://www.odoo.com/documentation/16.0/contributing/documentation.html#python)
+- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/16.0/requirements.txt).
+- [Make](https://www.odoo.com/documentation/16.0/contributing/documentation.html#make)
+- A local copy of the [odoo/odoo repository in 16.0](https://github.com/odoo/odoo/tree/16.0) (Optional)
 
 ### Instructions
 
@@ -23,7 +23,7 @@
 
 2. Open the file `documentation/_build/html/index.html` in your web browser to display the render.
 
-3. See [this guide](https://www.odoo.com/documentation/master/contributing/documentation.html#preview-your-changes)
+3. See [this guide](https://www.odoo.com/documentation/16.0/contributing/documentation.html#preview-your-changes)
    for more detailed instructions.
 
 Optional: to fully build the developer documentation with inline docstrings for documented Python
@@ -34,7 +34,7 @@ be shown.
 ## Contribute to the documentation
 
 For contributions to the content of the documentation, please refer to the
-[Introduction Guide](https://www.odoo.com/documentation/master/contributing/documentation.html).
+[Introduction Guide](https://www.odoo.com/documentation/16.0/contributing/documentation.html).
 
 To **report a content issue**, **request new content** or **ask a question**, use the
 [repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual.
@@ -43,4 +43,4 @@ To **report a content issue**, **request new content** or **ask a question**, us
 
 To learn more about Odoo, in addition to the documentation, have a look at
 [the official eLearning](https://odoo.com/slides) and
-[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).
+[Scale-up, The Business Game](https://www.odoo.com/page/scale-up-business-game).

conf.py

@@ -22,7 +22,7 @@ copyright = 'Odoo S.A.'
 # `version` if the version info for the project being documented, acts as replacement for |version|,
 # also used in various other places throughout the built documents.
 # `release` is the full version, including alpha/beta/rc tags. Acts as replacement for |release|.
-version = release = 'master'
+version = release = '16.0'
 
 # The minimal Sphinx version required to build the documentation.
 needs_sphinx = '3.0.0'
@@ -95,7 +95,7 @@ else:
     import odoo.addons
     odoo.addons.__path__.append(str(odoo_dir) + '/addons')
     from odoo import release as odoo_release  # Don't collide with Sphinx's 'release' config option
-    odoo_version = odoo_release.version.replace('~', '-')  # Change saas~XX.Y to saas-XX.Y
+    odoo_version = '.'.join(str(s) for s in odoo_release.version_info[:2]).replace('~', '-')  # Change saas~XX.Y to saas-XX.Y
     odoo_version = 'master' if 'alpha' in odoo_release.version else odoo_version
     if release != odoo_version:
         _logger.warning(
@@ -186,6 +186,7 @@ sphinx.transforms.i18n.docname_to_domain = (
 # The version names that should be shown in the version switcher, if the config option `versions`
 # is populated. If a version is passed to `versions` but is not listed here, it will not be shown.
 versions_names = {
+    '16.0': "Odoo 16",
     'master': "Master",
     'saas-15.2': "Odoo Online",
     '15.0': "Odoo 15",

content/administration/install/install.rst

@@ -547,7 +547,7 @@ Dependencies
          .. tab:: Debian/Ubuntu
 
             For Debian-based systems, the packages are listed in the `debian/control
-            <https://github.com/odoo/odoo/blob/master/debian/control>`_ file of the Odoo sources.
+            <https://github.com/odoo/odoo/blob/16.0/debian/control>`_ file of the Odoo sources.
 
             On Debian/Ubuntu, the following commands should install the required packages:
 

content/administration/maintain/domain_names.rst

@@ -62,11 +62,11 @@ database manager.
    - This offer doesn't include any mailbox. However, you can :ref:`configure your MX records
      <domain-name/odoo-manage>` to use your own email server or solution such as Google Workspace.
 
-To do so, go to :menuselection:`Website --> Go to website --> Promote --> Domain Name`.
-Alternatively, open your `database manager <https://www.odoo.com/my/databases>`_, click on the
-:guilabel:`settings` button next to your database, then on :guilabel:`Domain names`.
+To do so, go to :menuselection:`Website --> Domain Name`. Alternatively, open your `database manager
+<https://www.odoo.com/my/databases>`_, click on the :guilabel:`settings` button next to your
+database, then on :guilabel:`Domain names`.
 
-.. image:: domain_names/register-promote.png
+.. image:: domain_names/register-menu.png
    :align: center
    :alt: Clicking on Domain Names from an Odoo website
 

content/applications/finance/accounting/bank/feeds/ponto.rst

@@ -64,8 +64,8 @@ Link your Ponto account with your Odoo database
 #. Finish the flow.
 
 .. note::
-   You have to authorize all the accounts you want to access in Odoo but, Odoo will filter the
-   accounts based on the institution you selected at the second step.
+   You have to authorize all the accounts you want to access in Odoo, but Odoo will filter the
+   accounts based on the institution you selected in the second step.
 
 Update your synchronization credentials
 ---------------------------------------

content/applications/inventory_and_mrp/manufacturing/management/product_variants.rst

@@ -1,35 +1,45 @@
-=======================
-Variants BOM Management
-=======================
+==================================
+Managing BoMs for product variants
+==================================
 
-Odoo allows you to use one bill of materials for multiple variants of
-the same product. To activate variants, simply go to :menuselection:`Configuration --> Settings
---> Variants`.
+Odoo allows one bill of materials (BoM) to be used for multiple variants of the same product.
+Having a consolidated BoM for a product with variants saves time by preventing the need to manage
+multiple BoMs.
 
-.. image:: product_variants/bom-variants1.png
-    :align: center
+Activate product variants
+=========================
 
-You will then be able to specify which BOM component lines are to be used in
-the manufacture of each product variant. You may specify multiple
-variants for each line. If no variant is specified on a component line,
-then this component will be used in the BOM of all variants. 
+To activate variants, simply navigate to :menuselection:`Inventory --> Configuration --> Settings
+--> Products`, and then enable the :guilabel:`Variants` option. After that, click :guilabel:`Save`
+to apply the setting. For more information on configuring product variants, refer to :doc:`this
+page <../../../sales/sales/products_prices/products/variants>`.
 
-When defining variant BoMs on a line-item-basis, the **Product
-Variant** field in the main section of the BoM should be left blank as shown 
-below. This field is used when creating a BoM for one specific variant
-of a product only.
+.. image:: product_variants/inventory-variants-settings.png
+   :align: center
+   :alt: Selecting "Variants" from Inventory app settings.
 
+Apply BoM components to product variants
+========================================
 
-.. image:: product_variants/kit-bom1.png
-    :align: center
+Next, create a new BoM or edit an existing one by going to :menuselection:`Manufacturing -->
+Products --> Bills of Materials`. Then, click :guilabel:`Edit`. The :guilabel:`Apply on Variants`
+option to assign components to specific product variants on the BoM is available once the
+:guilabel:`Variants` setting is activated from the :guilabel:`Inventory` application. If the
+:guilabel:`Apply on Variants` field is not immediately visible, activate it from the additional
+options menu.
 
-Note that the same principle applies for the configuration 
-of operations.
+.. image:: product_variants/variants-kebab-menu.png
+   :align: center
+   :alt: "Apply on Variants" option on the additional options menu.
 
-.. image:: product_variants/kit-bom2.png
-    :align: center
+Each component can be assigned to multiple variants. Components with no variants specified are used
+in every variant of the product. The same principle applies when configuring operations and
+by-products.
 
-And for the production of by-products. 
+When defining variant BoMs by component assignment, the :guilabel:`Product Variant` field in the
+main section of the BoM should be left blank, as shown below. This field is used only when creating
+a BoM specifically for one product variant.
 
-.. image:: product_variants/kit-bom3.png
-    :align: center
+.. image:: product_variants/apply-on-variants-bom.png
+   :align: center
+   :alt: Applying components to multiple variants.

content/contributing/documentation.rst

@@ -218,7 +218,7 @@ Python comes with its own package manager: `pip
 a single command.
 
 #. Download and install the recommended release (`see README file
-   <https://github.com/odoo/documentation/tree/master/README.md>`_) of **Python 3** on your machine.
+   <https://github.com/odoo/documentation/tree/16.0/README.md>`_) of **Python 3** on your machine.
 #. Make sure to have **pip** installed on your machine (on Windows, you can install pip alongside
    Python).
 #. Execute the following commands in a terminal to verify that both installations finished

content/developer/howtos.rst

@@ -15,4 +15,5 @@ Tutorials
     howtos/profilecode
     howtos/company
     howtos/accounting_localization
+    howtos/payment_provider
     howtos/translations

content/developer/howtos/payment_provider.rst

@@ -0,0 +1,7 @@
+=================================
+Integrate with a payment provider
+=================================
+
+.. currentmodule:: odoo.addons.payment.payment_provider.PaymentProvider
+
+test: :meth:`._compute_feature_support_fields`.

content/developer/howtos/rdtraining/05_securityintro.rst

@@ -18,7 +18,7 @@ Data Files (CSV)
 Odoo is a highly data driven system. Although behavior is customized using Python code, part of a
 module's value is in the data it sets up when loaded. One way to load data is through a CSV
 file. One example is the
-`list of country states <https://github.com/odoo/odoo/blob/master/odoo/addons/base/data/res.country.state.csv>`__
+`list of country states <https://github.com/odoo/odoo/blob/16.0/odoo/addons/base/data/res.country.state.csv>`__
 which is loaded at installation of the ``base`` module.
 
 .. code-block:: text

content/developer/reference/backend/testing.rst

@@ -598,7 +598,7 @@ Javascript
 #. Add any step you want.
 
 Every step contains at least a trigger. You can either use the `predefined steps
-<https://github.com/odoo/odoo/blob/master/addons/web_tour/static/src/js/tour_step_utils.js>`_ or write
+<https://github.com/odoo/odoo/blob/16.0/addons/web_tour/static/src/js/tour_step_utils.js>`_ or write
 your own personalized step.
 
 Here are some example of steps:

content/developer/reference/standard_modules.rst

@@ -8,3 +8,4 @@ Standard modules
     :titlesonly:
 
     standard_modules/account
+    standard_modules/payment

content/developer/reference/standard_modules/payment.rst

@@ -0,0 +1,12 @@
+y:hide-page-toc:
+
+=======
+Payment
+=======
+
+.. toctree::
+   :titlesonly:
+
+   payment/payment_provider
+   payment/payment_transaction
+   payment/payment_token

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

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

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