@ikas/storefront 0.0.1

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

@@ -0,0 +1,10 @@
+import { IkasImage } from "../image/index";
+import { IkasHTMLMetaData } from "../html-meta-data/index";
+export declare class IkasBrand {
+    id: string;
+    name: string;
+    metaData?: IkasHTMLMetaData;
+    image?: IkasImage;
+    constructor(data: Partial<IkasBrand>);
+    get href(): string;
+}

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

@@ -0,0 +1,30 @@
+import { IkasOrderLineItem } from "../order/line-item/index";
+export declare class IkasCart {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    dueDate?: string;
+    currencyCode: string;
+    customerId?: string;
+    itemCount: number;
+    items: IkasOrderLineItem[];
+    merchantId: string;
+    totalPrice: number;
+    constructor(data: Partial<IkasCart>);
+    get totalTax(): number;
+}
+declare type IkasCartLineItemInput = {
+    id: string | null;
+    quantity: number;
+    variant: IkasCartLineVariantInput;
+};
+declare type IkasCartLineVariantInput = {
+    id: string;
+    name: string;
+};
+export declare type IkasSaveItemToCartInput = {
+    cartId: string | null;
+    customerId: string | null;
+    item: IkasCartLineItemInput;
+};
+export {};

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

@@ -0,0 +1,11 @@
+import { IkasImage } from "../image/index";
+import { IkasHTMLMetaData } from "../html-meta-data/index";
+export declare class IkasCategory {
+    id: string;
+    name: string;
+    parentId: string | null;
+    metaData?: IkasHTMLMetaData;
+    image?: IkasImage;
+    constructor(data: Partial<IkasCategory>);
+    get href(): string;
+}

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

@@ -0,0 +1,87 @@
+import { IkasOrderAddress } from "../order/address/index";
+import { IkasOrderShippingLine } from "../order/shipping-line/index";
+import { IkasCart } from "../cart/index";
+import { IkasOrderAdjustment } from "../order/index";
+export declare class IkasCheckout {
+    id?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    cartId?: string;
+    cart?: IkasCart;
+    orderId?: string;
+    orderNumber?: string;
+    merchantId?: string;
+    shippingSettingsId?: string;
+    shippingZoneRateId?: string;
+    availableShippingMethods: IkasAvailableShippingMethod[];
+    customer?: IkasCheckoutCustomer;
+    billingAddress?: IkasOrderAddress;
+    shippingAddress?: IkasOrderAddress;
+    shippingLines?: IkasOrderShippingLine[];
+    shippingMethod?: IkasShippingMethod;
+    status?: IkasCheckoutStatus;
+    couponCode?: string;
+    recoverEmailStatus?: IkasCheckoutRecoveryEmailStatus;
+    recoveryStatus?: IkasCheckoutRecoveryStatus;
+    totalFinalPrice?: number;
+    adjustments?: IkasOrderAdjustment[];
+    constructor(data?: Partial<IkasCheckout>);
+    get shippingTotal(): number;
+    get hasCustomer(): boolean;
+    get hasValidCustomer(): boolean;
+    get customerText(): string;
+    get dateStr(): string;
+}
+export declare type IkasCheckoutCustomer = {
+    id?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+};
+export declare enum IkasShippingMethod {
+    CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
+    NO_SHIPMENT = "NO_SHIPMENT",
+    SHIPMENT = "SHIPMENT"
+}
+export declare enum IkasCheckoutStatus {
+    COMPLETED = "COMPLETED",
+    OPEN = "OPEN"
+}
+export declare enum IkasCheckoutRecoveryEmailStatus {
+    NOT_SENT = "NOT_SENT",
+    SENT = "SENT"
+}
+export declare enum IkasCheckoutRecoveryStatus {
+    NOT_RECOVERED = "NOT_RECOVERED",
+    RECOVERED = "RECOVERED"
+}
+export declare enum IkasPaymentMethod {
+    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 type IkasPaymentMethodDetail = {
+    cardHolderName: string;
+    cardNumber: string;
+    cvv: string;
+    expiredMonth: number;
+    expiredYear: number;
+    installmentCount: number;
+    threeDSecure: boolean;
+};
+export declare enum IkasShippingMethodEnum {
+    CLICK_AND_COLLECT = "CLICK_AND_COLLECT",
+    NO_SHIPMENT = "NO_SHIPMENT",
+    SHIPMENT = "SHIPMENT"
+}
+export declare type IkasAvailableShippingMethod = {
+    price: number;
+    rateName: string;
+    shippingMethod: IkasShippingMethodEnum;
+    shippingSettingsId: string;
+    shippingZoneRateId: string;
+};

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

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

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

@@ -0,0 +1,6 @@
+export declare type IkasCountry = {
+    id: string;
+    name: string;
+    iso3?: string;
+    phoneCode?: string;
+};

package/build/models/data/customer/address/index.d.ts

@@ -0,0 +1,44 @@
+export declare class IkasCustomerAddress {
+    id?: string;
+    title?: string;
+    addressLine1?: string;
+    addressLine2?: string;
+    country?: IkasCustomerAddressCountry;
+    state?: IkasCustomerAddressState;
+    city?: IkasCustomerAddressCity;
+    district?: IkasCustomerAddressDistrict;
+    isDefault?: boolean;
+    company?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    postalCode?: string;
+    identityNumber?: string;
+    taxNumber?: string;
+    taxOffice?: string;
+    constructor(data?: Partial<IkasCustomerAddress>);
+    get addressText(): string;
+    get validationResult(): IkasAddressValidationResult;
+    get isValid(): boolean;
+}
+declare type IkasCustomerAddressLocation = {
+    id?: string;
+    name?: string;
+    code?: string;
+};
+export declare type IkasCustomerAddressCountry = IkasCustomerAddressLocation;
+export declare type IkasCustomerAddressCity = IkasCustomerAddressLocation;
+export declare type IkasCustomerAddressDistrict = IkasCustomerAddressLocation;
+export declare type IkasCustomerAddressState = IkasCustomerAddressLocation;
+export declare type IkasAddressValidationResult = {
+    firstName: boolean;
+    lastName: boolean;
+    addressLine1: boolean;
+    postalCode: boolean;
+    country: boolean;
+    state: boolean;
+    city: boolean;
+    phone: boolean;
+    title: boolean;
+};
+export {};

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

@@ -0,0 +1,19 @@
+import { IkasCustomerAddress } from "./address/index";
+export declare class IkasCustomer {
+    id: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone?: string;
+    isEmailVerified: boolean;
+    isPhoneVerified: boolean;
+    accountStatus: IkasCustomerAccountStatus;
+    addresses: IkasCustomerAddress[];
+    constructor(data: Partial<IkasCustomer>);
+}
+export declare enum IkasCustomerAccountStatus {
+    ACTIVE_ACCOUNT = "ACTIVE_ACCOUNT",
+    DECLINED_ACCOUNT_INVITATION = "DECLINED_ACCOUNT_INVITATION",
+    DISABLED_ACCOUNT = "DISABLED_ACCOUNT",
+    INVITED_TO_CREATE_ACCOUNT = "INVITED_TO_CREATE_ACCOUNT"
+}

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

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

package/build/models/data/html-meta-data/index.d.ts

@@ -0,0 +1,15 @@
+export declare class IkasHTMLMetaData {
+    slug: string;
+    pageTitle: string | null;
+    description: string | null;
+    targetType: IkasHTMLMetaDataTargetType | null;
+    targetId: string | null;
+    redirectTo?: string;
+    constructor(data?: Partial<IkasHTMLMetaData>);
+}
+export declare enum IkasHTMLMetaDataTargetType {
+    PRODUCT = "PRODUCT",
+    CATEGORY = "CATEGORY",
+    BRAND = "BRAND",
+    PAGE = "PAGE"
+}

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

@@ -0,0 +1,7 @@
+export declare class IkasImage {
+    id: string;
+    constructor(id: string);
+    get editorApiKey(): any;
+    get src(): string;
+    get thumbnailSrc(): string;
+}

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

@@ -0,0 +1,25 @@
+export { IkasBrand } from "./brand/index";
+export { IkasCategory } from "./category/index";
+export * from "./checkout/index";
+export type { IkasCity } from "./city/index";
+export * from "./customer/address/index";
+export { IkasCustomer } from "./customer/index";
+export type { IkasCountry } from "./country/index";
+export type { IkasDistrict } from "./district/index";
+export { IkasHTMLMetaData, IkasHTMLMetaDataTargetType } from "./html-meta-data/index";
+export { IkasImage } from "./image/index";
+export * from "./installment-info/index";
+export type { IkasInstallmentInfo, IkasInstallmentPrice, IkasInstallmentInfoInput, } from "./installment-info/index";
+export * from "./merchant-settings/index";
+export * from "./order/index";
+export { IkasOrderLineItem } from "./order/line-item/index";
+export { IkasProduct, IkasProductType } from "./product/index";
+export { IkasProductVariantType } from "./product/variant-type/index";
+export { IkasProductVariant } from "./product/variant/index";
+export { IkasProductPrice } from "./product/variant/price/index";
+export { IkasProductAttribute } from "./product-attribute/index";
+export { IkasProductAttributeValue } from "./product/attribute-value/index";
+export type { IkasState } from "./state/index";
+export * from "./variant-type/index";
+export { IkasVariantValue } from "./variant-type/variant-value/index";
+export { IkasOrderTransaction, IkasTransactionStatusEnum, IkasTransactionTypeEnum, } from "./order-transaction/index";

package/build/models/data/installment-info/index.d.ts

@@ -0,0 +1,30 @@
+export declare type IkasInstallmentInfo = {
+    bankName: string | null;
+    binNumber: string;
+    cardAssociation: IkasCardAssociation;
+    cardFamily: string | null;
+    cardType: IkasCardType;
+    installmentPrices: IkasInstallmentPrice[];
+    price: number;
+};
+export declare type IkasInstallmentPrice = {
+    installmentCount: number | null;
+    installmentPrice: number | null;
+    totalPrice: number | null;
+};
+export declare type IkasInstallmentInfoInput = {
+    binNumber: string;
+    paymentGatewayId: string;
+    price: number;
+};
+export declare enum IkasCardAssociation {
+    AMERICAN_EXPRESS = "AMERICAN_EXPRESS",
+    MASTER_CARD = "MASTER_CARD",
+    TROY = "TROY",
+    VISA = "VISA"
+}
+export declare enum IkasCardType {
+    CREDIT = "CREDIT",
+    DEBIT = "DEBIT",
+    PREPAID = "PREPAID"
+}

package/build/models/data/merchant-settings/index.d.ts

@@ -0,0 +1,8 @@
+import { IkasImage } from "../image/index";
+export declare class IkasMerchantSettings {
+    id: string;
+    logoId: string;
+    merchantName: string;
+    logo: IkasImage;
+    constructor(data?: Partial<IkasMerchantSettings>);
+}

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

@@ -0,0 +1,41 @@
+export declare class IkasOrderAddress {
+    addressLine1?: string;
+    addressLine2?: string;
+    country?: IkasOrderAddressCountry;
+    state?: IkasOrderAddressState;
+    city?: IkasOrderAddressCity;
+    district?: IkasOrderAddressDistrict;
+    isDefault?: boolean;
+    company?: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    postalCode?: string;
+    identityNumber?: string;
+    taxNumber?: string;
+    taxOffice?: string;
+    constructor(data?: Partial<IkasOrderAddress>);
+    get addressText(): string;
+    get validationResult(): IkasAddressValidationResult;
+    get isValid(): boolean;
+}
+declare type IkasOrderAddressLocation = {
+    id?: string;
+    name?: string;
+    code?: string;
+};
+export declare type IkasOrderAddressCountry = IkasOrderAddressLocation;
+export declare type IkasOrderAddressCity = IkasOrderAddressLocation;
+export declare type IkasOrderAddressDistrict = IkasOrderAddressLocation;
+export declare type IkasOrderAddressState = IkasOrderAddressLocation;
+export declare type IkasAddressValidationResult = {
+    firstName: boolean;
+    lastName: boolean;
+    addressLine1: boolean;
+    postalCode: boolean;
+    country: boolean;
+    state: boolean;
+    city: boolean;
+    phone: boolean;
+};
+export {};

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

@@ -0,0 +1,16 @@
+export declare type IkasOrderAdjustment = {
+    amount: number;
+    amountType: IkasAmountTypeEnum;
+    name: string;
+    order: number;
+    type: IkasAdjustmentEnum;
+};
+export declare enum IkasAmountTypeEnum {
+    AMOUNT = "AMOUNT",
+    RATIO = "RATIO"
+}
+declare enum IkasAdjustmentEnum {
+    DECREMENT = "DECREMENT",
+    INCREMENT = "INCREMENT"
+}
+export {};

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

@@ -0,0 +1,109 @@
+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;
+    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;
+    constructor(data: IkasOrder);
+    get unfullfilledOrderLineItems(): IkasOrderLineItem[];
+}
+export declare type IkasOrderAdjustment = {
+    amount: number;
+    amountType: IkasAmountTypeEnum;
+    name: string;
+    order: number;
+    type: IkasAdjustmentEnum;
+};
+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 {
+    UNFULFILLED = "UNFULFILLED",
+    PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED",
+    FULFILLED = "FULFILLED"
+}
+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 {};

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,19 @@
+import { IkasOrderLineDiscount } from "./discount/index";
+import { IkasOrderLineVariant } from "./variant/index";
+export declare class IkasOrderLineItem {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    deleted: boolean;
+    currencyCode: string;
+    discount?: IkasOrderLineDiscount;
+    discountPrice?: number;
+    finalPrice: number;
+    originalOrderLineItemId?: string;
+    price: number;
+    quantity: number;
+    taxValue?: number;
+    variant: IkasOrderLineVariant;
+    constructor(data: Partial<IkasOrderLineItem>);
+    get tax(): number;
+}

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;
+    slug?: string;
+    barcodeList: string[];
+    mainImageId?: string;
+    taxValue: number;
+    variantValues: IkasOrderLineVariantVariantValue[];
+    mainImage?: IkasImage;
+    constructor(data?: Partial<IkasOrderLineVariant>);
+    get href(): string;
+}
+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/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,72 @@
+export declare class 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: 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;
+};
+declare enum IkasPaymentMethodEnum {
+    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"
+}
+declare type IkasTransactionPaymentMethodDetail = {
+    bankName: string;
+    binNumber: string;
+    cardAssociation: IkasTransactionCardAssociationEnum;
+    cardFamily: string;
+    cardType: IkasTransactionCardTypeEnum;
+    installment: IkasTransactionInstallmentPrice;
+    lastFourDigits: string;
+    threeDSecure: boolean;
+};
+declare enum IkasTransactionCardAssociationEnum {
+    AMERICAN_EXPRESS = "AMERICAN_EXPRESS",
+    MASTER_CARD = "MASTER_CARD",
+    TROY = "TROY",
+    VISA = "VISA"
+}
+declare enum IkasTransactionCardTypeEnum {
+    CREDIT = "CREDIT",
+    DEBIT = "DEBIT",
+    PREPAID = "PREPAID"
+}
+declare type IkasTransactionInstallmentPrice = {
+    installmentCount: number;
+    installmentPrice: number;
+    totalPrice: number;
+};
+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,20 @@
+export declare type IkasPaymentGateway = {
+    paymentMethods: IkasPaymentMethod[];
+    paymentMethodType: IkasPaymentMethodType;
+    id: string | null;
+    name: string;
+    testMode: boolean | null;
+};
+export declare type IkasPaymentMethod = {
+    name: string;
+    logoUrl: string | null;
+};
+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"
+}

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

@@ -0,0 +1,6 @@
+export declare class IkasProductAttributeValue {
+    value: string | null;
+    productAttributeId: string;
+    productAttributeOptionId: string | null;
+    constructor(data: Partial<IkasProductAttributeValue>);
+}