@ikas/storefront-models 4.0.0-alpha.9 → 4.0.0-beta.10

package/src/models/customer/index.ts

@@ -1,48 +0,0 @@
-import { IkasCustomerAddress } from "./address";
-import { IkasCustomerAttributeValue } from "./attribute/value";
-import { IkasBaseModel } from "../base";
-
-export type IkasCustomer = {
-  accountStatusUpdatedAt: number | null;
-  customerGroupIds: string[] | null;
-  customerSequence: number | null;
-  email: string | null;
-  emailVerifiedDate: number | null;
-  firstName: string;
-  fullName: string | null;
-  isEmailVerified: boolean | null;
-  isPhoneVerified: boolean | null;
-  lastName: string | null;
-  note: string | null;
-  orderCount: number | null;
-  passwordUpdateDate: number | null;
-  phone: string | null;
-  phoneVerifiedDate: number | null;
-  subscriptionStatusUpdatedAt: number | null;
-  tagIds: string[] | null;
-
-  registrationSource: IkasCustomerRegistrationSource | null;
-  accountStatus: IkasCustomerAccountStatus | null;
-  addresses: IkasCustomerAddress[] | null;
-  subscriptionStatus: IkasCustomerEmailSubscriptionStatus | null;
-  attributes: IkasCustomerAttributeValue[] | null;
-} & IkasBaseModel;
-
-export enum IkasCustomerAccountStatus {
-  ACTIVE_ACCOUNT = "ACTIVE_ACCOUNT",
-  DECLINED_ACCOUNT_INVITATION = "DECLINED_ACCOUNT_INVITATION",
-  DISABLED_ACCOUNT = "DISABLED_ACCOUNT",
-  INVITED_TO_CREATE_ACCOUNT = "INVITED_TO_CREATE_ACCOUNT",
-}
-
-export enum IkasCustomerRegistrationSource {
-  credentials = "credentials",
-  facebook = "facebook",
-  google = "google",
-}
-
-export enum IkasCustomerEmailSubscriptionStatus {
-  NOT_SUBSCRIBED = "NOT_SUBSCRIBED",
-  PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
-  SUBSCRIBED = "SUBSCRIBED",
-}

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

@@ -1,28 +0,0 @@
-import { IkasBaseModel } from "../../base";
-import { IkasImage } from "../../image";
-
-export type IkasCustomerReview = {
-  comment: string | null;
-  customerId: string | null;
-  email: string | null;
-  firstName: string | null;
-  imageIds: string[] | null;
-  lastName: string | null;
-  orderId: string | null;
-  orderNumber: string | null;
-  productId: string;
-  salesChannelId: string | null;
-  star: number;
-  status: IkasCustomerReviewStatus | null;
-  storefrontId: string | null;
-  title: string | null;
-
-  // Extra
-  images?: IkasImage[] | null;
-} & IkasBaseModel;
-
-export enum IkasCustomerReviewStatus {
-  APPROVED = "APPROVED",
-  REJECTED = "REJECTED",
-  WAITING = "WAITING",
-}

package/src/models/customer/review/init.ts

@@ -1,7 +0,0 @@
-import { IkasCustomerReview } from ".";
-
-export function initIkasCustomerReview(customerReview: IkasCustomerReview) {
-  customerReview.images = customerReview.imageIds
-    ? customerReview.imageIds.map((id) => ({ id, isVideo: false }))
-    : null;
-}

package/src/models/customer/review/settings/index.ts

@@ -1,4 +0,0 @@
-export type IkasCustomerReviewSettings = {
-  customerLoginRequired: boolean;
-  customerPurchaseRequired: boolean;
-};

package/src/models/customer/review/summary/index.ts

@@ -1,9 +0,0 @@
-import { IkasBaseModel } from "../../../base";
-import { IkasCustomerReviewSummaryStar } from "./star";
-
-export type IkasCustomerReviewSummary = {
-  averageStar: number;
-  productId: string;
-  stars: IkasCustomerReviewSummaryStar[];
-  totalReview: number;
-} & IkasBaseModel;

package/src/models/customer/review/summary/star/index.ts

@@ -1,4 +0,0 @@
-export type IkasCustomerReviewSummaryStar = {
-  count: number;
-  star: number;
-};

package/src/models/district/index.ts

@@ -1,11 +0,0 @@
-import { IkasBaseModel } from "../base";
-
-export type IkasDistrict = {
-  cityId: string;
-  countryId: string;
-  latitude: string | null;
-  longitude: string | null;
-  name: string;
-  order: number | null;
-  stateId: string;
-} & IkasBaseModel;

package/src/models/favorite-product/index.ts

@@ -1,6 +0,0 @@
-import { IkasBaseModel } from "../base";
-
-export type IkasFavoriteProduct = {
-  customerId: string;
-  productId: string;
-} & IkasBaseModel;

package/src/models/filter-category/index.ts

@@ -1,9 +0,0 @@
-import { IkasHTMLMetaData } from "../html-meta-data";
-
-export type IkasFilterCategory = {
-  id: string;
-  name: string;
-  metaData: IkasHTMLMetaData | null;
-  resultCount: number | null;
-  isSelected: boolean;
-};

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

@@ -1,28 +0,0 @@
-import { IkasBaseModel } from "../base";
-import { IkasHTMLMetaDataTranslations } from "./translations";
-
-export type IkasHTMLMetaData = {
-  canonicals?: string[] | null;
-  description?: string | null;
-  disableIndex?: boolean | null;
-  pageTitle?: string | null;
-  slug: string;
-  targetId?: string | null;
-  targetType?: IkasHTMLMetaDataTargetType | null;
-  translations?: IkasHTMLMetaDataTranslations[] | null;
-} & IkasBaseModel;
-
-export type IkasHTMLMetaDataOverride = {
-  description: string;
-  language: string | null;
-  pageTitle: string;
-  storefrontId: string | null;
-  storefrontRegionId: string | null;
-};
-
-export enum IkasHTMLMetaDataTargetType {
-  BRAND = "BRAND",
-  CATEGORY = "CATEGORY",
-  PAGE = "PAGE",
-  PRODUCT = "PRODUCT",
-}

package/src/models/html-meta-data/init.ts

@@ -1,27 +0,0 @@
-import { IkasHTMLMetaData } from ".";
-
-export function initIkasHTMLMetaData(
-  metaData: IkasHTMLMetaData,
-  locale: string | null
-) {
-  if (locale) setHTMLMetaDataTranslations(metaData, locale);
-}
-
-export function setHTMLMetaDataTranslations(
-  metaData: IkasHTMLMetaData,
-  locale: string
-) {
-  if (
-    metaData.translations &&
-    metaData.translations.some((t) => t.locale === locale)
-  ) {
-    const localeTranslations = metaData.translations.find(
-      (t) => t.locale === locale
-    );
-
-    if (localeTranslations?.pageTitle)
-      metaData.pageTitle = localeTranslations.pageTitle;
-    if (localeTranslations?.description)
-      metaData.description = localeTranslations.description;
-  }
-}

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

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

package/src/models/image/index.ts

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

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

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

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

@@ -1,25 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

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

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

@@ -1,7 +0,0 @@
-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

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

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

@@ -1,25 +0,0 @@
-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

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

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

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

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

@@ -1,24 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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

package/src/models/order/index.ts

@@ -1,90 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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

@@ -1,10 +0,0 @@
-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

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

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

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

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

@@ -1,10 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

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

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

@@ -1,28 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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

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

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

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

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