William BraeckmanandCarlos Valverde
9bb9eaf067
This module is an unification of `coupon`, `gift_card` and an extraction of the program models of `pos_loyalty`. The goal of this module is to unify the creation of coupon, promotion, gift_card, loyalty programs etc.. into a single base module and share the same models. Managers will be able to create programs based on rules and rewards. Programs may apply on the current order (rules and rewards) or on future orders, where the rules must match the first order to get a reward on the second order or even be nominative and accumulate points over multiple orders. Every program is based on a point system. And each use of the program will result in the creation of a coupon (except for nominative programs which should be limited to one card per customer). A rule may filter on quantity, money spent and products and give points on the order, the amount of units paid or the amount of money spent. A reward could be a free product, a discount or (with an additional module) free shipping. Discounts can be percentage based, fixed, or based on the amount of points the card has. They can also be filtered on products or tags, to discount specific products. A new feature is also being able to select communication plan for these programs. The manager can define a template to be sent upon the creation of a new coupon/card or when reaching a certain amount of points. TaskId-2675382 For empty list design: Co-authored-by: Carlos Valverde <cvs@odoo.com>
108 lines
4.9 KiB
Python
108 lines
4.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
# Part of Odoo. See LICENSE file for full copyright and licensing details.
|
|
|
|
import ast
|
|
|
|
from odoo import _, api, fields, models
|
|
from odoo.exceptions import ValidationError
|
|
from odoo.osv import expression
|
|
|
|
class LoyaltyRule(models.Model):
|
|
_name = 'loyalty.rule'
|
|
_description = 'Loyalty Rule'
|
|
|
|
def _get_reward_point_mode_selection(self):
|
|
# The value is provided in the loyalty program's view since we may not have a program_id yet
|
|
# and makes sure to display the currency related to the program instead of the company's.
|
|
symbol = self.env.context.get('currency_symbol', self.env.company.currency_id.symbol)
|
|
return [
|
|
('order', _('per order')),
|
|
('money', _('per %s spent', symbol)),
|
|
('unit', _('per unit paid')),
|
|
]
|
|
|
|
active = fields.Boolean(default=True)
|
|
program_id = fields.Many2one('loyalty.program', required=True, ondelete='cascade')
|
|
# Stored for security rules
|
|
company_id = fields.Many2one(related='program_id.company_id', store=True)
|
|
currency_id = fields.Many2one(related='program_id.currency_id')
|
|
|
|
# Only for dev mode
|
|
product_domain = fields.Char(default="[]")
|
|
|
|
product_ids = fields.Many2many('product.product', string='Products')
|
|
product_category_id = fields.Many2one('product.category', string='Categories')
|
|
product_tag_id = fields.Many2one('product.tag', string='Product Tag')
|
|
|
|
reward_point_amount = fields.Float(default=1, string="Reward")
|
|
# Only used for program_id.applies_on == 'future'
|
|
reward_point_split = fields.Boolean(string='Split per unit', default=False,
|
|
help="Whether to separate reward coupons per matched unit, only applies to 'future' programs and trigger mode per money spent or unit paid..")
|
|
reward_point_name = fields.Char(related='program_id.portal_point_name', readonly=True)
|
|
reward_point_mode = fields.Selection(selection=_get_reward_point_mode_selection, required=True, default='order')
|
|
|
|
minimum_qty = fields.Integer('Minimum Quantity', default=1)
|
|
minimum_amount = fields.Monetary('Minimum Purchase', 'currency_id')
|
|
minimum_amount_tax_mode = fields.Selection([
|
|
('incl', 'Included'),
|
|
('excl', 'Excluded')], default='incl', required=True,
|
|
)
|
|
|
|
mode = fields.Selection([
|
|
('auto', 'Automatic'),
|
|
('with_code', 'With a promotion code'),
|
|
], string="Application", default="auto")
|
|
code = fields.Char(string='Promotion Code', compute='_compute_code', store=True, readonly=False)
|
|
|
|
_sql_constraints = [
|
|
('reward_point_amount_positive', 'CHECK (reward_point_amount > 0)', 'Rule points reward must be strictly positive.'),
|
|
]
|
|
|
|
@api.constrains('reward_point_split')
|
|
def _constraint_trigger_multi(self):
|
|
# Prevent setting trigger multi in case of nominative programs, it does not make sense to allow this
|
|
for rule in self:
|
|
if rule.reward_point_split and (rule.program_id.applies_on == 'both' or rule.program_id.program_type == 'ewallet'):
|
|
raise ValidationError(_('Split per unit is not allowed for Loyalty and eWallet programs.'))
|
|
|
|
@api.constrains('code')
|
|
def _constrains_code(self):
|
|
mapped_codes = self.filtered('code').mapped('code')
|
|
# Program code must be unique
|
|
if len(mapped_codes) != len(set(mapped_codes)) or\
|
|
self.env['loyalty.rule'].search_count(
|
|
[('mode', '=', 'with_code'), ('code', 'in', mapped_codes), ('id', 'not in', self.ids)]):
|
|
raise ValidationError(_('The promo code must be unique.'))
|
|
# Prevent coupons and programs from sharing a code
|
|
if self.env['loyalty.card'].search_count([('code', 'in', mapped_codes)]):
|
|
raise ValidationError(_('A coupon with the same code was found.'))
|
|
|
|
@api.depends('mode')
|
|
def _compute_code(self):
|
|
# Reset code when mode is set to auto
|
|
for rule in self:
|
|
if rule.mode == 'auto':
|
|
rule.code = False
|
|
|
|
def _get_valid_product_domain(self):
|
|
self.ensure_one()
|
|
domain = []
|
|
if self.product_ids:
|
|
domain = [('id', 'in', self.product_ids.ids)]
|
|
if self.product_category_id:
|
|
domain = expression.OR([domain, [('categ_id', 'child_of', self.product_category_id.id)]])
|
|
if self.product_tag_id:
|
|
domain = expression.OR([domain, [('all_product_tag_ids', 'in', self.product_tag_id.id)]])
|
|
if self.product_domain and self.product_domain != '[]':
|
|
domain = expression.AND([domain, ast.literal_eval(self.product_domain)])
|
|
return domain
|
|
|
|
def _get_valid_products(self):
|
|
self.ensure_one()
|
|
return self.env['product.product'].search(self._get_valid_product_domain())
|
|
|
|
def _compute_amount(self, currency_to):
|
|
self.ensure_one()
|
|
return self.currency_id._convert(
|
|
self.minimum_amount, currency_to, self.company_id, fields.Date.today())
|