discount-rule.go

package models

import (
	"database/sql/driver"

	"github.com/driver005/gateway/core"
)

type DiscountRuleType string

const (
	DiscountRuleFixed        DiscountRuleType = "fixed"
	DiscountRulePersentage   DiscountRuleType = "percentage"
	DiscountRuleFreeShipping DiscountRuleType = "free_shipping"
)

func (pl *DiscountRuleType) Scan(value interface{}) error {
	*pl = DiscountRuleType(value.([]byte))
	return nil
}

func (pl DiscountRuleType) Value() (driver.Value, error) {
	return string(pl), nil
}

type AllocationType string

const (
	AllocationTotal AllocationType = "total"
	AllocationItem  AllocationType = "item"
)

// @oas:schema:DiscountRule
// title: "Discount Rule"
// description: "A discount rule defines how a Discount is calculated when applied to a Cart."
// type: object
// required:
//   - allocation
//   - created_at
//   - deleted_at
//   - description
//   - id
//   - metadata
//   - type
//   - updated_at
//   - value
//
// properties:
//
//	id:
//	  description: The discount rule's ID
//	  type: string
//	  example: dru_01F0YESMVK96HVX7N419E3CJ7C
//	type:
//	  description: >-
//	    The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.
//	  type: string
//	  enum:
//	    - fixed
//	    - percentage
//	    - free_shipping
//	  example: percentage
//	description:
//	  description: A short description of the discount
//	  nullable: true
//	  type: string
//	  example: 10 Percent
//	value:
//	  description: The value that the discount represents; this will depend on the type of the discount
//	  type: integer
//	  example: 10
//	allocation:
//	  description: The scope that the discount should apply to.
//	  nullable: true
//	  type: string
//	  enum:
//	    - total
//	    - item
//	  example: total
//	conditions:
//	  description: The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.
//	  type: array
//	  x-expandable: "conditions"
//	  items:
//	    $ref: "#/components/schemas/DiscountCondition"
//	created_at:
//	  description: The date with timezone at which the resource was created.
//	  type: string
//	  format: date-time
//	updated_at:
//	  description: The date with timezone at which the resource was updated.
//	  type: string
//	  format: date-time
//	deleted_at:
//	  description: The date with timezone at which the resource was deleted.
//	  nullable: true
//	  type: string
//	  format: date-time
//	metadata:
//	  description: An optional key-value map with additional details
//	  nullable: true
//	  type: object
//	  example: {car: "white"}
//	  externalDocs:
//	    description: "Learn about the metadata attribute, and how to delete and update it."
//	    url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute"
type DiscountRule struct {
	core.SoftDeletableModel

	Type        DiscountRuleType    `json:"type" gorm:"column:type"`
	Description string              `json:"description" gorm:"column:description"`
	Value       float64             `json:"value" gorm:"column:value"`
	Allocation  AllocationType      `json:"allocation" gorm:"column:allocation"`
	Conditions  []DiscountCondition `json:"conditions" gorm:"foreignKey:Id"`
}