[16.0][ADD] sale_loyalty_order_suggestion_multi_gift: New module

sale_loyalty_order_suggestion_multi_gift/README.rst

@@ -0,0 +1,97 @@
+========================================
+Sale Loyalty Order Suggestion Multi Gift
+========================================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:3d28a9d1cda5d30a6d82161cb677692ee77bd9708deadb6b8b1cdbe2a3b4aa02
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fsale--promotion-lightgray.png?logo=github
+    :target: https://github.com/OCA/sale-promotion/tree/16.0/sale_loyalty_order_suggestion_multi_gift
+    :alt: OCA/sale-promotion
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/sale-promotion-16-0/sale-promotion-16-0-sale_loyalty_order_suggestion_multi_gift
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/sale-promotion&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module extends the functionality of `sale_loyalty_order_suggestion` by giving hints
+of available promotions whose reward is multi-gift and whose rules require a minimum quantity of products.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+To use this module:
+
+* Configure or create a promotion and set in its rules a minimum quantity of products required.
+* Create a sales order and add one of the products that were part of the rewards to the order lines. This line will be marked with an icon (🎁) that will appear at the bottom right.
+* Click on the icon and the wizard will open with the available promotions.
+* Select the promotion and the products needed to apply it.
+
+Known issues / Roadmap
+======================
+
+For the moment only suggestions for promotions whose multi-gift rewards include products
+added to the sales order and whose rules have product-based criteria will be taken into
+account. This module could be extended to take into account other types of rules in the
+loyalty programs to be able to apply the promotion from the wizard.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/sale-promotion/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/sale-promotion/issues/new?body=module:%20sale_loyalty_order_suggestion_multi_gift%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Tecnativa
+
+Contributors
+~~~~~~~~~~~~
+
+* `Tecnativa <https://www.tecnativa.com>`_:
+
+  * Pilar Vargas
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/sale-promotion <https://github.com/OCA/sale-promotion/tree/16.0/sale_loyalty_order_suggestion_multi_gift>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

sale_loyalty_order_suggestion_multi_gift/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from . import wizard

sale_loyalty_order_suggestion_multi_gift/__manifest__.py

@@ -0,0 +1,14 @@
+# Copyright 2024 Tecnativa - Pilar Vargas
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+{
+    "name": "Sale Loyalty Order Suggestion Multi Gift",
+    "summary": "Suggest promotions with rewards multi gift in the sale order line",
+    "version": "16.0.1.0.0",
+    "development_status": "Beta",
+    "category": "Sale",
+    "website": "https://github.com/OCA/sale-promotion",
+    "author": "Tecnativa, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "depends": ["sale_loyalty_order_suggestion", "sale_loyalty_multi_gift"],
+    "installable": True,
+}

sale_loyalty_order_suggestion_multi_gift/models/__init__.py

@@ -0,0 +1 @@
+from . import sale_order

sale_loyalty_order_suggestion_multi_gift/models/sale_order.py

@@ -0,0 +1,24 @@
+# Copyright 2024 Tecnativa - Pilar Vargas
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+from odoo import models
+
+
+class SaleOrder(models.Model):
+    _inherit = "sale.order"
+
+    def _available_programs(self):
+        self.ensure_one()
+        filtered_programs = self._filter_programs_by_rules_with_products()
+        programs_with_reward_multi_gift = filtered_programs.filtered(
+            lambda x: any(reward.reward_type == "multi_gift" for reward in x.reward_ids)
+        )
+        programs = self.env["loyalty.program"]
+        if programs_with_reward_multi_gift:
+            product_id = self.env.context.get("product_id")
+            programs += programs_with_reward_multi_gift.filtered(
+                lambda x: any(
+                    product_id in reward.loyalty_multi_gift_ids.reward_product_ids.ids
+                    for reward in x.reward_ids
+                )
+            )
+        return super()._available_programs() + programs

sale_loyalty_order_suggestion_multi_gift/readme/CONTRIBUTORS.rst

@@ -0,0 +1,3 @@
+* `Tecnativa <https://www.tecnativa.com>`_:
+
+  * Pilar Vargas

sale_loyalty_order_suggestion_multi_gift/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+This module extends the functionality of `sale_loyalty_order_suggestion` by giving hints
+of available promotions whose reward is multi-gift and whose rules require a minimum quantity of products.

sale_loyalty_order_suggestion_multi_gift/readme/ROADMAP.rst

@@ -0,0 +1,4 @@
+For the moment only suggestions for promotions whose multi-gift rewards include products
+added to the sales order and whose rules have product-based criteria will be taken into
+account. This module could be extended to take into account other types of rules in the
+loyalty programs to be able to apply the promotion from the wizard.

sale_loyalty_order_suggestion_multi_gift/readme/USAGE.rst

@@ -0,0 +1,6 @@
+To use this module:
+
+* Configure or create a promotion and set in its rules a minimum quantity of products required.
+* Create a sales order and add one of the products that were part of the rewards to the order lines. This line will be marked with an icon (🎁) that will appear at the bottom right.
+* Click on the icon and the wizard will open with the available promotions.
+* Select the promotion and the products needed to apply it.