types-magic-api 0.1.25 → 0.1.26

package/dist/src/services/customer/customer.model.d.ts

@@ -0,0 +1,342 @@
+import * as Model from "../../index.model.js";
+/**
+ * API Name : /api/customer/qr/token/get
+ */
+export interface GetTokenFromQRReq {
+    uuid: string;
+}
+export interface GetTokenFromQRRes {
+    authorization: string;
+}
+export interface AddWishListReq {
+    productId: string;
+}
+export interface AddWishListRes {
+    isSaved: boolean;
+}
+export interface RemoveWishListReq {
+    productId: string;
+}
+export interface RemoveWishListRes {
+    isRemoved: boolean;
+}
+export interface AddProductViewReq {
+    productIds: string[];
+}
+export interface AddProductViewRes {
+    isAdded: boolean;
+}
+export interface GetShippingZoneRes {
+    shippingZones: Model.ShopifyShippingZoneRes[];
+}
+export interface CustomerCheckoutDeliveryAddress {
+    address1: string | null;
+    address2: string | null;
+    city: string | null;
+    company: string | null;
+    country: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    phone: string | null;
+    province: string | null;
+    zip: string | null;
+}
+/**
+ * API Name: /api/customer/checkout/create
+ */
+export interface CreateCustomerCheckoutReq {
+    discountAmount: string | null;
+    discountCode: string | null;
+    shippingMethodName: string | null;
+    isByCart: boolean;
+    deliveryAddress: CustomerCheckoutDeliveryAddress;
+    variantId: string | null;
+    qty: number | null;
+    token: string | null;
+    note: string | null;
+}
+/**
+ * API Name: /api/customer/checkout/create
+ */
+export interface CreateCustomerCheckoutRes {
+    checkout: Model.ShopifyCheckoutRes;
+}
+export interface ReorderReq {
+    orderId: string;
+}
+export type ReorderRes = CreateCartRes;
+/**
+ * API Name: /api/customer/wishlist/product/get
+ */
+export interface GetWishListProductsReq {
+    count: number;
+    page: number;
+}
+/**
+ * API Name: /api/customer/wishlist/product/get
+ */
+export interface GetWishListProductsRes extends Model.GetAllCustomerProductsByIdsRes {
+    count: number;
+    page: number;
+    totalCount: number;
+    totalPage: number;
+}
+/**
+ * API Name: /api/customer/setting/save
+ */
+export interface SaveCustomerSettingReq {
+    language: string;
+}
+/**
+ * API Name: /api/customer/setting/save
+ */
+export interface SaveCustomerSettingRes {
+    isSaved: boolean;
+}
+/**
+ * API Name: /api/customer/setting/get
+ */
+export interface GetCustomerSettingRes {
+    setting: Model.Customer;
+}
+export interface MailingAddressInput {
+    address1: string | null;
+    address2: string | null;
+    city: string | null;
+    company: string | null;
+    country: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    phone: string | null;
+    province?: string | null;
+    zip: string | null;
+}
+/**
+ * API Name: /api/customer/address/create
+ */
+export type CreateCustomerAddressReq = MailingAddressInput;
+/**
+ * API Name: /api/customer/address/create
+ */
+export interface CreateCustomerAddressRes {
+    isCreated: boolean;
+    address: Model.MailingAddress;
+}
+/**
+ * API Name: /api/customer/address/delete
+ */
+export interface DeleteCustomerAddressReq {
+    id: string;
+}
+/**
+ * API Name: /api/customer/address/delete
+ */
+export interface DeleteCustomerAddressRes {
+    isDeleted: boolean;
+}
+/**
+ * API Name: /api/customer/address/update
+ */
+export interface UpdateCustomerAddressReq extends CreateCustomerAddressReq {
+    id: string;
+}
+/**
+ * API Name: /api/customer/address/update
+ */
+export interface UpdateCustomerAddressRes {
+    isUpdated: boolean;
+    address: Model.MailingAddress;
+}
+/**
+ * API Name: /api/customer/address/default/update
+ */
+export interface UpdateCustomerDefaultAddressReq {
+    addressId: string;
+}
+/**
+ * API Name: /api/customer/address/default/update
+ */
+export interface UpdateCustomerDefaultAddressRes {
+    isUpdated: boolean;
+    id: string;
+}
+/**
+ * API Name: /api/customer/create
+ */
+export interface CustomerCreateReq {
+    acceptsMarketing: boolean;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    password: string;
+    phone?: string;
+    language: string;
+}
+/**
+ * API Name: /api/customer/create
+ */
+export interface CustomerCreateRes {
+    customer: Model.ICustomer;
+}
+/**
+ * API Name: /api/customer/cart/address
+ */
+export interface addCartDeliveryAddressReq {
+    cartId: string;
+    addresses: Array<{
+        selected: boolean;
+        address: {
+            deliveryAddress: {
+                address1: string;
+                address2?: string;
+                city: string;
+                company?: string;
+                firstName?: string;
+                lastName?: string;
+                phone?: string;
+                provinceCode: string;
+                zip: string;
+                countryCode: string;
+            };
+        };
+    }>;
+}
+/**
+ * API Name: /api/customer/get
+ */
+export interface GetCustomerReq {
+    count: number;
+    cursor: string | null;
+    isNextPage: boolean;
+    isPrevPage: boolean;
+}
+/**
+ * API Name: /api/customer/order/get
+ */
+export interface GetCustomerOrderRes {
+    orders: Model.CustomerOrder[];
+}
+/**
+ * API Name: /api/customer/get
+ */
+export interface GetCustomerRes {
+    customer: Model.ICustomer;
+    pageInfo?: Model.StoreFrontPageInfo;
+}
+/**
+ * API Name: /api/customer/update
+ */
+export type CustomerUpdateReq = Omit<CustomerCreateReq, 'password' | 'language'>;
+/**
+ * API Name: /api/customer/update
+ */
+export interface CustomerUpdateRes {
+    isUpdated: boolean;
+    token: string | null;
+}
+export interface ShopifyCartInfoReq {
+    count: number;
+    reverse: boolean;
+    cursor: string | null;
+    isNextPage: boolean;
+    isPrevPage: boolean;
+}
+export interface GetCartReq {
+    pageInfo: ShopifyCartInfoReq;
+}
+export interface GetCartRes {
+    cart: Model.ICart | null;
+}
+export interface CreateCartReq {
+    lines: Model.CartLineInput[];
+    note: string | null;
+    discountCodes: string[];
+}
+export interface CreateCartRes {
+    id: string;
+}
+/**
+ * API Name: /api/customer/product/get
+ */
+export interface GetCustomerProductByIdReq {
+    id: string;
+}
+/**
+ * API Name: /api/customer/product/get
+ */
+export interface GetCustomerProductByIdRes {
+    product: Model.ICustomerProduct;
+}
+/**
+ * API Name: /api/customer/product/get/all
+ */
+export interface GetCustomerAllProductsReq {
+    count: number;
+    reverse: boolean;
+    sortKey: Model.ProductSortKeys | null;
+    searchKey: string | null;
+    cursor: string | null;
+    isNextPage: boolean;
+    isPrevPage: boolean;
+    filter: {
+        tag: string | null;
+        lowPrice: string | number | null;
+        highPrice: string | number | null;
+        productType: string | null;
+        vendor: string | null;
+        availableForSale: boolean | null;
+    };
+}
+/**
+ * API Name: /api/customer/product/get/all
+ */
+export interface GetCustomerAllProductsRes {
+    products: Model.ICustomerProductX[];
+    pageInfo: Model.StoreFrontPageInfo | undefined;
+}
+/**
+ * API Name: /api/customer/product/recommendations/get
+ */
+export interface GetProductRecommendationsReq {
+    productId: string;
+    recommendationIntent: Model.ProductRecommendationIntent;
+}
+/**
+ * API Name: /api/customer/product/recommendations/get
+ */
+export interface GetProductRecommendationsRes {
+    productRecommendations: Model.ICustomerProductX[];
+}
+/**
+ * API Name: /api/customer/collection/get
+ */
+export interface GetCustomerCollectionByIdReq extends Omit<GetCustomerAllProductsReq, 'sortKey' | 'searchKey'> {
+    id: string;
+    sortKey: Model.ProductCollectionSortKeys | null;
+}
+/**
+ * API Name: /api/customer/collection/get
+ */
+export interface GetCustomerCollectionByIdRes {
+    collection: Model.ICustomerCollection;
+    pageInfo: Model.StoreFrontPageInfo | undefined;
+}
+/**
+ * API Name: /api/customer/collection/get/all
+ */
+export interface GetCustomerAllCollectionsReq {
+    count: number;
+    reverse: boolean;
+    sortKey: Model.CollectionSortKeys | null;
+    searchKey: string | null;
+    cursor: string | null;
+    isNextPage: boolean;
+    isPrevPage: boolean;
+}
+/**
+ * API Name: /api/customer/collection/get/all
+ */
+export interface GetCustomerAllCollectionsRes {
+    collections: Model.ICollection[];
+    pageInfo: Model.StoreFrontPageInfo | undefined;
+}

package/dist/src/services/customer/customer.model.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=customer.model.js.map

package/dist/src/services/default/default.model.d.ts

@@ -0,0 +1,134 @@
+import { Language } from "../../index.model.js";
+export declare enum ComponentTypes {
+    CAROUSEL = "CAROUSEL",
+    CIRCLE = "CIRCLE",
+    COUNTDOWN_TIMER = "COUNTDOWN_TIMER",
+    DISCOUNT = "DISCOUNT",
+    DIVIDER = "DIVIDER",
+    GALLERY = "GALLERY",
+    GRID = "GRID",
+    IMAGE = "IMAGE",
+    RECENTLY_VIEWED = "RECENTLY_VIEWED",
+    SEARCH_BAR = "SEARCH_BAR",
+    SLIDER = "SLIDER",
+    SLIDESHOW = "SLIDESHOW",
+    TITLE = "TITLE",
+    VIDEO_PLAYER = "VIDEO_PLAYER"
+}
+export declare enum EComponentProperty {
+    ADD_TO_CART = "addToCart",
+    AUTO_PLAY = "autoPlay",
+    ACTION_TEXT = "actionText",
+    BAR_TYPE = "barType",
+    CLICKABLE = "clickable",
+    CONTENT_TYPE = "contentType",
+    CONTROL_BAR = "controlBar",
+    CUSTOMER_DISCOUNT_CODE = "customerDiscountCode",
+    DISCOUNT_CODE = "discountCode",
+    DISCOUNT_IMAGE = "discountImage",
+    DISPLAY_TYPE = "displayType",
+    DIVIDER_TYPE = "dividerType",
+    HAS_ACTION_TEXT = "hasActionText",
+    HAS_ITEM_MARGIN = "hasItemMargin",
+    HAS_MARGIN = "hasMargin",
+    HIDE_BORDER = "hideBorder",
+    HIDE_WHEN_FINISH = "hideWhenFinish",
+    LINK_TO = "linkTo",
+    IS_NEED_LINK = "isNeedLink",
+    LOOP = "loop",
+    MUTE_BTN = "muteBtn",
+    PLACEHOLDER = "placeholder",
+    PROMOTION_IMAGE = "promotionImage",
+    RESTART_BTN = "restartBtn",
+    SHOW_ITEM_TITLE = "showItemTitle",
+    SHOW_PRICE = "showPrice",
+    SHOW_TITLE = "showTitle",
+    THUMBNAIL_IMAGE = "thumbnailImage",
+    TIMER_EXPIRE_DATE = "timerExpireDate",
+    TIMER_NUMBER_COLOR = "timerNumberColor",
+    TIMER_TIMEZONE = "timerTimezone",
+    TITLE = "title",
+    TITLE_ALIGNMENT = "titleAlignment",
+    TITLE_POSITION = "titlePosition",
+    VIDEO_DISPLAY_TYPE = "videoDisplayType",
+    VIDEO_UPLOAD = "videoUpload",
+    VIEW_SIZE = "viewSize"
+}
+export type DefaultComponents = {
+    [key in ComponentTypes]: string[];
+};
+export interface IComponentGroup {
+    id: string;
+    name: string;
+    components: DefaultComponents;
+}
+/**
+ * API Name: /api/default/component/get/all
+ */
+export interface GetAllComponentRes {
+    componentGroups: IComponentGroup[];
+}
+export declare enum MenuTypes {
+    SHOWCASE = "SHOWCASE",
+    MY_ORDERS = "MY_ORDERS",
+    NOTIFICATION = "NOTIFICATION",
+    SEARCH = "SEARCH",
+    MY_ACCOUNT = "MY_ACCOUNT",
+    WEB_URL = "WEB_URL",
+    CART = "CART",
+    HOME_PAGE = "HOME_PAGE",
+    ALL_PRODUCT = "ALL_PRODUCT",
+    RECENTLY_VIEWED = "RECENTLY_VIEWED",
+    FAVORITES = "FAVORITES",
+    GROUP = "GROUP",
+    CONTACT = "CONTACT",
+    MOBILE_APP_PRIVACY_POLICY = "MOBILE_APP_PRIVACY_POLICY",
+    STYLE = "STYLE",
+    COLOR = "COLOR",
+    PAGE = "PAGE",
+    COLLECTION = "COLLECTION"
+}
+export declare enum EMenuProperty {
+    NAME = "name",
+    TITLE_ALIGN_TYPE = "titleAlignType",
+    ICON_TYPE = "iconType",
+    URL = "url",
+    LEFT_PANEL = "leftPanel",
+    BOTTOM_BAR = "bottomBar",
+    TEXT_COLOR = "textColor"
+}
+export type DefaultMenus = {
+    [key in MenuTypes]: string[];
+};
+export interface DefaultMenusCollection {
+    id: string;
+    title?: string;
+}
+export interface DefaultMenusPage {
+    id: string | number;
+    title: string | null;
+    html: string | null;
+    url: string;
+}
+export interface DefaultMenusField {
+    COLLECTION: DefaultMenusCollection[];
+    PAGE: DefaultMenusPage[];
+}
+export interface IMenuGroup {
+    id: string;
+    name: string;
+    menus: DefaultMenus;
+    fields?: DefaultMenusField;
+}
+/**
+ * API Name: /api/default/menu/get/all
+ */
+export interface GetAllMenuRes {
+    menuGroups: IMenuGroup[];
+}
+/**
+ * API Name: /api/app/language/get
+ */
+export interface GetAppLanguagesRes {
+    languages: Language[];
+}

package/dist/src/services/default/default.model.js

@@ -0,0 +1,89 @@
+export var ComponentTypes;
+(function (ComponentTypes) {
+    ComponentTypes["CAROUSEL"] = "CAROUSEL";
+    ComponentTypes["CIRCLE"] = "CIRCLE";
+    ComponentTypes["COUNTDOWN_TIMER"] = "COUNTDOWN_TIMER";
+    ComponentTypes["DISCOUNT"] = "DISCOUNT";
+    ComponentTypes["DIVIDER"] = "DIVIDER";
+    ComponentTypes["GALLERY"] = "GALLERY";
+    ComponentTypes["GRID"] = "GRID";
+    ComponentTypes["IMAGE"] = "IMAGE";
+    ComponentTypes["RECENTLY_VIEWED"] = "RECENTLY_VIEWED";
+    ComponentTypes["SEARCH_BAR"] = "SEARCH_BAR";
+    ComponentTypes["SLIDER"] = "SLIDER";
+    ComponentTypes["SLIDESHOW"] = "SLIDESHOW";
+    ComponentTypes["TITLE"] = "TITLE";
+    ComponentTypes["VIDEO_PLAYER"] = "VIDEO_PLAYER";
+})(ComponentTypes || (ComponentTypes = {}));
+export var EComponentProperty;
+(function (EComponentProperty) {
+    EComponentProperty["ADD_TO_CART"] = "addToCart";
+    EComponentProperty["AUTO_PLAY"] = "autoPlay";
+    EComponentProperty["ACTION_TEXT"] = "actionText";
+    EComponentProperty["BAR_TYPE"] = "barType";
+    EComponentProperty["CLICKABLE"] = "clickable";
+    EComponentProperty["CONTENT_TYPE"] = "contentType";
+    EComponentProperty["CONTROL_BAR"] = "controlBar";
+    EComponentProperty["CUSTOMER_DISCOUNT_CODE"] = "customerDiscountCode";
+    EComponentProperty["DISCOUNT_CODE"] = "discountCode";
+    EComponentProperty["DISCOUNT_IMAGE"] = "discountImage";
+    EComponentProperty["DISPLAY_TYPE"] = "displayType";
+    EComponentProperty["DIVIDER_TYPE"] = "dividerType";
+    EComponentProperty["HAS_ACTION_TEXT"] = "hasActionText";
+    EComponentProperty["HAS_ITEM_MARGIN"] = "hasItemMargin";
+    EComponentProperty["HAS_MARGIN"] = "hasMargin";
+    EComponentProperty["HIDE_BORDER"] = "hideBorder";
+    EComponentProperty["HIDE_WHEN_FINISH"] = "hideWhenFinish";
+    EComponentProperty["LINK_TO"] = "linkTo";
+    EComponentProperty["IS_NEED_LINK"] = "isNeedLink";
+    EComponentProperty["LOOP"] = "loop";
+    EComponentProperty["MUTE_BTN"] = "muteBtn";
+    EComponentProperty["PLACEHOLDER"] = "placeholder";
+    EComponentProperty["PROMOTION_IMAGE"] = "promotionImage";
+    EComponentProperty["RESTART_BTN"] = "restartBtn";
+    EComponentProperty["SHOW_ITEM_TITLE"] = "showItemTitle";
+    EComponentProperty["SHOW_PRICE"] = "showPrice";
+    EComponentProperty["SHOW_TITLE"] = "showTitle";
+    EComponentProperty["THUMBNAIL_IMAGE"] = "thumbnailImage";
+    EComponentProperty["TIMER_EXPIRE_DATE"] = "timerExpireDate";
+    EComponentProperty["TIMER_NUMBER_COLOR"] = "timerNumberColor";
+    EComponentProperty["TIMER_TIMEZONE"] = "timerTimezone";
+    EComponentProperty["TITLE"] = "title";
+    EComponentProperty["TITLE_ALIGNMENT"] = "titleAlignment";
+    EComponentProperty["TITLE_POSITION"] = "titlePosition";
+    EComponentProperty["VIDEO_DISPLAY_TYPE"] = "videoDisplayType";
+    EComponentProperty["VIDEO_UPLOAD"] = "videoUpload";
+    EComponentProperty["VIEW_SIZE"] = "viewSize";
+})(EComponentProperty || (EComponentProperty = {}));
+export var MenuTypes;
+(function (MenuTypes) {
+    MenuTypes["SHOWCASE"] = "SHOWCASE";
+    MenuTypes["MY_ORDERS"] = "MY_ORDERS";
+    MenuTypes["NOTIFICATION"] = "NOTIFICATION";
+    MenuTypes["SEARCH"] = "SEARCH";
+    MenuTypes["MY_ACCOUNT"] = "MY_ACCOUNT";
+    MenuTypes["WEB_URL"] = "WEB_URL";
+    MenuTypes["CART"] = "CART";
+    MenuTypes["HOME_PAGE"] = "HOME_PAGE";
+    MenuTypes["ALL_PRODUCT"] = "ALL_PRODUCT";
+    MenuTypes["RECENTLY_VIEWED"] = "RECENTLY_VIEWED";
+    MenuTypes["FAVORITES"] = "FAVORITES";
+    MenuTypes["GROUP"] = "GROUP";
+    MenuTypes["CONTACT"] = "CONTACT";
+    MenuTypes["MOBILE_APP_PRIVACY_POLICY"] = "MOBILE_APP_PRIVACY_POLICY";
+    MenuTypes["STYLE"] = "STYLE";
+    MenuTypes["COLOR"] = "COLOR";
+    MenuTypes["PAGE"] = "PAGE";
+    MenuTypes["COLLECTION"] = "COLLECTION";
+})(MenuTypes || (MenuTypes = {}));
+export var EMenuProperty;
+(function (EMenuProperty) {
+    EMenuProperty["NAME"] = "name";
+    EMenuProperty["TITLE_ALIGN_TYPE"] = "titleAlignType";
+    EMenuProperty["ICON_TYPE"] = "iconType";
+    EMenuProperty["URL"] = "url";
+    EMenuProperty["LEFT_PANEL"] = "leftPanel";
+    EMenuProperty["BOTTOM_BAR"] = "bottomBar";
+    EMenuProperty["TEXT_COLOR"] = "textColor";
+})(EMenuProperty || (EMenuProperty = {}));
+//# sourceMappingURL=default.model.js.map

package/dist/src/services/file/file.model.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/services/file/file.model.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=file.model.js.map

package/dist/src/services/maintainer/maintainer.model.d.ts

@@ -0,0 +1,71 @@
+import * as Model from "../../index.model.js";
+/**
+ * API Name: /api/maintainer/login
+ */
+export type MaintainerLoginRes = Model.LoginRes;
+/**
+ * API Name: /api/maintainer/login
+ */
+export type MaintainerLoginReq = Model.LoginReq;
+/**
+ * API Name: /api/maintainer/app/get/all
+ */
+export interface MaintainerGetAppsRes {
+    apps: Model.Organization[];
+}
+/**
+ * API Name: /api/maintainer/app/subscriber/get/all
+ */
+export interface MaintainerAppSubscribeReq {
+    orgId: string;
+    searchKey: string | null;
+    pageNo: number;
+    count: number;
+}
+/**
+ * API Name: /api/maintainer/app/subscriber/get/all
+ */
+export interface MaintainerAppSubscribeRes {
+    users: Model.UserProfile[];
+    count: number;
+    pageNo: number;
+    totalCount: number;
+    totalPage: number;
+}
+/**
+ * API Name: /api/maintainer/app/subscriber/store/get/all
+ */
+export interface AppSubscriberStoreReq {
+    subscriberId: string;
+    orgId: string;
+}
+/**
+ * API Name: /api/maintainer/app/subscriber/store/get/all
+ */
+export interface AppSubscriberStoreRes {
+    store: Model.App[];
+}
+/**
+ * API Name: /api/maintainer/store/build/get/all
+ */
+export interface AppSubscriberStoreBuildDetailReq {
+    orgId: string;
+    subscriberId: string;
+    appId: string;
+}
+/**
+ * API Name: /api/maintainer/store/build/get/all
+ */
+export interface AppSubscriberStoreBuildDetailRes {
+    storeBuilds: Model.AppBuild[];
+}
+/**
+ * API Name: /api/maintainer/app/build/status/change
+ */
+export interface AppBuildStatusChangeReq {
+    id: number;
+    status: number;
+}
+export interface AppBuildStatusChangeRes {
+    isUpdated: boolean;
+}

package/dist/src/services/maintainer/maintainer.model.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=maintainer.model.js.map

package/dist/src/services/menu/menu.model.d.ts

@@ -0,0 +1,56 @@
+import { AppMenu, AppMenuSettings } from "../../index.model.js";
+import { MenuTypes } from "../default/default.model.js";
+/**
+ * API Name: /api/app/menu/save
+ */
+export interface SaveMenuReq {
+    menus: IAppMenu[];
+    settings: IAppMenuSetting;
+}
+/**
+ * API Name: /api/app/menu/save
+ */
+export interface SaveMenuRes {
+    isSaved: boolean;
+}
+/**
+ * API Name: /api/app/menu/get
+ */
+export interface GetMenusRes {
+    menus: AppMenu[];
+    settings: AppMenuSettings | null;
+}
+export interface IAppMenu {
+    id: string | null;
+    menuType: MenuTypes;
+    displayOrder: number;
+    icon?: string;
+    name?: string;
+    url?: string;
+}
+export interface IAppMenuSetting {
+    menuStyle: number;
+    iconType: string;
+    titleAlignType: string;
+    textColor: string;
+}
+export declare enum MenuStye {
+    LEFT_PANEL = 1,
+    BOTTOM_BAR = 2
+}
+export declare enum IconType {
+    LEFT = "LEFT",
+    EMPTY = "EMPTY",
+    RIGHT = "RIGHT"
+}
+export declare enum TitleAlignType {
+    CENTER = "CENTER",
+    LEFT = "LEFT",
+    RIGHT = "RIGHT"
+}
+export interface DeleteAppMenuReq {
+    ids: string[];
+}
+export interface DeleteAppMenuRes {
+    isDeleted: boolean;
+}