types-magic-api 0.1.25 → 0.1.27

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;
+}

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

@@ -0,0 +1,18 @@
+export var MenuStye;
+(function (MenuStye) {
+    MenuStye[MenuStye["LEFT_PANEL"] = 1] = "LEFT_PANEL";
+    MenuStye[MenuStye["BOTTOM_BAR"] = 2] = "BOTTOM_BAR";
+})(MenuStye || (MenuStye = {}));
+export var IconType;
+(function (IconType) {
+    IconType["LEFT"] = "LEFT";
+    IconType["EMPTY"] = "EMPTY";
+    IconType["RIGHT"] = "RIGHT";
+})(IconType || (IconType = {}));
+export var TitleAlignType;
+(function (TitleAlignType) {
+    TitleAlignType["CENTER"] = "CENTER";
+    TitleAlignType["LEFT"] = "LEFT";
+    TitleAlignType["RIGHT"] = "RIGHT";
+})(TitleAlignType || (TitleAlignType = {}));
+//# sourceMappingURL=menu.model.js.map

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

@@ -0,0 +1,280 @@
+import { Reminder } from "../../index.model.js";
+export interface NotificationDetails {
+    deviceToken: string[] | null;
+    emailId: string | null;
+    mobileNumber: string | null;
+    userId: string;
+    orgId: string;
+    userName: string;
+    otherDetail?: object;
+    color?: string;
+    emailUnsubscribeLink?: string;
+    productImageUrl?: string;
+    appName?: string;
+}
+export interface TemplateContent {
+    push: {
+        body: string;
+        subject: string;
+        image: string;
+    };
+    email: {
+        body: string;
+        subject: string;
+    };
+    sms: {
+        message: string;
+    };
+}
+export interface UserAppNotificationType {
+    title: string;
+    body: string;
+    deviceToken: string[];
+    image?: string;
+    color?: string;
+}
+export interface UserEmailNotificationType {
+    sub: string;
+    body: string;
+    emailId: string[];
+}
+export interface UserMobileNotificationType {
+    message: string;
+    mobileNo: string;
+}
+export interface EmailSettings {
+    auth: {
+        pass: string;
+        user: string;
+        encryption: string;
+    };
+    from: string;
+    host: string;
+    port: number;
+    fromName: string;
+}
+export declare enum NotificationType {
+    OTPEmail = 1,
+    PasswordChanged = 2,
+    ForgetPassword = 3,
+    NewPostAdmin = 4,
+    UpdatePostToAdmin = 5,
+    UpdatePostToUser = 6,
+    AdminStatusChanged = 7,
+    AccountDeleted = 8,
+    NeedSupport = 9,
+    StockUpdate = 10,
+    buildSuccess = 11,
+    buildProcessPending = 12,
+    PublishPending = 13,
+    DealMail = 14,
+    OptionAppoinmentMail = 15,
+    RegistrationEmail = 16,
+    NoWorkStart = 17,
+    OptionRestPassword = 18,
+    ConfirmEmail = 19,
+    OtptionSurveyEmail = 20,
+    BuildFailure = 21,
+    NoActiveTime = 22,
+    OptionForgetPassword = 23,
+    BuildStart = 24,
+    IosBuildStart = 25,
+    IosBuildStartRequest = 26,
+    NoActivity = 27,
+    AppPublish = 28,
+    AppReleaseSuccess = 29,
+    IosAppReleaseSuccess = 30,
+    AppReleaseRequest = 31
+}
+export declare enum NotificationTemplate {
+    OTPEmail = "otp_email",
+    PasswordChanged = "password_changed",
+    ForgetPassword = "forget_password",
+    NewPostAdmin = "new_post_admin",
+    UpdatePostToAdmin = "update_post_to_admin",
+    UpdatePostToUser = "update_post_to_user",
+    AdminStatusChanged = "admin_status_changed",
+    AccountDeleted = "account_deleted",
+    NeedSupport = "need_support",
+    StockUpdate = "stock_update",
+    buildSuccess = "build_success",
+    buildProcessPending = "build_process_pending",
+    PublishPending = "publish_pending",
+    DealMail = "deal_mail",
+    OptionAppoinmentMail = "option_appoinment_schedule",
+    RegistrationEmail = "registeration_email",
+    NoWorkStart = "no_work_started",
+    OptionRestPassword = "option_reset_password",
+    ConfirmEmail = "confirmation_email",
+    OtptionSurveyEmail = "option_survey_email",
+    BuildFailure = "build_failure",
+    NoActiveTime = "no_activity_time",
+    OptionForgetPassword = "option_forget_password",
+    BuildStart = "build_start",
+    IosBuildStart = "ios_build_start",
+    IosBuildStartReq = "ios_build_start_Req",
+    NoActivity = "no_activity",
+    AppPublish = "app_publish_to_maintainer",
+    AppReleaseSuccess = "app_release_success",
+    IosAppReleaseSuccess = "ios_app_release_success",
+    AppReleaseRequest = "app_release_request"
+}
+export interface SendEmailNotificationOTPReq {
+    emailId: string;
+    userId: string;
+    otp: string;
+}
+export interface SendEmailNotification extends NotificationDetails {
+    emailId: string;
+    userId: string;
+    otp: string;
+}
+export interface SendPasswordChangedReq {
+    userId: string;
+    emailId: string;
+    firstName: string | null;
+    lastName: string | null;
+}
+export type SendPasswordChangedNotification = NotificationDetails;
+export interface SendForgetPasswordReq {
+    userId: string;
+    emailId: string;
+    firstName: string | null;
+    lastName: string | null;
+    link: string;
+}
+export interface SendForgetPasswordNotification extends NotificationDetails {
+    link: string;
+}
+export interface SendPostAddedNotificationReq {
+    userId: string;
+}
+export interface SendPostAddedNotification extends NotificationDetails {
+    user: string;
+}
+export interface SendPostUpdateToAdminNotification extends NotificationDetails {
+    user: string;
+}
+export type SendPostUpdateToUserNotification = NotificationDetails;
+export interface SendPostStatusChangedNotification extends NotificationDetails {
+    status: string;
+}
+export interface AppReminder {
+    appId: string;
+    reminder: Reminder[];
+}
+export interface AppBuildStartNotificationReq {
+    userId: string;
+    name: string;
+    team: string;
+}
+export interface AppBuildStartNotification extends NotificationDetails {
+    team: string;
+}
+export interface MaintainerDetail {
+    orgId: string;
+    userId: string;
+    firstName: string;
+    emailId: string;
+    team: string;
+}
+export interface IosBuildStartNotificationToAdmin extends NotificationDetails {
+    appName: string;
+    team: string;
+}
+export interface IosBuildStartNotificationReq {
+    userId: string;
+    name: string;
+    team: string;
+}
+export interface IosBuildStartNotification extends NotificationDetails {
+    team: string;
+}
+export interface AppBuildFailureNotificationReq {
+    userId: string;
+    name: string;
+    team: string;
+    supportEmailId: string;
+}
+export interface AppBuildFailureNotification extends NotificationDetails {
+    team: string;
+    supportEmailId: string;
+}
+export interface AppBuildSuccessNotificationReq {
+    userId: string;
+    name: string;
+    team: string;
+    supportEmailId: string;
+}
+export interface AppBuildSuccessNotification extends NotificationDetails {
+    team: string;
+    supportEmailId: string;
+}
+export interface ConfirmationNotificationReq {
+    userId: string;
+    name: string;
+    team: string;
+    supportEmailId: string;
+}
+export interface ConfirmationNotification extends NotificationDetails {
+    team: string;
+    supportEmailId: string;
+}
+export interface NeedSupportReq {
+    userId: string;
+    name: string;
+    team: string;
+    supportEmailId: string;
+}
+export interface NeedSupport extends NotificationDetails {
+    team: string;
+    supportEmailId: string;
+}
+export interface AfterRegistrationEmailReq {
+    userId: string;
+    name: string;
+    team: string;
+    supportEmailId: string;
+}
+export interface AfterRegistrationEmail extends NotificationDetails {
+    team: string;
+    supportEmailId: string;
+}
+export interface StockUpdateReq {
+    userId: string;
+    name: string;
+    team: string;
+    productName?: string;
+    productVariant: string;
+    productBrand?: string;
+    productSize?: string;
+    productColor?: string;
+    productPrice?: string;
+    productImageUrl?: string;
+}
+export interface StockUpdate extends NotificationDetails {
+    team: string;
+    productName?: string;
+    productVariant: string;
+    productBrand?: string;
+    productSize?: string;
+    productColor?: string;
+    productPrice?: string;
+}
+export interface AppPublishNotification extends NotificationDetails {
+    appName: string;
+    team: string;
+}
+export interface AppReleaseSuccessEmail extends NotificationDetails {
+    team: string;
+    playStoreAppLink: string;
+}
+export interface AppReleaseRequestEmail extends NotificationDetails {
+    team: string;
+    appName: string;
+}
+export interface IosAppReleaseSuccessEmail extends NotificationDetails {
+    team: string;
+    appName: string;
+    playStoreAppLink: string;
+}

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

@@ -0,0 +1,69 @@
+export var NotificationType;
+(function (NotificationType) {
+    NotificationType[NotificationType["OTPEmail"] = 1] = "OTPEmail";
+    NotificationType[NotificationType["PasswordChanged"] = 2] = "PasswordChanged";
+    NotificationType[NotificationType["ForgetPassword"] = 3] = "ForgetPassword";
+    NotificationType[NotificationType["NewPostAdmin"] = 4] = "NewPostAdmin";
+    NotificationType[NotificationType["UpdatePostToAdmin"] = 5] = "UpdatePostToAdmin";
+    NotificationType[NotificationType["UpdatePostToUser"] = 6] = "UpdatePostToUser";
+    NotificationType[NotificationType["AdminStatusChanged"] = 7] = "AdminStatusChanged";
+    NotificationType[NotificationType["AccountDeleted"] = 8] = "AccountDeleted";
+    NotificationType[NotificationType["NeedSupport"] = 9] = "NeedSupport";
+    NotificationType[NotificationType["StockUpdate"] = 10] = "StockUpdate";
+    NotificationType[NotificationType["buildSuccess"] = 11] = "buildSuccess";
+    NotificationType[NotificationType["buildProcessPending"] = 12] = "buildProcessPending";
+    NotificationType[NotificationType["PublishPending"] = 13] = "PublishPending";
+    NotificationType[NotificationType["DealMail"] = 14] = "DealMail";
+    NotificationType[NotificationType["OptionAppoinmentMail"] = 15] = "OptionAppoinmentMail";
+    NotificationType[NotificationType["RegistrationEmail"] = 16] = "RegistrationEmail";
+    NotificationType[NotificationType["NoWorkStart"] = 17] = "NoWorkStart";
+    NotificationType[NotificationType["OptionRestPassword"] = 18] = "OptionRestPassword";
+    NotificationType[NotificationType["ConfirmEmail"] = 19] = "ConfirmEmail";
+    NotificationType[NotificationType["OtptionSurveyEmail"] = 20] = "OtptionSurveyEmail";
+    NotificationType[NotificationType["BuildFailure"] = 21] = "BuildFailure";
+    NotificationType[NotificationType["NoActiveTime"] = 22] = "NoActiveTime";
+    NotificationType[NotificationType["OptionForgetPassword"] = 23] = "OptionForgetPassword";
+    NotificationType[NotificationType["BuildStart"] = 24] = "BuildStart";
+    NotificationType[NotificationType["IosBuildStart"] = 25] = "IosBuildStart";
+    NotificationType[NotificationType["IosBuildStartRequest"] = 26] = "IosBuildStartRequest";
+    NotificationType[NotificationType["NoActivity"] = 27] = "NoActivity";
+    NotificationType[NotificationType["AppPublish"] = 28] = "AppPublish";
+    NotificationType[NotificationType["AppReleaseSuccess"] = 29] = "AppReleaseSuccess";
+    NotificationType[NotificationType["IosAppReleaseSuccess"] = 30] = "IosAppReleaseSuccess";
+    NotificationType[NotificationType["AppReleaseRequest"] = 31] = "AppReleaseRequest";
+})(NotificationType || (NotificationType = {}));
+export var NotificationTemplate;
+(function (NotificationTemplate) {
+    NotificationTemplate["OTPEmail"] = "otp_email";
+    NotificationTemplate["PasswordChanged"] = "password_changed";
+    NotificationTemplate["ForgetPassword"] = "forget_password";
+    NotificationTemplate["NewPostAdmin"] = "new_post_admin";
+    NotificationTemplate["UpdatePostToAdmin"] = "update_post_to_admin";
+    NotificationTemplate["UpdatePostToUser"] = "update_post_to_user";
+    NotificationTemplate["AdminStatusChanged"] = "admin_status_changed";
+    NotificationTemplate["AccountDeleted"] = "account_deleted";
+    NotificationTemplate["NeedSupport"] = "need_support";
+    NotificationTemplate["StockUpdate"] = "stock_update";
+    NotificationTemplate["buildSuccess"] = "build_success";
+    NotificationTemplate["buildProcessPending"] = "build_process_pending";
+    NotificationTemplate["PublishPending"] = "publish_pending";
+    NotificationTemplate["DealMail"] = "deal_mail";
+    NotificationTemplate["OptionAppoinmentMail"] = "option_appoinment_schedule";
+    NotificationTemplate["RegistrationEmail"] = "registeration_email";
+    NotificationTemplate["NoWorkStart"] = "no_work_started";
+    NotificationTemplate["OptionRestPassword"] = "option_reset_password";
+    NotificationTemplate["ConfirmEmail"] = "confirmation_email";
+    NotificationTemplate["OtptionSurveyEmail"] = "option_survey_email";
+    NotificationTemplate["BuildFailure"] = "build_failure";
+    NotificationTemplate["NoActiveTime"] = "no_activity_time";
+    NotificationTemplate["OptionForgetPassword"] = "option_forget_password";
+    NotificationTemplate["BuildStart"] = "build_start";
+    NotificationTemplate["IosBuildStart"] = "ios_build_start";
+    NotificationTemplate["IosBuildStartReq"] = "ios_build_start_Req";
+    NotificationTemplate["NoActivity"] = "no_activity";
+    NotificationTemplate["AppPublish"] = "app_publish_to_maintainer";
+    NotificationTemplate["AppReleaseSuccess"] = "app_release_success";
+    NotificationTemplate["IosAppReleaseSuccess"] = "ios_app_release_success";
+    NotificationTemplate["AppReleaseRequest"] = "app_release_request";
+})(NotificationTemplate || (NotificationTemplate = {}));
+//# sourceMappingURL=notification.model.js.map

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

@@ -0,0 +1,153 @@
+import { OrderItem, OrderPayment, SaaSOrderPayment } from "../../index.model.js";
+export declare enum PaymentStatus {
+    New = 1,
+    WaitingForPayment = 8,
+    FAILURE = 9,
+    SUCCESS = 10,
+    PENDING = 11
+}
+export declare enum PaymentLogStage {
+    InitialRQ = 1,
+    InitialRS = 2,
+    WebhookRQ = 3,
+    WebhookRS = 4,
+    InquiryRQ = 5,
+    InquiryRS = 6
+}
+export interface IProviderSetting {
+    secretKey: string;
+    publishableKey: string;
+    webhookSecret: string;
+    successURL: string;
+    cancelURL: string;
+}
+export interface IOrderDetail {
+    mode: "payment" | "subscription";
+    emailId: string;
+    orgId: string;
+    userId: string;
+    trialPeriodDays?: number;
+    lineItems: LineItem[];
+}
+export interface LineItem {
+    price_data?: PriceData;
+    price?: string;
+    quantity: number;
+}
+export interface PriceData {
+    currency: string;
+    product_data: ProductData;
+    unit_amount: number;
+    recurring?: RecurringData;
+}
+export interface ProductData {
+    name: string;
+    images?: string[];
+    description?: string;
+}
+export interface RecurringData {
+    interval: 'day' | 'month' | 'week' | 'year';
+}
+export interface PaymentSessionReq {
+    planId: number;
+    qty: number;
+    moduleId: number[];
+    isHaveTrail: boolean;
+    emailId: string;
+    userId: string;
+    orgId: string;
+    trailDays?: number;
+    appId: string;
+}
+export interface PaymentSessionRes {
+    orderId: string;
+    orderPaymentId: string;
+    paymentProviderId: string;
+}
+export interface BuyPlanRes extends PaymentSessionRes {
+    appLaunchUrl: string;
+}
+export interface getPaymentSessionReq {
+    sessionid: string;
+    providerid: string;
+    orderpaymentid: string;
+}
+export interface PaymentSessionPriceRes {
+    order: SaaSOrderPayment;
+    orderItems: OrderItem[];
+    orderDetail: IOrderDetail;
+}
+export interface FeeSummary {
+    id: number;
+    amount: string;
+    paymentSettingId: number;
+}
+export interface RoundingDetail {
+    amountBeforeRounding: number;
+    amountAfterRounding: number;
+    difference: number;
+}
+export interface PaymentListForPayment {
+    card_type: string;
+    display_order: number;
+    group_id: string;
+    group_name: string;
+    is_production: boolean;
+    logo_url: string;
+    payment_settings_id: number;
+    provider_name: string;
+    provider_type: string;
+    small_logo_url: string;
+    description: string;
+    payment_type: string;
+    payment_group_id: string;
+    text_to_display: string;
+    fee_percentage: number;
+    fee_amount: number;
+}
+export declare enum OrderType {
+    subscription = 101
+}
+export declare enum OrderPaymentType {
+    subscription = "subscription"
+}
+export interface WebhookReq {
+    status: PaymentStatus;
+    transactionRef: string;
+    approvalCode: string;
+    statusInfo: string;
+    subscription?: string;
+    req?: unknown;
+}
+export declare abstract class PaymentHandler {
+    getSession: (order: OrderPayment, supportedCurrencies: string[], req: PaymentSessionRes) => Promise<object>;
+    handleWebHook: (paymentResponse: object) => Promise<WebhookReq>;
+    saveSubscription: (id: string, req: PaymentSessionRes) => Promise<void>;
+}
+export declare enum PaymentProviderType {
+    stripe = "stripe",
+    shopify = "shopify"
+}
+export interface WebhookRes {
+    isSuccess: boolean;
+}
+export declare enum SubscriptionStatus {
+    active = 1,
+    canceled = 2,
+    trialing = 3,
+    incomplete = 4
+}
+/**
+ * API Name: /api/payment/order/status
+ */
+export interface GetPaymentStatusReq {
+    token: string;
+}
+/**
+ * API Name: /api/payment/order/status
+ */
+export interface GetPaymentStatusRes {
+    orderPaymentId: string;
+    status: number;
+    transactionCode: string | null;
+}

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

@@ -0,0 +1,43 @@
+export var PaymentStatus;
+(function (PaymentStatus) {
+    PaymentStatus[PaymentStatus["New"] = 1] = "New";
+    PaymentStatus[PaymentStatus["WaitingForPayment"] = 8] = "WaitingForPayment";
+    PaymentStatus[PaymentStatus["FAILURE"] = 9] = "FAILURE";
+    PaymentStatus[PaymentStatus["SUCCESS"] = 10] = "SUCCESS";
+    PaymentStatus[PaymentStatus["PENDING"] = 11] = "PENDING";
+})(PaymentStatus || (PaymentStatus = {}));
+export var PaymentLogStage;
+(function (PaymentLogStage) {
+    PaymentLogStage[PaymentLogStage["InitialRQ"] = 1] = "InitialRQ";
+    PaymentLogStage[PaymentLogStage["InitialRS"] = 2] = "InitialRS";
+    PaymentLogStage[PaymentLogStage["WebhookRQ"] = 3] = "WebhookRQ";
+    PaymentLogStage[PaymentLogStage["WebhookRS"] = 4] = "WebhookRS";
+    PaymentLogStage[PaymentLogStage["InquiryRQ"] = 5] = "InquiryRQ";
+    PaymentLogStage[PaymentLogStage["InquiryRS"] = 6] = "InquiryRS";
+})(PaymentLogStage || (PaymentLogStage = {}));
+export var OrderType;
+(function (OrderType) {
+    OrderType[OrderType["subscription"] = 101] = "subscription";
+})(OrderType || (OrderType = {}));
+export var OrderPaymentType;
+(function (OrderPaymentType) {
+    OrderPaymentType["subscription"] = "subscription";
+})(OrderPaymentType || (OrderPaymentType = {}));
+export class PaymentHandler {
+    getSession;
+    handleWebHook;
+    saveSubscription;
+}
+export var PaymentProviderType;
+(function (PaymentProviderType) {
+    PaymentProviderType["stripe"] = "stripe";
+    PaymentProviderType["shopify"] = "shopify";
+})(PaymentProviderType || (PaymentProviderType = {}));
+export var SubscriptionStatus;
+(function (SubscriptionStatus) {
+    SubscriptionStatus[SubscriptionStatus["active"] = 1] = "active";
+    SubscriptionStatus[SubscriptionStatus["canceled"] = 2] = "canceled";
+    SubscriptionStatus[SubscriptionStatus["trialing"] = 3] = "trialing";
+    SubscriptionStatus[SubscriptionStatus["incomplete"] = 4] = "incomplete";
+})(SubscriptionStatus || (SubscriptionStatus = {}));
+//# sourceMappingURL=payment.model.js.map

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

@@ -0,0 +1,10 @@
+import { Provider } from "../../index.model.js";
+/**
+ * API Name: /api/provider/get/all
+ */
+export interface GetProvidersRes {
+    provider: Provider[];
+}
+export declare enum ProviderList {
+    Shopify = "Shopify"
+}

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

@@ -0,0 +1,5 @@
+export var ProviderList;
+(function (ProviderList) {
+    ProviderList["Shopify"] = "Shopify";
+})(ProviderList || (ProviderList = {}));
+//# sourceMappingURL=provider.model.js.map

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

@@ -0,0 +1,13 @@
+/**
+ * API Name: /api/app/reminder/add
+ */
+export interface AddReminderReq {
+    productId: string;
+    productVariantId: string;
+}
+/**
+ * API Name: /api/app/reminder/add
+ */
+export interface AddReminderRes {
+    isAdded: boolean;
+}

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

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