@ikas/storefront-models 4.0.0-alpha.78 → 4.0.0-alpha.8

package/src/models/html-meta-data/translations/index.ts

@@ -0,0 +1,5 @@
+export type IkasHTMLMetaDataTranslations = {
+  description: string | null;
+  locale: string;
+  pageTitle: string | null;
+};

package/src/models/image/index.ts

@@ -0,0 +1,4 @@
+export type IkasImage = {
+  id: string; // Might be a single imageId or merchantId/imageId
+  isVideo: boolean;
+};

package/src/models/last-viewed-product/index.ts

@@ -0,0 +1,4 @@
+export type IkasLastViewedProduct = {
+  productId: string;
+  variantId: string;
+};

package/src/models/merchant-settings/index.ts

@@ -0,0 +1,25 @@
+import { IkasImage } from "../image";
+
+export type IkasMerchantSettings = {
+  currencyFormats: IkasMerchantSettingsCurrencyFormat[] | null;
+  logoId: string | null;
+  merchantId: string;
+  merchantName: string;
+
+  // Extra
+  logo?: IkasImage | null;
+};
+
+export type IkasMerchantSettingsCurrencyFormat = {
+  currencyCode: string;
+  decimalSeparator: string;
+  symbol: string;
+  symbolPosition: IkasMerchantSettingsCurrencyFormatSymbolPosition;
+  thousandSeparator: string;
+  omitZeroDecimal: boolean;
+};
+
+enum IkasMerchantSettingsCurrencyFormatSymbolPosition {
+  LEFT = "LEFT",
+  RIGHT = "RIGHT",
+}

package/src/models/merchant-settings/init.ts

@@ -0,0 +1,7 @@
+import { IkasMerchantSettings } from ".";
+
+export function initIkasMerchantSettings(settings: IkasMerchantSettings) {
+  settings.logo = settings.logoId
+    ? { id: settings.logoId, isVideo: false }
+    : null;
+}

package/src/models/order/address/city/index.ts

@@ -0,0 +1,5 @@
+export type IkasOrderAddressCity = {
+  code: string | null;
+  id: string | null;
+  name: string;
+};

package/src/models/order/address/country/index.ts

@@ -0,0 +1,7 @@
+export type IkasOrderAddressCountry = {
+  code: string | null;
+  id: string | null;
+  iso2: string | null;
+  iso3: string | null;
+  name: string;
+};

package/src/models/order/address/district/index.ts

@@ -0,0 +1,5 @@
+export type IkasOrderAddressDistrict = {
+  code: string | null;
+  id: string | null;
+  name: string | null;
+};

package/src/models/order/address/index.ts

@@ -0,0 +1,25 @@
+import { IkasCheckoutSettings } from "../../checkout-settings";
+import { IkasOrderAddressCity } from "./city";
+import { IkasOrderAddressCountry } from "./country";
+import { IkasOrderAddressDistrict } from "./district";
+import { IkasOrderAddressState } from "./state";
+
+export type IkasOrderAddress = {
+  addressLine1: string;
+  addressLine2: string | null;
+  company: string | null;
+  firstName: string;
+  id: string | null;
+  identityNumber: string | null;
+  isDefault: boolean;
+  lastName: string;
+  phone: string | null;
+  postalCode: string | null;
+  taxNumber: string | null;
+  taxOffice: string | null;
+
+  country: IkasOrderAddressCountry | null;
+  state: IkasOrderAddressState | null;
+  city: IkasOrderAddressCity | null;
+  district: IkasOrderAddressDistrict | null;
+};

package/src/models/order/address/state/index.ts

@@ -0,0 +1,5 @@
+export interface IkasOrderAddressState {
+  code: string | null;
+  id: string | null;
+  name: string | null;
+}

package/src/models/order/adjustment/applied-order-line/index.ts

@@ -0,0 +1,6 @@
+export type IkasOrderAdjustmentAppliedOrderLine = {
+  amount: number;
+  appliedQuantity: number;
+  isAutoCreated: boolean | null;
+  orderLineId: string;
+};

package/src/models/order/adjustment/index.ts

@@ -0,0 +1,24 @@
+import { IkasCampaignType } from "../../../models/product/campaign/data";
+import { IkasOrderAdjustmentAppliedOrderLine } from "./applied-order-line";
+
+export type IkasOrderAdjustment = {
+  amount: number;
+  appliedOrderLines: IkasOrderAdjustmentAppliedOrderLine[] | null;
+  campaignId: string | null;
+  couponId: string | null;
+  name: string;
+  order: number;
+  amountType: IkasAmountType;
+  type: IkasAdjustmentType;
+  campaignType: IkasCampaignType | null;
+};
+
+export enum IkasAmountType {
+  AMOUNT = "AMOUNT",
+  RATIO = "RATIO",
+}
+
+export enum IkasAdjustmentType {
+  DECREMENT = "DECREMENT",
+  INCREMENT = "INCREMENT",
+}

package/src/models/order/customer/index.ts

@@ -0,0 +1,9 @@
+export type IkasOrderCustomer = {
+  email: string | null;
+  firstName: string | null;
+  fullName: string | null;
+  id: string | null;
+  isGuestCheckout: boolean | null;
+  lastName: string | null;
+  notificationsAccepted: boolean | null;
+};

package/src/models/order/gift-line/index.ts

@@ -0,0 +1,4 @@
+export type IkasOrderGiftPackageLine = {
+  price: number;
+  taxValue: number | null;
+};

package/src/models/order/index.ts

@@ -0,0 +1,90 @@
+import { IkasOrderAddress } from "./address";
+import { IkasOrderShippingLine } from "./shipping-line";
+import { IkasOrderLineItem } from "./line-item";
+import { IkasOrderCustomer } from "./customer";
+import { IkasOrderGiftPackageLine } from "./gift-line";
+import { IkasInvoice } from "./invoice";
+import { IkasOrderPaymentMethod } from "./payment-method";
+import { IkasOrderAdjustment } from "./adjustment";
+import { IkasOrderPackage } from "./package";
+import { IkasOrderTaxLine } from "./tax-line";
+import { IkasBaseModel } from "../base";
+
+export type IkasOrder = {
+  billingAddress: IkasOrderAddress | null;
+  cancelReason: IkasOrderCancelReason | null;
+  cancelledAt: number | null;
+  currencyCode: string;
+  customer: IkasOrderCustomer | null;
+  customerId: string | null;
+  giftPackageLines: IkasOrderGiftPackageLine[] | null;
+  giftPackageNote: string | null;
+  invoices: IkasInvoice[] | null;
+  isGiftPackage: boolean | null;
+  note: string | null;
+  orderAdjustments: IkasOrderAdjustment[] | null;
+  orderLineItems: IkasOrderLineItem[];
+  orderNumber: string | null;
+  orderPackageStatus: IkasOrderPackageStatus | null;
+  orderPackages: IkasOrderPackage[] | null;
+  orderPaymentStatus: IkasOrderPaymentStatus | null;
+  orderedAt: number | null;
+  paymentMethods: IkasOrderPaymentMethod[] | null;
+  shippingAddress: IkasOrderAddress | null;
+  shippingLines: IkasOrderShippingLine[] | null;
+  shippingMethod: IkasOrderShippingMethod;
+  status: IkasOrderStatus;
+  taxLines: IkasOrderTaxLine[] | null;
+  totalFinalPrice: number;
+  totalPrice: number;
+} & IkasBaseModel;
+
+export enum IkasOrderCancelReason {
+  CUSTOMER = "CUSTOMER",
+  DECLINED = "DECLINED",
+  INVENTORY = "INVENTORY",
+  OTHER = "OTHER",
+}
+
+export enum IkasOrderPackageStatus {
+  CANCELLED = "CANCELLED",
+  CANCEL_REJECTED = "CANCEL_REJECTED",
+  CANCEL_REQUESTED = "CANCEL_REQUESTED",
+  DELIVERED = "DELIVERED",
+  FULFILLED = "FULFILLED",
+  PARTIALLY_CANCELLED = "PARTIALLY_CANCELLED",
+  PARTIALLY_DELIVERED = "PARTIALLY_DELIVERED",
+  PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED",
+  PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+  READY_FOR_PICK_UP = "READY_FOR_PICK_UP",
+  READY_FOR_SHIPMENT = "READY_FOR_SHIPMENT",
+  REFUNDED = "REFUNDED",
+  REFUND_REJECTED = "REFUND_REJECTED",
+  REFUND_REQUESTED = "REFUND_REQUESTED",
+  REFUND_REQUEST_ACCEPTED = "REFUND_REQUEST_ACCEPTED",
+  UNABLE_TO_DELIVER = "UNABLE_TO_DELIVER",
+  UNFULFILLED = "UNFULFILLED",
+}
+
+export enum IkasOrderPaymentStatus {
+  PAID = "PAID",
+  PARTIALLY_PAID = "PARTIALLY_PAID",
+  WAITING = "WAITING",
+}
+
+export enum IkasOrderStatus {
+  CANCELLED = "CANCELLED",
+  CREATED = "CREATED",
+  DRAFT = "DRAFT",
+  PARTIALLY_CANCELLED = "PARTIALLY_CANCELLED",
+  PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+  REFUNDED = "REFUNDED",
+  REFUND_REJECTED = "REFUND_REJECTED",
+  REFUND_REQUESTED = "REFUND_REQUESTED",
+}
+
+export enum IkasOrderShippingMethod {
+  CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
+  NO_SHIPMENT = "NO_SHIPMENT",
+  SHIPMENT = "SHIPMENT",
+}

package/src/models/order/invoice/index.ts

@@ -0,0 +1,15 @@
+export type IkasInvoice = {
+  appId: string;
+  appName: string;
+  createdAt: number | null;
+  id: string;
+  invoiceNumber: string;
+  storeAppId: string;
+  type: IkasInvoiceType;
+};
+
+export enum IkasInvoiceType {
+  COMPANY = "COMPANY",
+  INDIVIDUAL = "INDIVIDUAL",
+  OTHER = "OTHER",
+}

package/src/models/order/line-item/discount/index.ts

@@ -0,0 +1,10 @@
+import { IkasAmountType } from "../../adjustment";
+
+export type IkasOrderLineDiscount = {
+  amount: number;
+  amountType: IkasAmountType;
+  campaignOfferId: string | null;
+  campaignOfferProductId: string | null;
+  maxApplicableQuantity: number | null;
+  reason: string | null;
+};

package/src/models/order/line-item/index.ts

@@ -0,0 +1,34 @@
+import { IkasOrderLineDiscount } from "./discount";
+import { IkasOrderLineVariant } from "./variant";
+import { IkasOrderLineItemOption } from "./option";
+import { IkasBaseModel } from "../../base";
+
+export type IkasOrderLineItem = {
+  currencyCode: string | null;
+  discount: IkasOrderLineDiscount | null;
+  discountPrice: number | null;
+  finalPrice: number | null;
+  options: IkasOrderLineItemOption[] | null;
+  originalOrderLineItemId: string | null;
+  price: number;
+  quantity: number;
+  status: IkasOrderLineItemStatus;
+  statusUpdatedAt: number | null;
+  stockLocationId: string | null;
+  taxValue: number | null;
+  variant: IkasOrderLineVariant;
+  orderedAt: number;
+} & IkasBaseModel;
+
+export enum IkasOrderLineItemStatus {
+  CANCELLED = "CANCELLED",
+  CANCEL_REJECTED = "CANCEL_REJECTED",
+  CANCEL_REQUESTED = "CANCEL_REQUESTED",
+  DELIVERED = "DELIVERED",
+  FULFILLED = "FULFILLED",
+  REFUNDED = "REFUNDED",
+  REFUND_REJECTED = "REFUND_REJECTED",
+  REFUND_REQUESTED = "REFUND_REQUESTED",
+  REFUND_REQUEST_ACCEPTED = "REFUND_REQUEST_ACCEPTED",
+  UNFULFILLED = "UNFULFILLED",
+}

package/src/models/order/line-item/option/index.ts

@@ -0,0 +1,10 @@
+import { IkasProductOptionType } from "../../../product/option-set/option";
+import { IkasOrderLineItemOptionValue } from "./value";
+
+export type IkasOrderLineItemOption = {
+  name: string;
+  productOptionId: string;
+  productOptionsSetId: string;
+  type: IkasProductOptionType;
+  values: IkasOrderLineItemOptionValue[];
+};

package/src/models/order/line-item/option/value/index.ts

@@ -0,0 +1,5 @@
+export type IkasOrderLineItemOptionValue = {
+  name: string | null;
+  price: number | null;
+  value: string;
+};

package/src/models/order/line-item/variant/brand/index.ts

@@ -0,0 +1,4 @@
+export type IkasOrderLineVariantBrand = {
+  id: string;
+  name: string;
+};

package/src/models/order/line-item/variant/category/index.ts

@@ -0,0 +1,10 @@
+export type IkasOrderLineVariantCategory = {
+  categoryPath: IkasOrderLineVariantCategoryPath[] | null;
+  id: string;
+  name: string;
+};
+
+export type IkasOrderLineVariantCategoryPath = {
+  id: string;
+  name: string;
+};

package/src/models/order/line-item/variant/index.ts

@@ -0,0 +1,26 @@
+import { IkasOrderLineVariantVariantValue } from "./value";
+import { IkasOrderLineVariantBrand } from "./brand";
+import { IkasOrderLineVariantCategory } from "./category";
+import { IkasOrderLineVariantPrice } from "./price";
+import { IkasImage } from "../../../image";
+
+export type IkasOrderLineVariant = {
+  barcodeList: string[] | null;
+  brand: IkasOrderLineVariantBrand | null;
+  categories: IkasOrderLineVariantCategory[] | null;
+  id: string | null;
+  mainImageId: string | null;
+  name: string;
+  prices: IkasOrderLineVariantPrice[] | null;
+  productId: string | null;
+  sku: string | null;
+  slug: string | null;
+  tagIds: string[] | null;
+  taxValue: number | null;
+  type: number | null;
+  weight: number | null;
+  variantValues: IkasOrderLineVariantVariantValue[] | null;
+
+  // Extra
+  mainImage?: IkasImage | null;
+};

package/src/models/order/line-item/variant/price/index.ts

@@ -0,0 +1,7 @@
+export type IkasOrderLineVariantPrice = {
+  buyPrice: number | null;
+  currency: string | null;
+  discountPrice: number | null;
+  priceListId: string | null;
+  sellPrice: number;
+};

package/src/models/order/line-item/variant/value/index.ts

@@ -0,0 +1,7 @@
+export type IkasOrderLineVariantVariantValue = {
+  order: number;
+  variantTypeId: string;
+  variantTypeName: string | null;
+  variantValueId: string;
+  variantValueName: string | null;
+};

package/src/models/order/package/index.ts

@@ -0,0 +1,28 @@
+import { IkasBaseModel } from "../../base";
+import { IkasTrackingInfo } from "./tracking-info";
+
+export type IkasOrderPackage = {
+  errorMessage: string | null;
+  note: string | null;
+  orderLineItemIds: string[];
+  orderPackageFulfillStatus: IkasOrderPackageFullfillStatus;
+  orderPackageNumber: string;
+  stockLocationId: string;
+  trackingInfo: IkasTrackingInfo | null;
+} & IkasBaseModel;
+
+export enum IkasOrderPackageFullfillStatus {
+  CANCELLED = "CANCELLED",
+  CANCEL_REJECTED = "CANCEL_REJECTED",
+  CANCEL_REQUESTED = "CANCEL_REQUESTED",
+  DELIVERED = "DELIVERED",
+  ERROR = "ERROR",
+  FULFILLED = "FULFILLED",
+  READY_FOR_PICK_UP = "READY_FOR_PICK_UP",
+  READY_FOR_SHIPMENT = "READY_FOR_SHIPMENT",
+  REFUNDED = "REFUNDED",
+  REFUND_REJECTED = "REFUND_REJECTED",
+  REFUND_REQUESTED = "REFUND_REQUESTED",
+  REFUND_REQUEST_ACCEPTED = "REFUND_REQUEST_ACCEPTED",
+  UNABLE_TO_DELIVER = "UNABLE_TO_DELIVER",
+}

package/src/models/order/package/tracking-info/index.ts

@@ -0,0 +1,7 @@
+export type IkasTrackingInfo = {
+  barcode: string | null;
+  cargoCompany: string | null;
+  isSendNotification: boolean | null;
+  trackingLink: string | null;
+  trackingNumber: string | null;
+};

package/src/models/order/payment-method/index.ts

@@ -0,0 +1,9 @@
+import { IkasPaymentMethodType } from "../../payment-gateway";
+
+export type IkasOrderPaymentMethod = {
+  paymentGatewayCode: string | null;
+  paymentGatewayId: string | null;
+  paymentGatewayName: string | null;
+  price: number;
+  type: IkasPaymentMethodType;
+};

package/src/models/order/refund/index.ts

@@ -0,0 +1,6 @@
+import { IkasOrderRefundOrderLineInput } from "./line-item";
+
+export type IkasRefund = {
+  orderId: string;
+  orderLineItems: IkasOrderRefundOrderLineInput[];
+};

package/src/models/order/refund/line-item/index.ts

@@ -0,0 +1,4 @@
+export type IkasOrderRefundOrderLineInput = {
+  orderLineItemId: string;
+  quantity: number;
+};

package/src/models/order/refund/settings/index.ts

@@ -0,0 +1,5 @@
+export type IkasOrderRefundSettings = {
+  isActiveRefundSection: boolean;
+  orderRefundDayLimit: number | null;
+  refundDesc: string;
+};

package/src/models/order/shipping-line/index.ts

@@ -0,0 +1,12 @@
+import { IkasPaymentMethodType } from "../../payment-gateway";
+
+export type IkasOrderShippingLine = {
+  finalPrice: number;
+  isRefunded: boolean | null;
+  paymentMethod: IkasPaymentMethodType | null;
+  price: number;
+  shippingSettingsId: string | null;
+  shippingZoneRateId: string | null;
+  taxValue: number | null;
+  title: string;
+};

package/src/models/order/tax-line/index.ts

@@ -0,0 +1,4 @@
+export type IkasOrderTaxLine = {
+  price: number;
+  rate: number;
+};

package/src/models/order/transaction/error/index.ts

@@ -0,0 +1,5 @@
+export type IkasTransactionError = {
+  code: string | null;
+  declineCode: string | null;
+  message: string | null;
+};

package/src/models/order/transaction/index.ts

@@ -0,0 +1,39 @@
+import { IkasPaymentMethodType } from "../../payment-gateway";
+import { IkasTransactionError } from "./error";
+import { IkasTransactionPaymentMethodDetail } from "./payment-method-detail";
+
+export type IkasOrderTransaction = {
+  amount: number | null;
+  checkoutId: string | null;
+  createdAt: number | null;
+  currencyCode: string | null;
+  customerId: string | null;
+  error: IkasTransactionError | null;
+  id: string | null;
+  orderId: string | null;
+  paymentGatewayId: string | null;
+  paymentGatewayName: string | null;
+  paymentMethod: IkasPaymentMethodType | null;
+  paymentMethodDetail: IkasTransactionPaymentMethodDetail | null;
+  processedAt: number | null;
+  refundReason: string | null;
+  status: IkasTransactionStatus | null;
+  type: IkasTransactionType | null;
+  updatedAt: number | null;
+
+  // Extra
+  currencySymbol?: string | null;
+};
+
+export enum IkasTransactionStatus {
+  AUTHORIZED = "AUTHORIZED",
+  FAILED = "FAILED",
+  PENDING = "PENDING",
+  SUCCESS = "SUCCESS",
+}
+
+export enum IkasTransactionType {
+  REFUND = "REFUND",
+  SALE = "SALE",
+  VOID = "VOID",
+}

package/src/models/order/transaction/payment-method-detail/index.ts

@@ -0,0 +1,25 @@
+import { IkasTransactionInstallmentPrice } from "./installment-price";
+
+export type IkasTransactionPaymentMethodDetail = {
+  bankName: string | null;
+  binNumber: string;
+  cardAssociation: IkasTransactionCardAssociation | null;
+  cardFamily: string | null;
+  cardType: IkasTransactionCardType | null;
+  installment: IkasTransactionInstallmentPrice | null;
+  lastFourDigits: string;
+  threeDSecure: boolean | null;
+};
+
+export enum IkasTransactionCardAssociation {
+  AMERICAN_EXPRESS = "AMERICAN_EXPRESS",
+  MASTER_CARD = "MASTER_CARD",
+  TROY = "TROY",
+  VISA = "VISA",
+}
+
+export enum IkasTransactionCardType {
+  CREDIT = "CREDIT",
+  DEBIT = "DEBIT",
+  PREPAID = "PREPAID",
+}

package/src/models/order/transaction/payment-method-detail/installment-price/index.ts

@@ -0,0 +1,7 @@
+export type IkasTransactionInstallmentPrice = {
+  installmentCount: number | null;
+  installmentPrice: number | null;
+  originalRate: number | null;
+  rate: number | null;
+  totalPrice: number | null;
+};

package/src/models/payment-gateway/additional-price/index.ts

@@ -0,0 +1,16 @@
+export type IkasPaymentGatewayAdditionalPrice = {
+  amount: number;
+  amountType: IkasPaymentGatewayTransactionFeeType;
+  name: string;
+  type: IkasPaymentGatewayAdditionalPriceType;
+};
+
+export enum IkasPaymentGatewayTransactionFeeType {
+  AMOUNT = "AMOUNT",
+  RATIO = "RATIO",
+}
+
+export enum IkasPaymentGatewayAdditionalPriceType {
+  DECREMENT = "DECREMENT",
+  INCREMENT = "INCREMENT",
+}

package/src/models/payment-gateway/index.ts

@@ -0,0 +1,47 @@
+import { IkasPaymentGatewayAdditionalPrice } from "./additional-price";
+import { IkasBaseModel } from "../base";
+import { IkasPaymentGatewayTranslation } from "./translation";
+import { IkasPaymentGatewaySettings } from "./settings";
+
+export type IkasPaymentGateway = {
+  additionalPrices: IkasPaymentGatewayAdditionalPrice[] | null;
+  availableCountries: string[] | null;
+  code: string;
+  description: string | null;
+  logoUrl: string | null;
+  masterPassClientId: string | null;
+  name: string;
+  paymentGatewayProviderId: string | null;
+  supportedCurrencies: string[] | null;
+  testMode: boolean | null;
+  type: IkasPaymentGatewayType;
+  paymentMethods: IkasPaymentMethod[];
+  paymentMethodType: IkasPaymentMethodType;
+  settings?: IkasPaymentGatewaySettings[] | null;
+
+  translations?: IkasPaymentGatewayTranslation[] | null;
+} & IkasBaseModel;
+
+export enum IkasPaymentMethodType {
+  APP_PAYMENT = "APP_PAYMENT",
+  BUY_ONLINE_PAY_AT_STORE = "BUY_ONLINE_PAY_AT_STORE",
+  CASH = "CASH",
+  CASH_ON_DELIVERY = "CASH_ON_DELIVERY",
+  CREDIT_CARD = "CREDIT_CARD",
+  CREDIT_CARD_ON_DELIVERY = "CREDIT_CARD_ON_DELIVERY",
+  GIFT_CARD = "GIFT_CARD",
+  MONEY_ORDER = "MONEY_ORDER",
+  OTHER = "OTHER",
+  WALLET = "WALLET",
+}
+
+export type IkasPaymentMethod = {
+  name: string;
+  logoUrl: string | null;
+};
+
+export enum IkasPaymentGatewayType {
+  EXTERNAL = "EXTERNAL",
+  INTERNAL = "INTERNAL",
+  THIRD_PARTY = "THIRD_PARTY",
+}

package/src/models/payment-gateway/init.ts

@@ -0,0 +1,26 @@
+import { IkasPaymentGateway } from ".";
+import { IkasPaymentGatewayTranslation } from "./translation";
+
+export function initIkasPaymentGateway(
+  paymentGateway: IkasPaymentGateway,
+  locale: string | null
+) {
+  if (paymentGateway.translations && locale) {
+    setTranslations(paymentGateway, paymentGateway.translations, locale);
+    delete paymentGateway.translations;
+  }
+}
+
+function setTranslations(
+  paymentGateway: IkasPaymentGateway,
+  translations: IkasPaymentGatewayTranslation[],
+  locale: string
+) {
+  if (translations && translations.some((t) => t.locale === locale)) {
+    const localeTranslations = translations.find((t) => t.locale === locale);
+
+    if (localeTranslations?.name) paymentGateway.name = localeTranslations.name;
+    if (localeTranslations?.description)
+      paymentGateway.description = localeTranslations.description;
+  }
+}