@ikas/storefront 1.0.16-alpha.1 → 1.0.16

package/build/models/data/order/index.d.ts

@@ -0,0 +1,146 @@
+import { IkasOrderAddress } from "./address/index";
+import { IkasOrderShippingLine } from "./shipping-line/index";
+import { IkasOrderLineItem } from "./line-item/index";
+export declare class IkasOrder {
+    id: string;
+    orderNumber: string;
+    note: string | null;
+    totalPrice: number | null;
+    totalFinalPrice: number | null;
+    currencyCode: string;
+    currencySymbol: string;
+    orderedAt: number;
+    cancelledAt: number | null;
+    status: IkasOrderStatus;
+    cancelReason: IkasOrderCancelledReason | null;
+    orderPaymentStatus: IkasOrderPaymentStatus | null;
+    orderPackageStatus: IkasOrderPackageStatus | null;
+    shippingMethod: IkasOrderShippingMethod | null;
+    shippingAddress: IkasOrderAddress | null;
+    billingAddress: IkasOrderAddress | null;
+    orderLineItems: IkasOrderLineItem[];
+    orderAdjustments: IkasOrderAdjustment[] | null;
+    shippingLines: IkasOrderShippingLine[] | null;
+    customer: IkasOrderCustomer | null;
+    taxLines: IkasOrderTaxLine[] | null;
+    orderPackages: IkasOrderPackage[] | null;
+    currencyRates: IkasOrderCurrencyRate[] | null;
+    private _refundSettings;
+    constructor(data: IkasOrder);
+    get refundableItems(): IkasOrderLineItem[];
+    get unfullfilledItems(): IkasOrderLineItem[];
+    get refundedItems(): IkasOrderLineItem[];
+    refund: () => Promise<boolean>;
+}
+export declare type IkasOrderAdjustment = {
+    amount: number;
+    amountType: IkasAmountTypeEnum;
+    name: string;
+    order: number;
+    type: IkasAdjustmentEnum;
+    couponId: string | null;
+    appliedOrderLines: IkasOrderAdjustmentAppliedLine[] | null;
+};
+export declare type IkasOrderAdjustmentAppliedLine = {
+    amount: number;
+    appliedQuantity: number;
+    orderLineId: string;
+};
+export declare type IkasOrderCustomer = {
+    id: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+};
+export declare type IkasOrderTaxLine = {
+    price: number;
+    rate: number;
+};
+export declare type IkasOrderPackage = {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    deleted: boolean;
+    orderLineItemIds: string[];
+    orderPackageFulfillStatus: IkasOrderPackageFulfillStatus;
+    orderPackageNumber: string;
+    stockLocationId: string;
+    trackingInfo: IkasOrderTrackingInfo | null;
+};
+export declare type IkasOrderTrackingInfo = {
+    cargoCompany: string;
+    isSendNotification: boolean;
+    trackingLink: string;
+    trackingNumber: string;
+};
+export declare enum IkasOrderStatus {
+    DRAFT = "DRAFT",
+    CREATED = "CREATED",
+    CANCELLED = "CANCELLED",
+    REFUNDED = "REFUNDED"
+}
+export declare enum IkasOrderCancelledReason {
+    CUSTOMER = "CUSTOMER",
+    INVENTORY = "INVENTORY",
+    DECLINED = "DECLINED",
+    OTHER = "OTHER"
+}
+export declare enum IkasAmountTypeEnum {
+    AMOUNT = "AMOUNT",
+    RATIO = "RATIO"
+}
+declare enum IkasAdjustmentEnum {
+    DECREMENT = "DECREMENT",
+    INCREMENT = "INCREMENT"
+}
+export declare enum IkasOrderPaymentStatus {
+    WAITING = "WAITING",
+    PAID = "PAID",
+    PARTIALLY_PAID = "PARTIALLY_PAID"
+}
+export declare enum IkasOrderPackageStatus {
+    CANCELLED = "CANCELLED",
+    CANCEL_REJECTED = "CANCEL_REJECTED",
+    CANCEL_REQUESTED = "CANCEL_REQUESTED",
+    DELIVERED = "DELIVERED",
+    FULFILLED = "FULFILLED",
+    READY_FOR_SHIPMENT = "READY_FOR_SHIPMENT",
+    PARTIALLY_CANCELLED = "PARTIALLY_CANCELLED",
+    PARTIALLY_DELIVERED = "PARTIALLY_DELIVERED",
+    PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED",
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+    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 declare enum IkasOrderPackageFulfillStatus {
+    DELIVERED = "DELIVERED",
+    FULFILLED = "FULFILLED",
+    SHIPPED = "SHIPPED"
+}
+export declare enum IkasOrderShippingMethod {
+    CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
+    SHIPMENT = "SHIPMENT",
+    NO_SHIPMENT = "NO_SHIPMENT"
+}
+export declare type IkasOrderCurrencyRate = {
+    code: string;
+    originalRate: number;
+    rate: number;
+};
+export declare enum OrderLineItemStatusEnum {
+    FULFILLED = "FULFILLED",
+    UNFULFILLED = "UNFULFILLED",
+    DELIVERED = "DELIVERED",
+    CANCELLED = "CANCELLED",
+    CANCEL_REQUESTED = "CANCEL_REQUESTED",
+    CANCEL_REJECTED = "CANCEL_REJECTED",
+    REFUND_REQUESTED = "REFUND_REQUESTED",
+    REFUND_REQUEST_ACCEPTED = "REFUND_REQUEST_ACCEPTED",
+    REFUNDED = "REFUNDED",
+    REFUND_REJECTED = "REFUND_REJECTED"
+}
+export {};

package/build/models/data/order/line-item/discount/index.d.ts

@@ -0,0 +1,11 @@
+declare enum IkasAmountTypeEnum {
+    AMOUNT = "AMOUNT",
+    RATIO = "RATIO"
+}
+export declare class IkasOrderLineDiscount {
+    amount: number;
+    amountType: IkasAmountTypeEnum;
+    reason: string | null;
+    constructor(data: IkasOrderLineDiscount);
+}
+export {};

package/build/models/data/order/line-item/index.d.ts

@@ -0,0 +1,43 @@
+import { IkasOrderLineDiscount } from "./discount/index";
+import { IkasOrderLineVariant } from "./variant/index";
+import { IkasOrderLineOptions } from "./options/index";
+export declare class IkasOrderLineItem {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    orderedAt: number;
+    deleted: boolean;
+    currencyCode: string;
+    currencySymbol: string;
+    discount?: IkasOrderLineDiscount | null;
+    discountPrice?: number | null;
+    finalPrice: number;
+    options: IkasOrderLineOptions[] | null;
+    originalOrderLineItemId?: string | null;
+    price: number;
+    quantity: number;
+    taxValue?: number | null;
+    private _refundQuantity?;
+    variant: IkasOrderLineVariant;
+    status: OrderLineItemStatusEnum;
+    constructor(data: Partial<IkasOrderLineItem>);
+    get orderedAtDays(): number;
+    get priceWithQuantity(): number;
+    get overridenPriceWithQuantity(): number | null;
+    get finalPriceWithQuantity(): number;
+    get tax(): number;
+    get refundQuantity(): number | null | undefined;
+    set refundQuantity(value: number | null | undefined);
+}
+export declare enum OrderLineItemStatusEnum {
+    FULFILLED = "FULFILLED",
+    UNFULFILLED = "UNFULFILLED",
+    DELIVERED = "DELIVERED",
+    CANCELLED = "CANCELLED",
+    CANCEL_REQUESTED = "CANCEL_REQUESTED",
+    CANCEL_REJECTED = "CANCEL_REJECTED",
+    REFUND_REQUESTED = "REFUND_REQUESTED",
+    REFUND_REQUEST_ACCEPTED = "REFUND_REQUEST_ACCEPTED",
+    REFUNDED = "REFUNDED",
+    REFUND_REJECTED = "REFUND_REJECTED"
+}

package/build/models/data/order/line-item/options/index.d.ts

@@ -0,0 +1,10 @@
+import { IkasProductOptionType } from "../../../product-option-set/index";
+import { IkasOrderLineOptionsValue } from "./options-value/index";
+export declare class IkasOrderLineOptions {
+    name: string;
+    productOptionId: string;
+    productOptionsSetId: string;
+    type: IkasProductOptionType;
+    values: IkasOrderLineOptionsValue[];
+    constructor(data: IkasOrderLineOptions);
+}

package/build/models/data/order/line-item/options/options-value/index.d.ts

@@ -0,0 +1,6 @@
+export declare class IkasOrderLineOptionsValue {
+    name: string | null;
+    price: number | null;
+    value: string;
+    constructor(data: IkasOrderLineOptionsValue);
+}

package/build/models/data/order/line-item/variant/index.d.ts

@@ -0,0 +1,25 @@
+import { IkasImage } from "../../../image/index";
+export declare class IkasOrderLineVariant {
+    id: string;
+    name: string;
+    productId: string;
+    sku?: string | null;
+    slug?: string | null;
+    barcodeList: string[];
+    mainImageId?: string | null;
+    taxValue: number;
+    variantValues: IkasOrderLineVariantVariantValue[];
+    mainImage?: IkasImage | null;
+    constructor(data?: Partial<IkasOrderLineVariant>);
+    get href(): string | undefined;
+}
+export declare class IkasOrderLineVariantVariantValue {
+    order: number;
+    variantTypeId: string;
+    variantTypeName: string;
+    variantValueId: string;
+    variantValueName: string;
+    constructor(data: IkasOrderLineVariantVariantValue);
+    get variantTypeSlug(): string;
+    get variantNameSlug(): string;
+}

package/build/models/data/order/refund/index.d.ts

@@ -0,0 +1,6 @@
+import { IkasOrderRefundOrderLineInput } from "./refund-line-item/index";
+export declare class IkasRefund {
+    orderId: string;
+    orderLineItems: IkasOrderRefundOrderLineInput[];
+    constructor(data: Partial<IkasRefund>);
+}

package/build/models/data/order/refund/refund-line-item/index.d.ts

@@ -0,0 +1,5 @@
+export declare class IkasOrderRefundOrderLineInput {
+    quantity: number;
+    orderLineItemId: string;
+    constructor(data: Partial<IkasOrderRefundOrderLineInput>);
+}

package/build/models/data/order/refund/settings.d.ts

@@ -0,0 +1,6 @@
+export declare class IkasOrderRefundSettings {
+    isActiveRefundSection: boolean;
+    orderRefundDayLimit: number | null;
+    refundDesc: string;
+    constructor(data: Partial<IkasOrderRefundSettings>);
+}

package/build/models/data/order/shipping-line/index.d.ts

@@ -0,0 +1,7 @@
+export declare type IkasOrderShippingLine = {
+    price: number;
+    taxValue: number | null;
+    title: string;
+    shippingSettingsId: string;
+    shippingZoneRateId: string;
+};

package/build/models/data/order-transaction/index.d.ts

@@ -0,0 +1,74 @@
+export declare class IkasOrderTransaction {
+    amount: number | null;
+    checkoutId: string | null;
+    createdAt: number | null;
+    currencyCode: string | null;
+    currencySymbol: string | null;
+    customerId: string | null;
+    error: IkasTransactionError | null;
+    id: string | null;
+    orderId: string | null;
+    paymentGatewayId: string | null;
+    paymentGatewayName: string | null;
+    paymentMethod: IkasPaymentMethodEnum | null;
+    paymentMethodDetail: IkasTransactionPaymentMethodDetail | null;
+    processedAt: number | null;
+    refundReason: string | null;
+    status: IkasTransactionStatusEnum | null;
+    type: IkasTransactionTypeEnum | null;
+    updatedAt: number | null;
+    constructor(data?: Partial<IkasOrderTransaction>);
+}
+declare type IkasTransactionError = {
+    code: string;
+    declineCode: string;
+    message: string;
+};
+export declare enum IkasPaymentMethodEnum {
+    BUY_ONLINE_PAY_AT_STORE = "BUY_ONLINE_PAY_AT_STORE",
+    CASH = "CASH",
+    CASH_ON_DELIVERY = "CASH_ON_DELIVERY",
+    CREDIT_CARD_ON_DELIVERY = "CREDIT_CARD_ON_DELIVERY",
+    CREDIT_CARD = "CREDIT_CARD",
+    GIFT_CARD = "GIFT_CARD",
+    MONEY_ORDER = "MONEY_ORDER",
+    OTHER = "OTHER"
+}
+export declare type IkasTransactionPaymentMethodDetail = {
+    bankName: string;
+    binNumber: string;
+    cardAssociation: IkasTransactionCardAssociationEnum;
+    cardFamily: string;
+    cardType: IkasTransactionCardTypeEnum;
+    installment: IkasTransactionInstallmentPrice | null;
+    lastFourDigits: string;
+    threeDSecure: boolean;
+};
+export declare enum IkasTransactionCardAssociationEnum {
+    AMERICAN_EXPRESS = "AMERICAN_EXPRESS",
+    MASTER_CARD = "MASTER_CARD",
+    TROY = "TROY",
+    VISA = "VISA"
+}
+export declare enum IkasTransactionCardTypeEnum {
+    CREDIT = "CREDIT",
+    DEBIT = "DEBIT",
+    PREPAID = "PREPAID"
+}
+export declare type IkasTransactionInstallmentPrice = {
+    installmentCount: number | null;
+    installmentPrice: number | null;
+    totalPrice: number | null;
+};
+export declare enum IkasTransactionStatusEnum {
+    FAILED = "FAILED",
+    PENDING = "PENDING",
+    SUCCESS = "SUCCESS",
+    AUTHORIZED = "AUTHORIZED"
+}
+export declare enum IkasTransactionTypeEnum {
+    REFUND = "REFUND",
+    SALE = "SALE",
+    VOID = "VOID"
+}
+export {};

package/build/models/data/payment-gateway/index.d.ts

@@ -0,0 +1,61 @@
+import { IkasOrderShippingLine } from "../order/shipping-line/index";
+export declare class IkasPaymentGateway {
+    paymentMethods: IkasPaymentMethod[];
+    paymentMethodType: IkasPaymentMethodType;
+    id: string | null;
+    name: string;
+    code: string;
+    type: IkasPaymentGatewayType;
+    logoUrl: string | null;
+    testMode: boolean | null;
+    description: string | null;
+    additionalPrices: IkasPaymentGatewayAdditionalPrice[] | null;
+    translations: IkasPaymentGatewayTranslation[] | null;
+    supportedCurrencies: string[];
+    availableCountries: string[];
+    constructor(data: Partial<IkasPaymentGateway>);
+    getCalculatedAdditionalPrices(totalFinalPrice: number, shippingLines: IkasOrderShippingLine[] | null): {
+        name: string;
+        amount: number;
+        type: IkasPaymentMethodAdditionalPriceType;
+    }[] | undefined;
+    private setTranslations;
+}
+export declare type IkasPaymentMethod = {
+    name: string;
+    logoUrl: string | null;
+};
+export declare class IkasPaymentGatewayAdditionalPrice {
+    amount: number;
+    amountType: IkasPaymentGatewayAdditionalPriceAmountType;
+    name: string;
+    type: IkasPaymentMethodAdditionalPriceType;
+    constructor(data: Partial<IkasPaymentGatewayAdditionalPrice>);
+}
+export declare enum IkasPaymentMethodType {
+    BUY_ONLINE_PAY_AT_STORE = "BUY_ONLINE_PAY_AT_STORE",
+    CASH = "CASH",
+    CASH_ON_DELIVERY = "CASH_ON_DELIVERY",
+    CREDIT_CARD = "CREDIT_CARD",
+    GIFT_CARD = "GIFT_CARD",
+    MONEY_ORDER = "MONEY_ORDER",
+    OTHER = "OTHER"
+}
+export declare enum IkasPaymentMethodAdditionalPriceType {
+    DECREMENT = "DECREMENT",
+    INCREMENT = "INCREMENT"
+}
+export declare enum IkasPaymentGatewayAdditionalPriceAmountType {
+    AMOUNT = "AMOUNT",
+    RATIO = "RATIO"
+}
+export declare enum IkasPaymentGatewayType {
+    EXTERNAL = "EXTERNAL",
+    INTERNAL = "INTERNAL"
+}
+declare type IkasPaymentGatewayTranslation = {
+    description: string | null;
+    locale: string;
+    name: string | null;
+};
+export {};

package/build/models/data/product/attribute-value/index.d.ts

@@ -0,0 +1,20 @@
+import { IkasProductAttribute } from "../../product-attribute/index";
+import IkasProductAttributeOption from "../../product-attribute/product-attribute-option/index";
+export declare class IkasProductAttributeValue {
+    value: any;
+    productAttributeId: string | null;
+    productAttributeOptionId: string | null;
+    productAttribute?: IkasProductAttribute | null;
+    productAttributeOption?: IkasProductAttributeOption | null;
+    constructor(data: Partial<IkasProductAttributeValue>);
+    get tableValue(): IkasAttributeTableCellValue[] | undefined;
+}
+export declare type IkasAttributeTableCellValue = {
+    colId: string;
+    rowId: string;
+    value: string | null;
+};
+export declare type IkasProductAttributeMap = {
+    attribute: IkasProductAttribute;
+    values: IkasProductAttributeValue[];
+};

package/build/models/data/product/index.d.ts

@@ -0,0 +1,35 @@
+import { IkasCategory } from "../category/index";
+import { IkasProductVariant } from "./variant/index";
+import { IkasProductAttributeValue } from "./attribute-value/index";
+import { IkasProductVariantType } from "./variant-type/index";
+import { IkasBrand } from "../brand/index";
+import { IkasHTMLMetaData } from "../html-meta-data/index";
+import { IkasProductTag } from "../product-tag/index";
+import { IkasProductOptionSet } from "../product-option-set/index";
+export declare class IkasProduct {
+    id: string;
+    name: string;
+    type: IkasProductType;
+    description: string;
+    shortDescription: string;
+    metaData?: IkasHTMLMetaData;
+    brand: IkasBrand | null;
+    categories: IkasCategory[];
+    tags: IkasProductTag[] | null;
+    variants: IkasProductVariant[];
+    attributes: IkasProductAttributeValue[];
+    variantTypes: IkasProductVariantType[];
+    productOptionSetId?: string | null;
+    productOptionSet?: IkasProductOptionSet | null;
+    constructor(data?: Partial<IkasProduct>);
+    get hasVariant(): boolean;
+    get hasStock(): boolean;
+    get mainVariantType(): import("../index").IkasVariantType | undefined;
+    get href(): string;
+    get canAddToCart(): boolean;
+}
+export declare enum IkasProductType {
+    PHYSICAL = "PHYSICAL",
+    DIGITAL = "DIGITAL",
+    MEMBERSHIP = "MEMBERSHIP"
+}

package/build/models/data/product/variant/index.d.ts

@@ -0,0 +1,24 @@
+import { IkasProductPrice } from "./price/index";
+import { IkasVariantValue } from "../../variant-type/variant-value/index";
+import { IkasProductAttributeValue } from "../attribute-value/index";
+import { IkasImage } from "../../image/index";
+export declare class IkasProductVariant {
+    id: string;
+    sku: string | null;
+    barcodeList: string[];
+    variantValues: IkasVariantValue[];
+    images: IkasImage[];
+    attributes: IkasProductAttributeValue[];
+    price: IkasProductPrice;
+    stock: number;
+    isActive: boolean;
+    productId: string;
+    private _backInStockReminderSaved;
+    constructor(data?: Partial<IkasProductVariant>);
+    get mainImage(): IkasImage | undefined;
+    get hasStock(): boolean;
+    get isBackInStockEnabled(): boolean;
+    get isBackInStockCustomerLoginRequired(): boolean | null;
+    get isBackInStockReminderSaved(): boolean;
+    saveBackInStockReminder(email: string): Promise<boolean>;
+}

package/build/models/data/product/variant/price/index.d.ts

@@ -0,0 +1,11 @@
+export declare class IkasProductPrice {
+    sellPrice: number;
+    discountPrice: number | null;
+    currency: string;
+    currencySymbol: string;
+    constructor(data?: Partial<IkasProductPrice>);
+    get finalPrice(): number;
+    get hasDiscount(): boolean;
+    get discountAmount(): number;
+    get discountPercentage(): string | 0;
+}

package/build/models/data/product/variant-type/index.d.ts

@@ -0,0 +1,6 @@
+import { IkasVariantType } from "../../variant-type/index";
+export declare class IkasProductVariantType {
+    variantType: IkasVariantType;
+    variantValueIds: string[];
+    constructor(data: Partial<IkasProductVariantType>);
+}

package/build/models/data/product-attribute/index.d.ts

@@ -0,0 +1,34 @@
+import IkasProductAttributeOption from "./product-attribute-option/index";
+import { IkasProductAttributeTableTemplate } from "./product-attribute-table-template/index";
+export declare class IkasProductAttribute {
+    id: string;
+    name: string;
+    description: string | null;
+    type: IkasProductAttributeType;
+    options?: IkasProductAttributeOption[] | null;
+    tableTemplate?: IkasProductAttributeTableTemplate | null;
+    translations: IkasProductAttributeTranslation[] | null;
+    constructor(data: Partial<IkasProductAttribute>);
+    private setTranslations;
+}
+export declare enum IkasProductAttributeType {
+    CHOICE = "CHOICE",
+    MULTIPLE_CHOICE = "MULTIPLE_CHOICE",
+    TEXT = "TEXT",
+    BOOLEAN = "BOOLEAN",
+    NUMERIC = "NUMERIC",
+    DATETIME = "DATETIME",
+    HTML = "HTML",
+    TABLE = "TABLE"
+}
+declare type IkasProductAttributeTranslation = {
+    description: string | null;
+    locale: string;
+    name: string | null;
+    options: IkasProductAttributeOptionTranslation[] | null;
+};
+declare type IkasProductAttributeOptionTranslation = {
+    id: string;
+    name: string | null;
+};
+export {};

package/build/models/data/product-attribute/product-attribute-option/index.d.ts

@@ -0,0 +1,5 @@
+export default class IkasProductAttributeOption {
+    id: string;
+    name: string;
+    constructor(data?: Partial<IkasProductAttributeOption>);
+}

package/build/models/data/product-attribute/product-attribute-table-cell/index.d.ts

@@ -0,0 +1,5 @@
+export declare class IkasProductAttributeTableCell {
+    id: string;
+    name: string | null;
+    constructor(data?: Partial<IkasProductAttributeTableCell>);
+}

package/build/models/data/product-attribute/product-attribute-table-template/index.d.ts

@@ -0,0 +1,6 @@
+import { IkasProductAttributeTableCell } from "../product-attribute-table-cell/index";
+export declare class IkasProductAttributeTableTemplate {
+    columns: IkasProductAttributeTableCell[] | null;
+    rows: IkasProductAttributeTableCell[] | null;
+    constructor(data?: Partial<IkasProductAttributeTableTemplate>);
+}

package/build/models/data/product-back-in-stock-settings/index.d.ts

@@ -0,0 +1,3 @@
+export declare type IkasProductBackInStockSettings = {
+    customerLoginRequired: boolean;
+};

package/build/models/data/product-cart-item-options/index.d.ts

@@ -0,0 +1,6 @@
+export declare class IkasProductCartLineOption {
+    productOptionId: string;
+    productOptionsSetId: string;
+    values: string[];
+    constructor(data?: Partial<IkasProductCartLineOption>);
+}