quickbooks-types 0.1.1

use chrono::NaiveDate;
use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;

use super::common::{MetaData, NtRef};
#[cfg(feature = "builder")]
use crate::error::QBTypeError;
use crate::{QBCreatable, QBFullUpdatable, QBItem};

#[skip_serializing_none]
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize, Default)]
#[serde(rename_all = "PascalCase", default)]
#[cfg_attr(
    feature = "builder",
    derive(Builder),
    builder(default, build_fn(error = "QBTypeError"), setter(into, strip_option))
)]
/// Item
///
/// Represents a product or service that can be purchased or sold. Items determine posting accounts (income, expense, inventory) and pricing.
///
/// Creation requirements:
/// - `QBCreatable::can_create()` returns true when:
///   - `name` and `expense_account_ref` are present, and
///   - for `ItemType::Inventory`: `income_account_ref`, `asset_account_ref`, `inv_start_date`, and `qty_on_hand` are present
///   - for `ItemType::Service`: `income_account_ref` is present
///   - for `ItemType::NonInventory`: no additional fields beyond `name` and `expense_account_ref`
///   - if `item_type` is `None`: `asset_account_ref` must be present
///
/// Update semantics:
/// - `QBFullUpdatable::can_full_update()` returns true when `has_read()` is true (ID + sync token) and `name` is present.
///
/// API reference:
/// <https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item>
pub struct Item {
    pub id: Option<String>,
    pub sync_token: Option<String>,
    #[serde(skip_serializing)]
    pub meta_data: Option<MetaData>,

    /// If true, the object is currently enabled for use by `QuickBooks`.
    pub active: Option<bool>,

    /// Reference to the Inventory Asset account that tracks the current value of the inventory.
    /// If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory.
    /// Query the Account name list resource to determine the appropriate Account object for this reference.
    /// Use `Account.id` and `Account.name` from that object for `AssetAccountRef.value` and `AssetAccountRef.name`, respectively.
    ///
    /// Required for Inventory item types.
    pub asset_account_ref: Option<NtRef>,

    /// Description of the item.
    ///
    /// * max character: maximum of 4000 chars
    pub description: Option<String>,

    /// Documentation unavailable.
    #[serde(rename = "domain")]
    pub domain: Option<String>,

    /// Reference to the expense account used to pay the vendor for this item.
    /// Must be an account with account type of Cost of Goods Sold.
    /// Query the Account name list resource to determine the appropriate Account object for this reference.
    /// Use `Account.id` and `Account.name` from that object for `ExpenseAccountRef.value` and `ExpenseAccountRef.name`, respectively.
    ///
    /// For France locales:
    /// * This is an optional field.
    /// * This is the purchase account id, If not provided it defaults to the default purchase account: 605100 and 601100 are the default expense accounts used for Service and Product type of item, respectively.
    ///
    /// Required for Inventory, `NonInventory`, and Service item types
    pub expense_account_ref: Option<NtRef>,

    /// Fully qualified name of the entity.
    /// The fully qualified name prepends the topmost parent, followed by each sub element separated by colons.
    /// Takes the form of Item:SubItem.
    /// Returned from an existing object and not input on a new object.
    /// Limited to 5 levels.
    ///
    /// * filterable
    /// * read only
    /// * system defined
    pub fully_qualified_name: Option<String>,
    pub income_account_ref: Option<NtRef>,
    pub inv_start_date: Option<NaiveDate>,
    pub sales_tax_included: Option<bool>,
    pub sales_tax_code_ref: Option<NtRef>,
    pub class_ref: Option<NtRef>,
    pub source: Option<String>,
    pub purchase_tax_included: Option<bool>,
    pub reorder_point: Option<f64>,
    pub purchase_dec: Option<String>,
    pub pref_vendor_ref: Option<NtRef>,
    pub purchase_tax_code_ref: Option<NtRef>,
    pub purchase_cost: Option<f64>,
    pub parent_ref: Option<NtRef>,
    pub tax_classification_ref: Option<NtRef>,

    /// Classification that specifies the use of this item.
    /// Available when endpoint is evoked with the minorversion=3 query parameter.
    /// Read-only after object is created.
    /// Valid values include: Product and Service.
    ///
    /// Applicable for France companies only.
    pub item_category_type: Option<String>,
    #[serde(rename = "Type")]
    pub item_type: Option<ItemType>,
    pub level: Option<i64>,
    pub name: Option<String>,
    pub purchase_desc: Option<String>,
    pub qty_on_hand: Option<i64>,
    pub sku: Option<String>,
    #[serde(rename = "sparse")]
    pub sparse: Option<bool>,
    pub sub_item: Option<bool>,
    pub taxable: Option<bool>,
    pub track_qty_on_hand: Option<bool>,
    pub unit_price: Option<f64>,
}

/// Item Type
///
/// Classification that specifies whether the item is an inventory item, a service item, or a non-inventory item.
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize, Default)]
pub enum ItemType {
    Inventory,
    Service,
    #[default]
    NonInventory,
}

impl QBCreatable for Item {
    fn can_create(&self) -> bool {
        self.name.is_some()
            && self.expense_account_ref.is_some()
            && match self.item_type.as_ref() {
                Some(typ) => match *typ {
                    ItemType::Inventory => {
                        self.income_account_ref.is_some()
                            && self.asset_account_ref.is_some()
                            && self.inv_start_date.is_some()
                            && self.qty_on_hand.is_some()
                    }
                    ItemType::Service => self.income_account_ref.is_some(),
                    ItemType::NonInventory => true,
                },
                None => self.asset_account_ref.is_some(),
            }
    }
}

impl QBFullUpdatable for Item {
    fn can_full_update(&self) -> bool {
        self.has_read() && self.name.is_some()
    }
}