/**
 * PayPal Server SDKLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { lazy, object, optional, Schema, string } from '../schema.js';
import { Money, moneySchema } from './money.js';
import {
  OrderBillingPlan,
  orderBillingPlanSchema,
} from './orderBillingPlan.js';
import {
  UniversalProductCode,
  universalProductCodeSchema,
} from './universalProductCode.js';

/** The line items for this purchase. If your merchant account has been configured for Level 3 processing this field will be passed to the processor on your behalf. */
export interface LineItem {
  /** The item name or title. */
  name: string;
  /** The item quantity. Must be a whole number. */
  quantity: string;
  /** The detailed item description. */
  description?: string;
  /** The stock keeping unit (SKU) for the item. */
  sku?: string;
  /** The URL to the item being purchased. Visible to buyer and used in buyer experiences. */
  url?: string;
  /** The URL of the item's image. File type and size restrictions apply. An image that violates these restrictions will not be honored. */
  imageUrl?: string;
  /** The Universal Product Code of the item. */
  upc?: UniversalProductCode;
  /** Metadata for merchant-managed recurring billing plans. Valid only during the saved payment method token or billing agreement creation. */
  billingPlan?: OrderBillingPlan;
  /** The currency and amount for a financial transaction, such as a balance or payment due. */
  unitAmount?: Money;
  /** The currency and amount for a financial transaction, such as a balance or payment due. */
  tax?: Money;
  /** Code used to classify items purchased and track the total amount spent across various categories of products and services. Different corporate purchasing organizations may use different standards, but the United Nations Standard Products and Services Code (UNSPSC) is frequently used. */
  commodityCode?: string;
  /** The currency and amount for a financial transaction, such as a balance or payment due. */
  discountAmount?: Money;
  /** The currency and amount for a financial transaction, such as a balance or payment due. */
  totalAmount?: Money;
  /** Unit of measure is a standard used to express the magnitude of a quantity in international trade. Most commonly used (but not limited to) examples are: Acre (ACR), Ampere (AMP), Centigram (CGM), Centimetre (CMT), Cubic inch (INQ), Cubic metre (MTQ), Fluid ounce (OZA), Foot (FOT), Hour (HUR), Item (ITM), Kilogram (KGM), Kilometre (KMT), Kilowatt (KWT), Liquid gallon (GLL), Liter (LTR), Pounds (LBS), Square foot (FTK). */
  unitOfMeasure?: string;
}

export const lineItemSchema: Schema<LineItem> = lazy(() =>
  object({
    name: ['name', string()],
    quantity: ['quantity', string()],
    description: ['description', optional(string())],
    sku: ['sku', optional(string())],
    url: ['url', optional(string())],
    imageUrl: ['image_url', optional(string())],
    upc: ['upc', optional(universalProductCodeSchema)],
    billingPlan: ['billing_plan', optional(orderBillingPlanSchema)],
    unitAmount: ['unit_amount', optional(moneySchema)],
    tax: ['tax', optional(moneySchema)],
    commodityCode: ['commodity_code', optional(string())],
    discountAmount: ['discount_amount', optional(moneySchema)],
    totalAmount: ['total_amount', optional(moneySchema)],
    unitOfMeasure: ['unit_of_measure', optional(string())],
  })
);