@ikas/storefront 1.0.16-alpha.1 → 1.0.16-alpha.2

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

@@ -0,0 +1,67 @@
+import { IkasImage } from "../image/index";
+export declare class IkasBlog {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    categoryId: string | null;
+    category: IkasBlogCategory | null;
+    imageId: string | null;
+    title: string | null;
+    shortDescription: string | null;
+    isPublished: boolean;
+    storefrontId: string;
+    tagIds: string[] | null;
+    tags: IkasBlogTag[] | null;
+    writer: IkasBlogWriter;
+    blogContent: IkasBlogContent;
+    metadata: IkasBlogMetaData | null;
+    image: IkasImage | null;
+    constructor(data?: Partial<IkasBlog>);
+    get href(): string;
+}
+export declare class IkasBlogContent {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    content: string;
+    constructor(data?: Partial<IkasBlogContent>);
+}
+export declare class IkasBlogWriter {
+    firstName: string;
+    lastName: string;
+    constructor(data?: Partial<IkasBlogWriter>);
+}
+export declare enum IkasBlogMetadataTargetType {
+    BLOG = "BLOG",
+    BLOG_CATEGORY = "BLOG_CATEGORY"
+}
+export declare class IkasBlogMetaData {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    pageTitle: string | null;
+    description: string | null;
+    slug: string;
+    targetId: string;
+    targetType: IkasBlogMetadataTargetType;
+    constructor(data?: Partial<IkasBlogMetaData>);
+}
+export declare class IkasBlogCategory {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    deleted: boolean;
+    name: string;
+    imageId: string;
+    metadata: IkasBlogMetaData | null;
+    constructor(data?: Partial<IkasBlogCategory>);
+    get href(): string;
+}
+export declare class IkasBlogTag {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    deleted: boolean;
+    name: string | null;
+    constructor(data?: Partial<IkasBlogTag>);
+}

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

@@ -0,0 +1,21 @@
+import { IkasImage } from "../image/index";
+import { IkasHTMLMetaData } from "../html-meta-data/index";
+import { ModelOrder } from "../category/index";
+export declare class IkasBrand {
+    id: string;
+    name: string;
+    description: string | null;
+    metaData?: IkasHTMLMetaData | null;
+    image?: IkasImage | null;
+    orderType: ModelOrder | null;
+    translations: IkasProductBrandTranslation[] | null;
+    constructor(data?: Partial<IkasBrand>);
+    get href(): string;
+    private setTranslations;
+}
+declare type IkasProductBrandTranslation = {
+    description: string | null;
+    locale: string;
+    name: string | null;
+};
+export {};

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

@@ -0,0 +1,47 @@
+import { IkasOrderLineItem } from "../order/line-item/index";
+import { IkasProductCartLineOption } from "../product-cart-item-options/index";
+export declare class IkasCart {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    dueDate?: string | null;
+    currencyCode: string;
+    currencySymbol: string;
+    customerId?: string | null;
+    itemCount: number;
+    items: IkasOrderLineItem[];
+    merchantId: string;
+    totalPrice: number;
+    salesChannelId: string;
+    storefrontId: string | null;
+    storefrontRoutingId: string | null;
+    storefrontThemeId: string | null;
+    taxLines: IkasCartTaxLine[] | null;
+    constructor(data: Partial<IkasCart>);
+    get totalTax(): number;
+}
+declare type IkasCartLineItemInput = {
+    id: string | null;
+    quantity: number;
+    variant: IkasCartLineVariantInput;
+};
+declare type IkasCartLineVariantInput = {
+    id: string;
+    name: string;
+};
+declare type IkasCartTaxLine = {
+    price: number;
+    rate: number;
+};
+export declare type IkasSaveItemToCartInput = {
+    cartId: string | null;
+    customerId: string | null;
+    item: IkasCartLineItemInput;
+    priceListId: string | null;
+    salesChannelId: string;
+    storefrontId: string;
+    storefrontRoutingId: string;
+    options: IkasProductCartLineOption[] | null;
+    storefrontThemeId: string;
+};
+export {};

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

@@ -0,0 +1,52 @@
+import { IkasImage } from "../image/index";
+import { IkasHTMLMetaData } from "../html-meta-data/index";
+export declare class IkasCategory {
+    id: string;
+    name: string;
+    description: string | null;
+    parentId: string | null;
+    metaData?: IkasHTMLMetaData | null;
+    image?: IkasImage | null;
+    path: IkasCategoryPath[];
+    orderType: ModelOrder | null;
+    translations: IkasCategoryTranslation[] | null;
+    constructor(data?: Partial<IkasCategory>);
+    get href(): string;
+    private setTranslations;
+}
+export declare class IkasCategoryPath {
+    id: string;
+    name: string;
+    slug?: string | null;
+    constructor(data: Partial<IkasCategoryPath>);
+    get href(): string;
+}
+export declare class IkasFilterCategory {
+    id: string;
+    name: string;
+    slug?: string | null;
+    resultCount?: number | null;
+    private _isSelected;
+    constructor(data: Partial<IkasFilterCategory>);
+    get isSelected(): boolean;
+    get href(): string;
+    toJSON(): this & {
+        isSelected: boolean;
+    };
+}
+export declare enum ModelOrder {
+    BEST_SELLER = "BEST_SELLER",
+    HIGHEST_DISCOUNT_RATIO = "HIGHEST_DISCOUNT_RATIO",
+    HIGHEST_PRICE = "HIGHEST_PRICE",
+    LOWEST_DISCOUNT_RATIO = "LOWEST_DISCOUNT_RATIO",
+    LOWEST_PRICE = "LOWEST_PRICE",
+    MANUALLY = "MANUALLY",
+    NEWEST = "NEWEST",
+    OLDEST = "OLDEST"
+}
+declare type IkasCategoryTranslation = {
+    description: string | null;
+    locale: string;
+    name: string | null;
+};
+export {};

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

@@ -0,0 +1,103 @@
+import { IkasOrderAddress } from "../order/address/index";
+import { IkasOrderShippingLine } from "../order/shipping-line/index";
+import { IkasCart } from "../cart/index";
+import { IkasOrderAdjustment } from "../order/index";
+import { IkasPaymentGateway } from "../payment-gateway/index";
+import { IkasOrderGiftPackageLine } from "../order/gift-line/index";
+export declare class IkasCheckout {
+    id?: string | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+    cartId?: string | null;
+    cart?: IkasCart | null;
+    orderId?: string | null;
+    orderNumber?: string | null;
+    merchantId?: string | null;
+    shippingSettingsId?: string | null;
+    shippingZoneRateId?: string | null;
+    availableShippingMethods: IkasAvailableShippingMethod[];
+    customer?: IkasCheckoutCustomer | null;
+    billingAddress?: IkasOrderAddress | null;
+    shippingAddress?: IkasOrderAddress | null;
+    shippingLines?: IkasOrderShippingLine[] | null;
+    shippingMethod?: IkasShippingMethod | null;
+    status?: IkasCheckoutStatus | null;
+    couponCode?: string | null;
+    recoverEmailStatus?: IkasCheckoutRecoveryEmailStatus | null;
+    recoveryStatus?: IkasCheckoutRecoveryStatus | null;
+    totalFinalPrice?: number | null;
+    adjustments?: IkasOrderAdjustment[] | null;
+    note: string | null;
+    isGiftPackage: boolean;
+    giftPackageLines: IkasOrderGiftPackageLine[] | null;
+    giftPackageNote: string | null;
+    appliedCouponCode?: string | null;
+    selectedPaymentGateway?: IkasPaymentGateway | null;
+    constructor(data?: Partial<IkasCheckout>);
+    get isComplete(): boolean;
+    get totalTax(): number;
+    get shippingTotal(): number;
+    get hasCustomer(): boolean;
+    get hasValidCustomer(): boolean;
+    get customerFullName(): string;
+    get customerEmail(): string;
+    get dateStr(): string;
+    get $totalFinalPrice(): number;
+    get couponAdjustment(): IkasOrderAdjustment | undefined;
+    get nonCouponAdjustments(): IkasOrderAdjustment[] | undefined;
+}
+export declare class IkasCheckoutCustomer {
+    id?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    notificationsAccepted?: boolean | null;
+    constructor(data: Partial<IkasCheckoutCustomer>);
+}
+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/checkout-settings/index.d.ts

@@ -0,0 +1,25 @@
+export declare class IkasCheckoutSettings {
+    id: string;
+    createdAt: number;
+    updatedAt: number;
+    phoneRequirement: IkasCheckoutRequirementEnum | null;
+    postalCodeRequirement: IkasCheckoutRequirementEnum | null;
+    identityNumberRequirement: IkasCheckoutRequirementEnum | null;
+    isAccountRequired: boolean;
+    isTermsAndConditionsDefaultChecked: boolean;
+    showTermsAndConditionsCheckbox: boolean;
+    showCheckoutNote: boolean;
+    storefrontId: string;
+    giftPackagePriceList: IkasCheckoutSettingsPrice[] | null;
+    isGiftPackageEnabled: boolean;
+    constructor(data?: Partial<IkasCheckoutSettings>);
+}
+export declare enum IkasCheckoutRequirementEnum {
+    INVISIBLE = "INVISIBLE",
+    MANDATORY = "MANDATORY",
+    OPTIONAL = "OPTIONAL"
+}
+export declare type IkasCheckoutSettingsPrice = {
+    currencyCode: string;
+    price: number;
+};

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

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

package/build/models/data/contact-form/index.d.ts

@@ -0,0 +1,7 @@
+export declare class IkasContactForm {
+    email: string;
+    firstName: string;
+    lastName: string;
+    message: string;
+    constructor(data: Partial<IkasContactForm>);
+}

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

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

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

@@ -0,0 +1,52 @@
+import { IkasCheckoutSettings } from "../../checkout-settings/index";
+export declare class IkasCustomerAddress {
+    id?: string | null;
+    title?: string | null;
+    addressLine1?: string | null;
+    addressLine2?: string | null;
+    country?: IkasCustomerAddressCountry | null;
+    state?: IkasCustomerAddressState | null;
+    city?: IkasCustomerAddressCity | null;
+    district?: IkasCustomerAddressDistrict | null;
+    isDefault?: boolean | null;
+    company?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    phone?: string | null;
+    postalCode?: string | null;
+    identityNumber?: string | null;
+    taxNumber?: string | null;
+    taxOffice?: string | null;
+    checkoutSettings?: IkasCheckoutSettings | null;
+    isDistrictRequired?: boolean;
+    constructor(data?: Partial<IkasCustomerAddress>);
+    get addressText(): string;
+    get validationResult(): IkasAddressValidationResult;
+    get isValid(): boolean;
+    toJSON(): this;
+}
+declare type IkasCustomerAddressLocation = {
+    id?: string;
+    name?: string;
+    code?: string;
+    iso2?: string;
+    iso3?: 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;
+    country: boolean;
+    state: boolean;
+    city: boolean;
+    district: boolean;
+    phone: boolean;
+    postalCode: boolean;
+    identityNumber: boolean;
+    title: boolean;
+};
+export {};

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

@@ -0,0 +1,33 @@
+import { IkasCustomerAddress } from "./address/index";
+export declare class IkasCustomer {
+    id: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone?: string | null;
+    isEmailVerified: boolean;
+    isPhoneVerified: boolean;
+    accountStatus: IkasCustomerAccountStatus;
+    addresses: IkasCustomerAddress[];
+    subscriptionStatus: IkasCustomerEmailSubscriptionStatus | null;
+    constructor(data: Partial<IkasCustomer>);
+    get isSubscribed(): boolean;
+    get basicInfo(): {
+        id: string;
+        firstName: string;
+        lastName: string;
+        email: string;
+        phone: string | null | undefined;
+    };
+}
+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"
+}
+export declare enum IkasCustomerEmailSubscriptionStatus {
+    NOT_SUBSCRIBED = "NOT_SUBSCRIBED",
+    PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
+    SUBSCRIBED = "SUBSCRIBED"
+}

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

@@ -0,0 +1,23 @@
+export declare class IkasCustomerReview {
+    comment: string;
+    createdAt: string;
+    customerId: string;
+    deleted: boolean;
+    id: string;
+    orderId: string;
+    orderNumber: string;
+    productId: string;
+    salesChannelId: string;
+    star: number;
+    status: CustomerReviewStatusEnum;
+    storefrontId: string;
+    title: string;
+    updatedAt: string;
+    constructor(data: Partial<IkasCustomerReview>);
+}
+declare enum CustomerReviewStatusEnum {
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    WAITING = "WAITING"
+}
+export {};

package/build/models/data/customer-review-settings/index.d.ts

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

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

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

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

@@ -0,0 +1,6 @@
+export declare class IkasFavoriteProduct {
+    id: string;
+    customerId: string;
+    productId: string;
+    constructor(data: Partial<IkasFavoriteProduct>);
+}

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

@@ -0,0 +1,23 @@
+export declare class IkasHTMLMetaData {
+    slug: string;
+    pageTitle: string | null;
+    description: string | null;
+    targetType: IkasHTMLMetaDataTargetType | null;
+    targetId: string | null;
+    redirectTo?: string | null;
+    translations?: IkasHTMLMetaDataTranslations[] | null;
+    constructor(data?: Partial<IkasHTMLMetaData>);
+    private setTranslations;
+}
+export declare enum IkasHTMLMetaDataTargetType {
+    PRODUCT = "PRODUCT",
+    CATEGORY = "CATEGORY",
+    BRAND = "BRAND",
+    PAGE = "PAGE"
+}
+declare type IkasHTMLMetaDataTranslations = {
+    description: string | null;
+    locale: string;
+    pageTitle: string | null;
+};
+export {};

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

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

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

@@ -0,0 +1,33 @@
+export * from "./blog/index";
+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 { IkasCustomerReview } from "./customer-review/index";
+export type { IkasCustomerReviewSettings } from "./customer-review-settings/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 { IkasOrderRefundSettings } from "./order/refund/settings";
+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, IkasProductAttributeType, } from "./product-attribute/index";
+export { IkasProductAttributeValue, IkasAttributeTableCellValue, IkasProductAttributeMap, } from "./product/attribute-value/index";
+export * from "./product-filter/index";
+export { IkasFavoriteProduct } from "./favorite-product/index";
+export { IkasContactForm } from "./contact-form/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";
+export * from "./product-option-set/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,51 @@
+import { IkasCheckoutSettings } from "../../checkout-settings/index";
+export declare class IkasOrderAddress {
+    id?: string | null;
+    title?: string | null;
+    addressLine1?: string | null;
+    addressLine2?: string | null;
+    country?: IkasOrderAddressCountry | null;
+    state?: IkasOrderAddressState | null;
+    city?: IkasOrderAddressCity | null;
+    district?: IkasOrderAddressDistrict | null;
+    isDefault?: boolean | null;
+    company?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    phone?: string | null;
+    postalCode?: string | null;
+    identityNumber?: string | null;
+    taxNumber?: string | null;
+    taxOffice?: string | null;
+    checkoutSettings?: IkasCheckoutSettings | null;
+    isDistrictRequired?: boolean;
+    constructor(data?: Partial<IkasOrderAddress>);
+    get addressText(): string;
+    get validationResult(): IkasAddressValidationResult;
+    get isValid(): boolean;
+    toJSON(): this;
+}
+declare type IkasOrderAddressLocation = {
+    id?: string;
+    name?: string;
+    code?: string;
+    iso2?: string;
+    iso3?: 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;
+    country: boolean;
+    state: boolean;
+    city: boolean;
+    district: boolean;
+    phone: boolean;
+    postalCode: boolean;
+    identityNumber: 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/gift-line/index.d.ts

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