/*
 * Copyright 2010-2014 Ning, Inc.
 * Copyright 2014-2018 The Billing Project, LLC
 *
 * The Billing Project licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package com.ning.billing.recurly.model;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlElementWrapper;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;

import org.joda.time.DateTime;
import com.google.common.base.Objects;

/**
 * Class that represents the Concept of a Coupon within the Recurly API.
 */
@XmlRootElement(name = "coupon")
public class Coupon extends RecurlyObject {
    public enum DiscountType {
        percent, dollars, free_trial
    }

    public enum Duration {
        forever, single_use, temporal
    }

    public enum FreeTrialUnit {
        day, week, month
    }

    public enum RedemptionResource {
        account, subscription
    }

    public enum TemporalUnit {
        day, week, month, year;
    }

    public enum Type {
        single_code, bulk, unique_code
    }

    @XmlTransient
    public static final String COUPON_RESOURCE = "/coupons";

    @XmlTransient
    public static final String GENERATE_RESOURCE = "/generate";

    @XmlTransient
    public static final String UNIQUE_CODES_RESOURCE = "/unique_coupon_codes";

    @XmlTransient
    public static final String RESTORE_RESOURCE = "/restore";

    @XmlElement(name = "id")
    private Long id;

    @XmlElement(name = "name")
    private String name;

    @XmlElement(name = "coupon_code")
    private String couponCode;

    /**
     * Description of the coupon on the hosted payment pages.
     */
    @XmlElement(name = "description")
    private String description;

    /**
     * Description of the coupon on the invoice.
     */
    @XmlElement(name = "invoice_description")
    private String invoiceDescription;

    /**
     * Last date to redeem the coupon, defaults to no date
     */
    @XmlElement(name = "redeem_by_date")
    private DateTime redeemByDate;

    /**
     * Number of months after redemption that the coupon is valid, defaults to no date
     * @deprecated Please use temporal_unit and temporal_amount
     */
    @XmlElement(name = "applies_for_months")
    private Integer appliesForMonths;

    /**
     * Maximum number of accounts that may use the coupon before it can no longer be redeemed
     */
    @XmlElement(name = "max_redemptions")
    private Integer maxRedemptions;

    /**
     * The coupon is valid for all plans if true, defaults to true
     */
    @XmlElement(name = "applies_to_all_plans")
    private Boolean appliesToAllPlans;

    /**
     * The coupon is valid for all items if true, defaults to false
     */
    @XmlElement(name = "applies_to_all_items")
    private Boolean appliesToAllItems;

    /**
     * If true, the coupon applies to the first invoice only
     * @deprecated Please use duration
     */
    @XmlElement(name = "single_use")
    private Boolean singleUse;

    @XmlElement(name = "discount_type")
    private DiscountType discountType;

    @XmlElement(name = "free_trial_unit")
    private FreeTrialUnit freeTrialUnit;

    @XmlElement(name = "free_trial_amount")
    private Integer freeTrialAmount;

    /**
     * Discount percentage if discount_type is "percent"
     */
    @XmlElement(name = "discount_percent")
    private Integer discountPercent;

    @XmlElement(name = "discount_in_cents")
    private RecurlyUnitCurrency discountInCents;

    @XmlElement(name = "state")
    private String state;

    @XmlElement(name = "created_at")
    private DateTime createdAt;

    @XmlElement(name = "updated_at")
    private DateTime updatedAt;

    public PlanCodes getPlanCodes() {
        return planCodes;
    }

    public void setPlanCodes(final PlanCodes planCodes) {
        this.planCodes = planCodes;
    }

    @XmlElement(name = "plan_code")
    @XmlElementWrapper(name = "plan_codes")
    private PlanCodes planCodes;

    public ItemCodes getItemCodes() {
        return itemCodes;
    }

    public void setItemCodes(final ItemCodes itemCodes) {
        this.itemCodes = itemCodes;
    }

    @XmlElement(name = "item_code")
    @XmlElementWrapper(name = "item_codes")
    private ItemCodes itemCodes;

    /**
     * forever, single_use, or temporal. If single_use, the coupon applies to
     * the first invoice only. If temporal the coupon will apply to invoices for
     * the duration determined by the temporal_unit and temporal_amount
     * attributes.
     */
    @XmlElement(name = "duration")
    private Duration duration;

    /**
     * day, week, month, or year. If duration is temporal then temporal_unit is
     * multiplied by temporal_amount to define the duration that the coupon will
     * be applied to invoices for.
     */
    @XmlElement(name = "temporal_unit")
    private TemporalUnit temporalUnit;

    /**
     * If duration is temporal then temporal_amount is an integer which is
     * multiplied by temporal_unit to define the duration that the coupon will
     * be applied to invoices for.
     */
    @XmlElement(name = "temporal_amount")
    private Integer temporalAmount;

    /**
     * The coupon is valid for one-time, non-plan charges if true, defaults to
     * false.
     */
    @XmlElement(name = "applies_to_non_plan_charges")
    private Boolean appliesToNonPlanCharges;

    /**
     * Whether the discount is for all eligible charges on the account, or only
     * a specific subscription. Values are account or subscription.
     */
    @XmlElement(name = "redemption_resource")
    private RedemptionResource redemptionResource;

    /**
     * The number of times the coupon can be redeemed on a specific account
     */
    @XmlElement(name = "max_redemptions_per_account")
    private Integer maxRedemptionsPerAccount;

    /**
     * Whether the coupon is single_code or bulk. Bulk coupons will require a
     * unique_code_template and will generate unique codes through the generate
     * endpoint.
     */
    @XmlElement(name = "coupon_type")
    private Type type;

    /**
     * The template for generating unique codes.
     * 
     * @see <a href=
     *      "https://dev.recurly.com/docs/create-coupon">https://dev.recurly.com/docs/create-coupon</a>
     */
    @XmlElement(name = "unique_code_template")
    private String uniqueCodeTemplate;

    /**
     * The number of unique codes to generate.
     *
     * @see <a href=
     *      "https://dev.recurly.com/docs/generate-unique-codes">https://dev.recurly.com/docs/generate-unique-codes</a>
     */
    @XmlElement(name = "number_of_unique_codes")
    private Integer numberOfUniqueCodes;

    public void setId(final Object id) {
        this.id = longOrNull(id);
    }

    public Long getId() {
        return this.id;
    }

    public String getState() {
        return state;
    }

    public void setState(final Object state) {
        this.state = stringOrNull(state);
    }

    /**
     * Gets the name of the {@link Coupon}
     *
     * @return The {@link Coupon} name
     */
    public String getName() {
        return name;
    }

    /**
     * Sets the name of the {@link Coupon}
     *
     * @param name The Name that is to be given to the {@link Coupon}
     */
    public void setName(final Object name) {
        this.name = stringOrNull(name);
    }

    /**
     * Gets the coupon code for a {@link Coupon}
     *
     * @return The coupon code for the {@link Coupon}
     */
    public String getCouponCode() {
        return couponCode;
    }

    /**
     * Sets the coupon code for the {@link Coupon}
     *
     * @param couponCode The coupon code
     */
    public void setCouponCode(final Object couponCode) {
        this.couponCode = stringOrNull(couponCode);
    }

    /**
     * Sets the discount type for a {@link Coupon}
     *
     * @param discountType
     */
    public void setDiscountType(final Object discountType) {
        this.discountType = enumOrNull(DiscountType.class, discountType);
    }

    /**
     * Gets the discount type associated with the {@link Coupon}
     *
     * @return the DiscountType
     */
    public DiscountType getDiscountType() {
        return discountType;
    }

    /**
     * Gets the percentage discount for a coupon
     *
     * @return The percentage
     */
    public Integer getDiscountPercent() {
        return discountPercent;
    }

    public void setDiscountPercent(final Object discountPercent) {
        this.discountPercent = integerOrNull(discountPercent);
    }

    public DateTime getRedeemByDate() {
        return redeemByDate;
    }

    public void setRedeemByDate(final Object redeemByDate) {
        this.redeemByDate = dateTimeOrNull(redeemByDate);
    }

    public Integer getAppliesForMonths() {
        return appliesForMonths;
    }

    public void setAppliesForMonths(final Object appliesForMonths) {
        this.appliesForMonths = integerOrNull(appliesForMonths);
    }

    public Integer getMaxRedemptions() {
        return maxRedemptions;
    }

    public void setMaxRedemptions(final Object maxRedemptions) {
        this.maxRedemptions = integerOrNull(maxRedemptions);
    }

    public Boolean getSingleUse() {
        return singleUse;
    }

    public void setSingleUse(final Object singleUse) {
        this.singleUse = booleanOrNull(singleUse);
    }

    public RecurlyUnitCurrency getDiscountInCents() {
        return discountInCents;
    }

    public void setDiscountInCents(final Object discountInCents) {
        this.discountInCents = RecurlyUnitCurrency.build(discountInCents);
    }

    public Boolean getAppliesToAllPlans() {
        return appliesToAllPlans;
    }

    public void setAppliesToAllPlans(final Object appliesToAllPlans) {
        this.appliesToAllPlans = booleanOrNull(appliesToAllPlans);
    }

    public Boolean getAppliesToAllItems() {
        return appliesToAllItems;
    }

    public void setAppliesToAllItems(final Object appliesToAllItems) {
        this.appliesToAllItems = booleanOrNull(appliesToAllItems);
    }

    public FreeTrialUnit getFreeTrialUnit() {
        return freeTrialUnit;
    }

    public void setFreeTrialUnit(final Object freeTrialUnit) {
        this.freeTrialUnit = enumOrNull(FreeTrialUnit.class, freeTrialUnit);
    }

    public Integer getFreeTrialAmount() {
        return freeTrialAmount;
    }

    public void setFreeTrialAmount(final Object freeTrialAmount) {
        this.freeTrialAmount = integerOrNull(freeTrialAmount);
    }

    public DateTime getCreatedAt() {
        return createdAt;
    }

    public void setCreatedAt(final Object createdAt) {
        this.createdAt = dateTimeOrNull(createdAt);
    }

    public DateTime getUpdatedAt() {
        return updatedAt;
    }

    public void setUpdatedAt(final Object updatedAt) {
        this.updatedAt = dateTimeOrNull(updatedAt);
    }

    public String getDescription() {
      return description;
    }

    public void setDescription(Object description) {
      this.description = stringOrNull(description);
    }

    public String getInvoiceDescription() {
      return invoiceDescription;
    }

    public void setInvoiceDescription(Object invoiceDescription) {
      this.invoiceDescription = stringOrNull(invoiceDescription);
    }

    public Duration getDuration() {
      return duration;
    }

    public void setDuration(Object duration) {
      this.duration = enumOrNull(Duration.class, duration);
    }

    public TemporalUnit getTemporalUnit() {
      return temporalUnit;
    }

    public void setTemporalUnit(Object temporalUnit) {
      this.temporalUnit = enumOrNull(TemporalUnit.class, temporalUnit);
    }

    public Integer getTemporalAmount() {
      return temporalAmount;
    }

    public void setTemporalAmount(Object temporalAmount) {
      this.temporalAmount = integerOrNull(temporalAmount);
    }

    public Boolean getAppliesToNonPlanCharges() {
      return appliesToNonPlanCharges;
    }

    public void setAppliesToNonPlanCharges(Object appliesToNonPlanCharges) {
      this.appliesToNonPlanCharges = booleanOrNull(appliesToNonPlanCharges);
    }

    public RedemptionResource getRedemptionResource() {
      return redemptionResource;
    }

    public void setRedemptionResource(Object redemptionResource) {
      this.redemptionResource = enumOrNull(RedemptionResource.class, redemptionResource);
    }

    public Integer getMaxRedemptionsPerAccount() {
      return maxRedemptionsPerAccount;
    }

    public void setMaxRedemptionsPerAccount(Object maxRedemptionsPerAccount) {
      this.maxRedemptionsPerAccount = integerOrNull(maxRedemptionsPerAccount);
    }

    public Type getType() {
      return type;
    }

    public void setType(Type type) {
      this.type = enumOrNull(Type.class, type);
    }

    public String getUniqueCodeTemplate() {
      return uniqueCodeTemplate;
    }

    public void setUniqueCodeTemplate(Object uniqueCodeTemplate) {
      this.uniqueCodeTemplate = stringOrNull(uniqueCodeTemplate);
    }

    public Integer getNumberOfUniqueCodes() {
        return numberOfUniqueCodes;
    }

    public void setNumberOfUniqueCodes(Integer numberOfUniqueCodes) {
        this.numberOfUniqueCodes = numberOfUniqueCodes;
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder();
        sb.append("Coupon");
        sb.append("{name='").append(name).append('\'');
        sb.append(", id=").append(id);
        sb.append(", couponCode='").append(couponCode).append('\'');
        sb.append(", discountType='").append(discountType).append('\'');
        sb.append(", discountPercent='").append(discountPercent).append('\'');
        sb.append(", createdAt=").append(createdAt);
        sb.append(", updatedAt=").append(updatedAt);
        sb.append('}');
        return sb.toString();
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        final Coupon coupon = (Coupon) o;

        if (appliesForMonths != null ? !appliesForMonths.equals(coupon.appliesForMonths) : coupon.appliesForMonths != null) {
            return false;
        }
        if (appliesToNonPlanCharges != null ? !appliesToNonPlanCharges.equals(coupon.appliesToNonPlanCharges) : coupon.appliesToNonPlanCharges != null) {
            return false;
        }
        if (appliesToAllPlans != null ? !appliesToAllPlans.equals(coupon.appliesToAllPlans) : coupon.appliesToAllPlans != null) {
            return false;
        }
        if (appliesToAllItems != null ? !appliesToAllItems.equals(coupon.appliesToAllItems) : coupon.appliesToAllItems != null) {
            return false;
        }
        if (couponCode != null ? !couponCode.equals(coupon.couponCode) : coupon.couponCode != null) {
            return false;
        }
        if (planCodes != null ? !planCodes.equals(coupon.planCodes) : coupon.planCodes != null) {
            return false;
        }
        if (itemCodes != null ? !itemCodes.equals(coupon.itemCodes) : coupon.itemCodes != null) {
            return false;
        }
        if (createdAt != null ? createdAt.compareTo(coupon.createdAt) != 0 : coupon.createdAt != null) {
            return false;
        }
        if (description != null ? !description.equals(coupon.description) : coupon.description != null) {
            return false;
        }
        if (discountInCents != null ? !discountInCents.equals(coupon.discountInCents) : coupon.discountInCents != null) {
            return false;
        }
        if (discountPercent != null ? !discountPercent.equals(coupon.discountPercent) : coupon.discountPercent != null) {
            return false;
        }
        if (discountType != null ? !discountType.equals(coupon.discountType) : coupon.discountType != null) {
            return false;
        }
        if (duration != null ? !duration.equals(coupon.duration) : coupon.duration != null) {
            return false;
        }
        if (id != null ? !id.equals(coupon.id) : coupon.id != null) {
            return false;
        }
        if (invoiceDescription != null ? !invoiceDescription.equals(coupon.invoiceDescription) : coupon.invoiceDescription != null) {
            return false;
        }
        if (maxRedemptions != null ? !maxRedemptions.equals(coupon.maxRedemptions) : coupon.maxRedemptions != null) {
            return false;
        }
        if (name != null ? !name.equals(coupon.name) : coupon.name != null) {
            return false;
        }
        if (redeemByDate != null ? redeemByDate.compareTo(coupon.redeemByDate) != 0 : coupon.redeemByDate != null) {
            return false;
        }
        if (redemptionResource != null ? redemptionResource.compareTo(coupon.redemptionResource) != 0 : coupon.redemptionResource != null) {
            return false;
        }
        if (singleUse != null ? singleUse.compareTo(coupon.singleUse) != 0 : coupon.singleUse != null) {
            return false;
        }
        if (temporalAmount != null ? temporalAmount.compareTo(coupon.temporalAmount) != 0 : coupon.temporalAmount != null) {
            return false;
        }
        if (temporalUnit != null ? temporalUnit.compareTo(coupon.temporalUnit) != 0 : coupon.temporalUnit != null) {
            return false;
        }
        if (type != null ? type.compareTo(coupon.type) != 0 : coupon.type != null) {
            return false;
        }
        if (uniqueCodeTemplate != null ? uniqueCodeTemplate.compareTo(coupon.uniqueCodeTemplate) != 0 : coupon.uniqueCodeTemplate != null) {
            return false;
        }
        if (freeTrialUnit != null ? !freeTrialUnit.equals(coupon.freeTrialUnit) : coupon.freeTrialUnit != null) {
            return false;
        }
        if (freeTrialAmount != null ? !freeTrialAmount.equals(coupon.freeTrialAmount) : coupon.freeTrialAmount != null) {
            return false;
        }
        if (updatedAt != null ? updatedAt.compareTo(coupon.updatedAt) != 0 : coupon.updatedAt != null) {
            return false;
        }

        return true;
    }

    @Override
    public int hashCode() {
        return Objects.hashCode(
                appliesForMonths,
                appliesToAllPlans,
                appliesToAllItems,
                appliesToNonPlanCharges,
                name,
                couponCode,
                planCodes,
                itemCodes,
                description,
                discountType,
                discountPercent,
                discountInCents,
                duration,
                id,
                invoiceDescription,
                redeemByDate,
                singleUse,
                maxRedemptions,
                freeTrialUnit,
                freeTrialAmount,
                createdAt,
                redemptionResource,
                temporalAmount,
                temporalUnit,
                type,
                uniqueCodeTemplate,
                updatedAt
        );
    }
}