@authenty/authapi-types 1.0.29 → 1.0.31

package/dist/index.d.ts

@@ -671,10 +671,87 @@ export declare namespace AuthApi {
                 }>;
             }
         }
+        namespace support {
+            namespace newReport {
+                type POST = {
+                    msg?: string;
+                };
+            }
+        }
         namespace report {
-            type POST = {
-                msg?: string;
-            };
+            namespace users {
+                type GET = {
+                    totalUsers: number;
+                    usersByCountry: Array<{
+                        countryId: number | null;
+                        countryName: string;
+                        count: number;
+                    }>;
+                    usersByState: Array<{
+                        stateId: number | null;
+                        stateName: string;
+                        stateUf: string | null;
+                        count: number;
+                    }>;
+                    usersWithActiveSubscription: number;
+                };
+                namespace timeline {
+                    type GET = {
+                        timeline: Array<{
+                            month: string;
+                            users: number;
+                            purchases: number;
+                        }>;
+                        summary: {
+                            totalUsers: number;
+                            totalPurchases: number;
+                            iniDate: string;
+                            endDate: string;
+                        };
+                    };
+                }
+                namespace cumulativeTimeline {
+                    type GET = {
+                        timeline2: Array<{
+                            month: string;
+                            activeUsers: number;
+                            paidSubscriptions: number;
+                        }>;
+                        summary: {
+                            iniDate: string;
+                            endDate: string;
+                        };
+                    };
+                }
+                namespace usage {
+                    namespace monthly {
+                        type GET = {
+                            users: Array<{
+                                userId: number;
+                                userName: string;
+                                userEmail: string;
+                                monthlyUsage: Array<{
+                                    month: string;
+                                    totalMinutes: number;
+                                    totalHours: number;
+                                    byProduct: Array<{
+                                        productId: number;
+                                        productTitle: string;
+                                        minutes: number;
+                                    }>;
+                                }>;
+                            }>;
+                            summary: {
+                                totalUsers: number;
+                                totalSessions: number;
+                                totalMinutes: number;
+                                iniDate: string;
+                                endDate: string;
+                            };
+                        };
+                    }
+                }
+            }
         }
         namespace admin {
             namespace purchases {
@@ -814,9 +891,18 @@ export declare namespace AuthApi {
                 status: () => Promise<responses.ApiResponse<auxiliarTypes.CronjobsStatuses>>;
                 run: (name: string) => Promise<responses.ApiResponse<responses.cronJobs.run.POST>>;
             };
+            reports: {
+                users: () => Promise<responses.ApiResponse<responses.report.users.GET>>;
+                usersMonthlyUsage: (iniDate?: string, endDate?: string, userId?: number) => Promise<responses.ApiResponse<responses.report.users.usage.monthly.GET>>;
+                usersTimeline: (iniDate?: string, endDate?: string) => Promise<responses.ApiResponse<responses.report.users.timeline.GET>>;
+                usersCumulativeTimeline: (iniDate?: string, endDate?: string) => Promise<responses.ApiResponse<responses.report.users.cumulativeTimeline.GET>>;
+            };
+        };
+        support: {
+            newReport: (id: string, data: any) => Promise<responses.ApiResponse<responses.support.newReport.POST>>;
         };
-        report: {
-            new: (id: string, data: any) => Promise<responses.ApiResponse<responses.report.POST>>;
+        track: {
+            route: (route: string) => Promise<responses.ApiResponse<any>>;
         };
     }
 }

package/dist/index.js

@@ -253,17 +253,36 @@ var AuthApi;
                     run: async (name) => {
                         return await this.request('POST', `admin/cronjobs/run/${name}`, {});
                     }
+                },
+                reports: {
+                    users: async () => {
+                        return await this.request('GET', 'report/users', {});
+                    },
+                    usersMonthlyUsage: async (iniDate, endDate, userId) => {
+                        return await this.request('GET', 'report/users/usage/monthly', { iniDate, endDate, userId });
+                    },
+                    usersTimeline: async (iniDate, endDate) => {
+                        return await this.request('GET', 'report/users/timeline', { iniDate, endDate });
+                    },
+                    usersCumulativeTimeline: async (iniDate, endDate) => {
+                        return await this.request('GET', 'report/users/cumulative-timeline', { iniDate, endDate });
+                    },
                 }
             };
-            this.report = {
-                new: async (id, data) => {
-                    return await this.request('POST', 'report', {
+            this.support = {
+                newReport: async (id, data) => {
+                    return await this.request('POST', 'support/newReport', {
                         id,
                         data: (0, tools_1.safeStringify)(data),
                         appVersion: 'unknown'
                     });
                 }
             };
+            this.track = {
+                route: async (route) => {
+                    return await this.request('POST', 'track/route', { route });
+                }
+            };
             this.baseURL = config.baseURL;
             this.tokenStorage = config.tokenStorage;
             this.onTokenUpdate = config.onTokenUpdate;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@authenty/authapi-types",
-  "version": "1.0.29",
+  "version": "1.0.31",
   "description": "Shared types for Authenty API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/index.ts

@@ -689,8 +689,91 @@ export namespace AuthApi {
             }
         }
 
+        export namespace support {
+            export namespace newReport {
+                export type POST = { msg?: string };
+            }
+        }
         export namespace report {
-            export type POST = { msg?: string };
+
+            export namespace users {
+
+                export type GET = {
+                    totalUsers: number;
+                    usersByCountry: Array<{
+                        countryId: number | null;
+                        countryName: string;
+                        count: number;
+                    }>;
+                    usersByState: Array<{
+                        stateId: number | null;
+                        stateName: string;
+                        stateUf: string | null;
+                        count: number;
+                    }>;
+                    usersWithActiveSubscription: number;
+                };
+
+                export namespace timeline {
+                    export type GET = {
+                        timeline: Array<{
+                            month: string;
+                            users: number;
+                            purchases: number;
+                        }>;
+                        summary: {
+                            totalUsers: number;
+                            totalPurchases: number;
+                            iniDate: string;
+                            endDate: string;
+                        };
+                    };
+                }
+
+                export namespace cumulativeTimeline {
+                    export type GET = {
+                        timeline2: Array<{
+                            month: string;
+                            activeUsers: number;
+                            paidSubscriptions: number;
+                        }>;
+                        summary: {
+                            iniDate: string;
+                            endDate: string;
+                        };
+                    };
+                }
+
+                export namespace usage {
+                    export namespace monthly {
+                        export type GET = {
+                            users: Array<{
+                                userId: number;
+                                userName: string;
+                                userEmail: string;
+                                monthlyUsage: Array<{
+                                    month: string;
+                                    totalMinutes: number;
+                                    totalHours: number;
+                                    byProduct: Array<{
+                                        productId: number;
+                                        productTitle: string;
+                                        minutes: number;
+                                    }>;
+                                }>;
+                            }>;
+                            summary: {
+                                totalUsers: number;
+                                totalSessions: number;
+                                totalMinutes: number;
+                                iniDate: string;
+                                endDate: string;
+                            };
+                        };
+                    }
+                }
+
+            }
         }
 
         export namespace admin {
@@ -1109,13 +1192,28 @@ export namespace AuthApi {
                 run: async (name: string) => {
                     return await this.request<responses.cronJobs.run.POST>('POST', `admin/cronjobs/run/${name}`, {});
                 }
+            },
+
+            reports: {
+                users: async () => {
+                    return await this.request<responses.report.users.GET>('GET', 'report/users', {});
+                },
+                usersMonthlyUsage: async (iniDate?: string, endDate?: string, userId?: number) => {
+                    return await this.request<responses.report.users.usage.monthly.GET>('GET', 'report/users/usage/monthly', { iniDate, endDate, userId });
+                },
+                usersTimeline: async (iniDate?: string, endDate?: string) => {
+                    return await this.request<responses.report.users.timeline.GET>('GET', 'report/users/timeline', { iniDate, endDate });
+                },
+                usersCumulativeTimeline: async (iniDate?: string, endDate?: string) => {
+                    return await this.request<responses.report.users.cumulativeTimeline.GET>('GET', 'report/users/cumulative-timeline', { iniDate, endDate });
+                },
             }
         }
 
-        public report = {
-            new: async (id: string, data: any) => {
+        public support = {
+            newReport: async (id: string, data: any) => {
 
-                return await this.request<responses.report.POST>('POST', 'report', {
+                return await this.request<responses.support.newReport.POST>('POST', 'support/newReport', {
                     id,
                     data: safeStringify(data),
                     appVersion: 'unknown'
@@ -1123,6 +1221,11 @@ export namespace AuthApi {
             }
         }
 
+        public track = {
+            route: async (route: string) => {
+                return await this.request('POST', 'track/route', { route });
+            }
+        }
     }
 
 }

package/dist/admin.d.ts

@@ -1,19 +0,0 @@
-export declare enum Privilege {
-    NONE = 0,
-    READ = 1,
-    WRITE = 2
-}
-export type PrivilegeTable = {
-    users: Privilege;
-    products: Privilege;
-    courses: Privilege;
-    consultancies: Privilege;
-    bundles: Privilege;
-    logs: Privilege;
-    support: Privilege;
-    leads: Privilege;
-    paymentSystem: Privilege;
-    adminMaster: Privilege;
-    activityTrakking: Privilege;
-    financial: Privilege;
-};

package/dist/admin.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Privilege = void 0;
-var Privilege;
-(function (Privilege) {
-    Privilege[Privilege["NONE"] = 0] = "NONE";
-    Privilege[Privilege["READ"] = 1] = "READ";
-    Privilege[Privilege["WRITE"] = 2] = "WRITE";
-})(Privilege || (exports.Privilege = Privilege = {}));

package/dist/cronjobs.d.ts

@@ -1,8 +0,0 @@
-export type CronJob = {
-    startAt: Date | null;
-    latestRunErrorCount: number;
-    latestCompletedAt: Date | null;
-};
-export type CronjobsStatuses = {
-    purchasesStatusUpdate: CronJob;
-};

package/dist/cronjobs.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/general.d.ts

@@ -1,227 +0,0 @@
-import { PrivilegeTable } from "./admin";
-import { PG_PurchaseLicenseStatus, PG_PurchasePaymentStatus, PG_PurchaseType } from "./payment-system";
-export declare enum BundleType {
-    BUNDLE = 0,
-    SYMBOLIC_PRODUCT = 1,
-    SYMBOLIC_COURSE = 2,
-    SYMBOLIC_CONSULTANCY = 3
-}
-export type Product = {
-    id: number;
-    title: string;
-    short: string;
-    resume: string;
-    video: string;
-    imgUrls: string | null;
-    logo: string;
-    themeImage: string;
-    themeColor: string;
-    themeVideo: string;
-    url: string;
-    type: number;
-    period_test: number;
-    created: string;
-    deletedAt?: string | null;
-    Levels?: ProductLevel[];
-};
-export type ProductLevel = {
-    id: number;
-    productID: number;
-    level: number;
-    short: string;
-    Product?: Product;
-    store_bundles_levels?: {
-        id: number;
-        bundleID: number;
-        levelID: number;
-        quantity: number;
-        Bundle?: Bundle;
-    }[];
-};
-export type Course = {
-    id: number;
-    type: number;
-    name: string;
-    short: string;
-    resume: string;
-    img_landscape: string;
-    img_square: string;
-    workload: number;
-    langID: number;
-    num_classes?: number;
-    seats: number;
-    url?: string;
-    dates: string;
-    local: string;
-    local_url: string;
-    date_mat_s?: string;
-    date_mat_e?: string;
-    date_ends?: string;
-    email_enrollment?: string;
-    email_before?: string;
-    email_after?: string;
-    date_c: string;
-    date_r?: string | null;
-};
-export type Consultancy = {
-    id: number;
-    teacherID: number;
-    type: number;
-    name: string;
-    short: string;
-    resume: string;
-    img_landscape: string;
-    img_square: string;
-    workload: number;
-    langID: number;
-    url?: string;
-    datetime: string;
-    date_mat_s?: string;
-    date_mat_e?: string;
-    date_ends?: string;
-    email_enrollment: string;
-    email_before: string;
-    email_after: string;
-    date_c: string;
-    date_r?: string | null;
-};
-export type Bundle = {
-    id: number;
-    type: BundleType;
-    title?: string;
-    short?: string;
-    resume?: string;
-    img: string;
-    themeImage: string;
-    themeColor: string;
-    shareLimit: number;
-    created: string;
-    active: boolean;
-    showInSite: boolean;
-    defaultMetaArray: string;
-    deletedAt?: string | null;
-    Levels?: {
-        id: number;
-        bundleID: number;
-        levelID: number;
-        quantity: number;
-        Level: ProductLevel;
-    }[];
-    Courses?: {
-        id: number;
-        bundleID: number;
-        courseID: number;
-        quantity: number;
-        Course: Course;
-    }[];
-    Consultancies?: {
-        id: number;
-        bundleID: number;
-        consultancyID: number;
-        quantity: number;
-        Consultancy: Consultancy;
-    }[];
-    store_bundles_paymethod: PaymentMethod[];
-};
-export type PaymentMethod = {
-    id: number;
-    bundleID: number;
-    price: number;
-    fromprice: number;
-    period_renew: number;
-    period_grace: number;
-    gatewayHash: string;
-    allowBoleto: boolean;
-    gatewayID: number;
-    Bundle?: Bundle;
-};
-export type Purchase = {
-    paghash: string;
-    id: number;
-    price: number;
-    licenseStatus: PG_PurchaseLicenseStatus;
-    paymentStatus: PG_PurchasePaymentStatus;
-    type_step: PG_PurchaseType;
-    PaymentMethod: PaymentMethod;
-    Wallet?: Wallet;
-    walletID: number;
-    createdAt: string;
-    paymentDueAt: string | null;
-    owner: string;
-    invoiceUrl?: string;
-    nfUrl?: string;
-    isAdmin?: boolean;
-    meta_data?: Record<string, any>;
-    PurchaseShares?: PurchaseShare[];
-    Levels?: {
-        Level: ProductLevel;
-        quant: number;
-    }[];
-};
-export type Wallet = {
-    id: number;
-    userID: number;
-    balance?: number;
-    Purchases?: Purchase[];
-};
-export type PurchaseShare = {
-    id: number;
-    purchaseID: number;
-    userID: number;
-    Purchase: Purchase;
-};
-export type LocalUser = {
-    id: number;
-    fullname: string;
-    email: string;
-    lang: number;
-    avatar: string;
-    end_city?: number;
-    end_comp?: string;
-    end_country: number;
-    end_district?: string;
-    end_n?: string;
-    end_state?: number;
-    end_street?: string;
-    end_zip?: string;
-    email_verif: boolean;
-    fiscal_verif: boolean;
-    terms: boolean;
-    cpf?: string;
-    newslatter?: boolean;
-    allow_purchase?: boolean;
-    allow_license?: boolean;
-    date_c?: Date | string;
-    date_r?: Date | string | null;
-    Wallets?: Wallet[];
-    PurchasesShares?: PurchaseShare[];
-    Sys_admUser_config?: AdminUserConfig;
-    Sys_adminUser?: PrivilegeTable;
-};
-export type AdminUserConfig = {
-    campaigns_blacklist: string;
-    deletedAt: Date | null;
-    userID: number;
-};
-export type availableSoftware_auxType = {
-    Level: ProductLevel;
-    quantity: number;
-    purchaseId: number | null;
-    type: 'free' | 'own' | 'shared';
-};
-export type LogEntry = {
-    appId: string;
-    logCode: number;
-    content: string;
-    timestamp?: string;
-    metadata?: {
-        requestId: string;
-        endpoint: string;
-        method: string;
-        userId?: number;
-        ip?: string;
-        browser?: string;
-        system?: string;
-        referer?: string;
-    };
-};

package/dist/general.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BundleType = void 0;
-var BundleType;
-(function (BundleType) {
-    BundleType[BundleType["BUNDLE"] = 0] = "BUNDLE";
-    BundleType[BundleType["SYMBOLIC_PRODUCT"] = 1] = "SYMBOLIC_PRODUCT";
-    BundleType[BundleType["SYMBOLIC_COURSE"] = 2] = "SYMBOLIC_COURSE";
-    BundleType[BundleType["SYMBOLIC_CONSULTANCY"] = 3] = "SYMBOLIC_CONSULTANCY";
-})(BundleType || (exports.BundleType = BundleType = {}));

package/dist/package.json

@@ -1,18 +0,0 @@
-{
-    "name": "@authenty/authapi-types",
-    "version": "1.0.12",
-    "description": "Shared types for Authenty API",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "scripts": {
-        "prebuild": "node IncrementVersion.js",
-        "build": "tsc",
-        "dev": "tsc -w"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "devDependencies": {
-        "typescript": "^5.0.0"
-    }
-}

package/dist/payment-system.d.ts

@@ -1,44 +0,0 @@
-export type PG_Customer = {
-    id: string;
-    email: string;
-    name: string;
-};
-export declare enum PG_PurchaseLicenseStatus {
-    UNKNOWN = 0,//Nunca será atualizado automaticamente!!
-    OPEN = 3,//ABERTA - Aguardando pagamento
-    EXPIRED = 1,//VENCEU - Era PAGAMENTO, e acabou prazo pra uso acabou
-    PAID = 5,//PAGA - Pagamento realizado com sucesso - é pagamento único
-    ACTIVE = 6,//ATIVO - Assinatura ativa e em dia
-    RECYCLING = 4,//RETENTANDO - Tentativa de renovação automática falhou, mas ainda está no prazo para pagar manualmente
-    CANCELED = 2
-}
-export declare const PG_PurchaseLicenseStatus_GroupActive: PG_PurchaseLicenseStatus[];
-export declare enum PG_PurchasePaymentStatus {
-    UNKNOWN = 0,//pendent or unknown
-    ACTIVE = 1,
-    CANCELED = 2,
-    REFUNDED = 3,
-    REMOVED = 4,// REMOVIDO DO GATEWAY - Não há mais registro do pagamento no gateway
-    PENDING = 5
-}
-export declare enum PG_PurchaseType {
-    SESSION = 0,//o registro se trata de uma sessão de compra (ex: intenção de compra preparada para redirecionar o usuário ao gateway. Ainda não é um pagamento nem uma assinatura ativa)
-    STANDARD = 1,//Pagamento único
-    RECURRENT = 2
-}
-export type PG_Purchase = {
-    id: string;
-    amount: number;
-    recurrent: boolean;
-    type: PG_PurchaseType;
-    paymentStatus: PG_PurchasePaymentStatus;
-    url: string | null;
-    dueTime: Date | null;
-};
-export declare enum PG_RecurrenceType {
-    NONE = 0,
-    DAILY = 1,
-    WEEKLY = 2,
-    MONTHLY = 3,
-    YEARLY = 4
-}

package/dist/payment-system.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PG_RecurrenceType = exports.PG_PurchaseType = exports.PG_PurchasePaymentStatus = exports.PG_PurchaseLicenseStatus_GroupActive = exports.PG_PurchaseLicenseStatus = void 0;
-var PG_PurchaseLicenseStatus;
-(function (PG_PurchaseLicenseStatus) {
-    // Pagamentos ou Assinaturas
-    PG_PurchaseLicenseStatus[PG_PurchaseLicenseStatus["UNKNOWN"] = 0] = "UNKNOWN";
-    PG_PurchaseLicenseStatus[PG_PurchaseLicenseStatus["OPEN"] = 3] = "OPEN";
-    // Pagamentos
-    PG_PurchaseLicenseStatus[PG_PurchaseLicenseStatus["EXPIRED"] = 1] = "EXPIRED";
-    PG_PurchaseLicenseStatus[PG_PurchaseLicenseStatus["PAID"] = 5] = "PAID";
-    // Assinaturas
-    PG_PurchaseLicenseStatus[PG_PurchaseLicenseStatus["ACTIVE"] = 6] = "ACTIVE";
-    PG_PurchaseLicenseStatus[PG_PurchaseLicenseStatus["RECYCLING"] = 4] = "RECYCLING";
-    PG_PurchaseLicenseStatus[PG_PurchaseLicenseStatus["CANCELED"] = 2] = "CANCELED";
-})(PG_PurchaseLicenseStatus || (exports.PG_PurchaseLicenseStatus = PG_PurchaseLicenseStatus = {}));
-exports.PG_PurchaseLicenseStatus_GroupActive = [
-    PG_PurchaseLicenseStatus.PAID,
-    PG_PurchaseLicenseStatus.ACTIVE,
-    PG_PurchaseLicenseStatus.RECYCLING,
-];
-var PG_PurchasePaymentStatus;
-(function (PG_PurchasePaymentStatus) {
-    PG_PurchasePaymentStatus[PG_PurchasePaymentStatus["UNKNOWN"] = 0] = "UNKNOWN";
-    PG_PurchasePaymentStatus[PG_PurchasePaymentStatus["ACTIVE"] = 1] = "ACTIVE";
-    PG_PurchasePaymentStatus[PG_PurchasePaymentStatus["CANCELED"] = 2] = "CANCELED";
-    PG_PurchasePaymentStatus[PG_PurchasePaymentStatus["REFUNDED"] = 3] = "REFUNDED";
-    PG_PurchasePaymentStatus[PG_PurchasePaymentStatus["REMOVED"] = 4] = "REMOVED";
-    PG_PurchasePaymentStatus[PG_PurchasePaymentStatus["PENDING"] = 5] = "PENDING";
-})(PG_PurchasePaymentStatus || (exports.PG_PurchasePaymentStatus = PG_PurchasePaymentStatus = {}));
-var PG_PurchaseType;
-(function (PG_PurchaseType) {
-    PG_PurchaseType[PG_PurchaseType["SESSION"] = 0] = "SESSION";
-    PG_PurchaseType[PG_PurchaseType["STANDARD"] = 1] = "STANDARD";
-    PG_PurchaseType[PG_PurchaseType["RECURRENT"] = 2] = "RECURRENT";
-})(PG_PurchaseType || (exports.PG_PurchaseType = PG_PurchaseType = {}));
-var PG_RecurrenceType;
-(function (PG_RecurrenceType) {
-    PG_RecurrenceType[PG_RecurrenceType["NONE"] = 0] = "NONE";
-    PG_RecurrenceType[PG_RecurrenceType["DAILY"] = 1] = "DAILY";
-    PG_RecurrenceType[PG_RecurrenceType["WEEKLY"] = 2] = "WEEKLY";
-    PG_RecurrenceType[PG_RecurrenceType["MONTHLY"] = 3] = "MONTHLY";
-    PG_RecurrenceType[PG_RecurrenceType["YEARLY"] = 4] = "YEARLY";
-})(PG_RecurrenceType || (exports.PG_RecurrenceType = PG_RecurrenceType = {}));