@vitalfit/sdk 0.0.76 → 0.1.0

package/dist/index.d.cts

@@ -44,6 +44,9 @@ type BaseModel = UUIDModel & {
 type DataResponse<T> = {
     data: T;
 };
+type PaginationWithStatus = PaginationRequest & {
+    status?: string;
+};
 
 declare enum UserGender {
     male = "male",
@@ -736,6 +739,14 @@ type ClientInvoice = {
     total_amount: string;
     status: string;
 };
+type InvoiceList = {
+    client_name: string;
+    invoice_id: string;
+    invoice_number: string;
+    issue_date: string;
+    status: string;
+    total_amount: number;
+};
 
 type ClientBookingResponse = {
     booking_id: string;
@@ -853,6 +864,25 @@ type CheckInResponse = {
     service_name: string;
 };
 
+type ChartData = {
+    hour?: number;
+    label: string;
+    value: number;
+};
+type TopBranch = {
+    branch_name: string;
+    total_sales: string;
+    percent_change: number;
+    label: string;
+    trend: 'up' | 'down' | string;
+};
+type GlobalStat = {
+    percentage_change: number;
+    total_current_month: number;
+    total_last_month: number;
+    trend: string;
+};
+
 declare class AuthService {
     private client;
     constructor(client: Client);
@@ -875,7 +905,7 @@ declare class UserService {
     getStaffUsers({ search, role }: UserPaginationOptions, jwt: string): Promise<DataResponse<User[]>>;
     WhoAmI(jwt: string): Promise<UserApiResponse>;
     getBranchAdmins(jwt: string): Promise<DataResponse<User[]>>;
-    getClientUsers(jwt: string, options?: UserPaginationOptions): Promise<DataResponse<User[]>>;
+    getClientUsers(jwt: string, options?: UserPaginationOptions): Promise<PaginatedTotal<User[]>>;
     GetUserByID(userId: string, jwt: string): Promise<DataResponse<GetUserResponse>>;
     updateUserClient(userId: string, data: UpdateUserRequest, jwt: string): Promise<void>;
     updateUserStaff(userId: string, data: UpdateUserStaffRequest, jwt: string): Promise<void>;
@@ -1034,6 +1064,7 @@ declare class BillingService {
     getPaymentByID(paymentId: string, jwt: string): Promise<DataResponse<PaymentDetail>>;
     updatePaymentStatus(paymentId: string, status: string, jwt: string): Promise<void>;
     getClientInvoices(jwt: string, { page, limit, sort, search }: PaginationRequest, userID?: string): Promise<PaginatedTotal<ClientInvoice[]>>;
+    getInvoices(jwt: string, { page, limit, sort, search, status, }: PaginationWithStatus): Promise<PaginatedTotal<InvoiceList[]>>;
 }
 
 declare class BookingService {
@@ -1051,6 +1082,20 @@ declare class AccessService {
     checkIn(jwt: string, data: CheckIn): Promise<CheckInResponse>;
 }
 
+declare class ReportService {
+    client: Client;
+    constructor(client: Client);
+    mostUsedServices(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    salesByCategory(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    salesByHour(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    salesByPaymentMethod(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    topInstructors(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    topBranches(jwt: string): Promise<DataResponse<TopBranch[]>>;
+    globalStats(jwt: string): Promise<DataResponse<TopBranch[]>>;
+    totalActiveBranches(jwt: string): Promise<DataResponse<number>>;
+    totalClients(jwt: string): Promise<DataResponse<number>>;
+}
+
 declare class APIError extends Error {
     status: number;
     messages: string[];
@@ -1077,9 +1122,10 @@ declare class VitalFit {
     billing: BillingService;
     booking: BookingService;
     access: AccessService;
+    report: ReportService;
     constructor(isDevMode: boolean, origin?: string);
     static getInstance(isDevMode?: boolean): VitalFit;
     version(): string;
 }
 
-export { APIError, type AddPaymentToInvoicePayload, type AddPaymentToInvoiceResponse, type BankTransferConfig, type Banner, type BannerResponse, type BaseModel, type BookClassRequest, type BranchClassInfo, type BranchDetails, type BranchEquipmentInventory, type BranchInfo, type BranchInstructorInfo, type BranchPaymentMethod, type BranchPaymentMethodInfo, type BranchPaymentVisibility, type BranchScheduleResponse, type BranchServicePrice, type BranchStatusCount, type CancellationReason, type CheckIn, type CheckInResponse, type ClientBookingResponse, type ClientInvoice, type ClientMembership, type ClientMembershipDetail, type ClientMembershipItem, type ClientMembershipUser, type ClientProfile, type CreateBanner, type CreateBranchEquipment, type CreateBranchRequest, type CreateBranchServicePriceItem, type CreateClassPayload, type CreateEquipment, type CreateInvoiceItem, type CreateInvoicePayload, type CreateInvoiceResponse, type CreateMembershipType, type CreatePackagePayload, type CreatePaymentMethod, type CreateRole, type CreateService, type CreateServiceImage, type DataResponse, type Equipment, type EquipmentCategory, type EquipmentInfo, type EquipmentStatus, type GetUserResponse, type Instructor, type InstructorData, type InstructorDataList, type InstructorsSummary, type InvoiceDetail, type InvoiceItemDetail, type InvoicePaymentDetail, type LoginRequest, type LoginResponse, type MembershipType, type MembershipTypeDetail, type MembershipsSummary, type Oauth, type OperatingHour, type PackageDetail, type PackageItemDetail, type PackageItemInput, type PackageListItem, type PackagePublicItem, type PaginatedBranch, type PaginatedEquipmentRequest, type PaginatedInstructor, type PaginatedServiceRequest, type PaginatedTotal, type Pagination, type PaginationBranchRequest, type PaginationRequest, type PagoMovilConfig, type PaymentConfiguration, type PaymentDetail, type PaymentMethod, type PaymentMethodTypes, type Permission, type PublicMembershipResponse, type PublicPaginatedPackage, type PublicPaginationService, type QrToken, type Role, type RoleResponse, type ServiceCategoryInfo, type ServiceFullDetail, type ServiceImageResponse, type ServicePublicItem, type ServicesSummary, type SignUpRequest, type Specialty, type UUIDModel, type UpdateBanner, type UpdateBranchEquipmentDetails, type UpdateBranchPaymentMethod, type UpdateBranchRequest, type UpdateBranchServicePrice, type UpdateClassPayload, type UpdateClientMembershipRequest, type UpdateEquipment, type UpdateMembershipType, type UpdateOperatingHour, type UpdatePackagePayload, type UpdateServiceImageManual, type UpdateServiceManual, type UpdateUserRequest, type UpdateUserStaffRequest, type User, type UserApiResponse, UserGender, type UserPaginationOptions, VitalFit, type ZelleConfig, isAPIError, mainCurrencies };
+export { APIError, type AddPaymentToInvoicePayload, type AddPaymentToInvoiceResponse, type BankTransferConfig, type Banner, type BannerResponse, type BaseModel, type BookClassRequest, type BranchClassInfo, type BranchDetails, type BranchEquipmentInventory, type BranchInfo, type BranchInstructorInfo, type BranchPaymentMethod, type BranchPaymentMethodInfo, type BranchPaymentVisibility, type BranchScheduleResponse, type BranchServicePrice, type BranchStatusCount, type CancellationReason, type ChartData, type CheckIn, type CheckInResponse, type ClientBookingResponse, type ClientInvoice, type ClientMembership, type ClientMembershipDetail, type ClientMembershipItem, type ClientMembershipUser, type ClientProfile, type CreateBanner, type CreateBranchEquipment, type CreateBranchRequest, type CreateBranchServicePriceItem, type CreateClassPayload, type CreateEquipment, type CreateInvoiceItem, type CreateInvoicePayload, type CreateInvoiceResponse, type CreateMembershipType, type CreatePackagePayload, type CreatePaymentMethod, type CreateRole, type CreateService, type CreateServiceImage, type DataResponse, type Equipment, type EquipmentCategory, type EquipmentInfo, type EquipmentStatus, type GetUserResponse, type GlobalStat, type Instructor, type InstructorData, type InstructorDataList, type InstructorsSummary, type InvoiceDetail, type InvoiceItemDetail, type InvoiceList, type InvoicePaymentDetail, type LoginRequest, type LoginResponse, type MembershipType, type MembershipTypeDetail, type MembershipsSummary, type Oauth, type OperatingHour, type PackageDetail, type PackageItemDetail, type PackageItemInput, type PackageListItem, type PackagePublicItem, type PaginatedBranch, type PaginatedEquipmentRequest, type PaginatedInstructor, type PaginatedServiceRequest, type PaginatedTotal, type Pagination, type PaginationBranchRequest, type PaginationRequest, type PaginationWithStatus, type PagoMovilConfig, type PaymentConfiguration, type PaymentDetail, type PaymentMethod, type PaymentMethodTypes, type Permission, type PublicMembershipResponse, type PublicPaginatedPackage, type PublicPaginationService, type QrToken, type Role, type RoleResponse, type ServiceCategoryInfo, type ServiceFullDetail, type ServiceImageResponse, type ServicePublicItem, type ServicesSummary, type SignUpRequest, type Specialty, type TopBranch, type UUIDModel, type UpdateBanner, type UpdateBranchEquipmentDetails, type UpdateBranchPaymentMethod, type UpdateBranchRequest, type UpdateBranchServicePrice, type UpdateClassPayload, type UpdateClientMembershipRequest, type UpdateEquipment, type UpdateMembershipType, type UpdateOperatingHour, type UpdatePackagePayload, type UpdateServiceImageManual, type UpdateServiceManual, type UpdateUserRequest, type UpdateUserStaffRequest, type User, type UserApiResponse, UserGender, type UserPaginationOptions, VitalFit, type ZelleConfig, isAPIError, mainCurrencies };

package/dist/index.d.ts

@@ -44,6 +44,9 @@ type BaseModel = UUIDModel & {
 type DataResponse<T> = {
     data: T;
 };
+type PaginationWithStatus = PaginationRequest & {
+    status?: string;
+};
 
 declare enum UserGender {
     male = "male",
@@ -736,6 +739,14 @@ type ClientInvoice = {
     total_amount: string;
     status: string;
 };
+type InvoiceList = {
+    client_name: string;
+    invoice_id: string;
+    invoice_number: string;
+    issue_date: string;
+    status: string;
+    total_amount: number;
+};
 
 type ClientBookingResponse = {
     booking_id: string;
@@ -853,6 +864,25 @@ type CheckInResponse = {
     service_name: string;
 };
 
+type ChartData = {
+    hour?: number;
+    label: string;
+    value: number;
+};
+type TopBranch = {
+    branch_name: string;
+    total_sales: string;
+    percent_change: number;
+    label: string;
+    trend: 'up' | 'down' | string;
+};
+type GlobalStat = {
+    percentage_change: number;
+    total_current_month: number;
+    total_last_month: number;
+    trend: string;
+};
+
 declare class AuthService {
     private client;
     constructor(client: Client);
@@ -875,7 +905,7 @@ declare class UserService {
     getStaffUsers({ search, role }: UserPaginationOptions, jwt: string): Promise<DataResponse<User[]>>;
     WhoAmI(jwt: string): Promise<UserApiResponse>;
     getBranchAdmins(jwt: string): Promise<DataResponse<User[]>>;
-    getClientUsers(jwt: string, options?: UserPaginationOptions): Promise<DataResponse<User[]>>;
+    getClientUsers(jwt: string, options?: UserPaginationOptions): Promise<PaginatedTotal<User[]>>;
     GetUserByID(userId: string, jwt: string): Promise<DataResponse<GetUserResponse>>;
     updateUserClient(userId: string, data: UpdateUserRequest, jwt: string): Promise<void>;
     updateUserStaff(userId: string, data: UpdateUserStaffRequest, jwt: string): Promise<void>;
@@ -1034,6 +1064,7 @@ declare class BillingService {
     getPaymentByID(paymentId: string, jwt: string): Promise<DataResponse<PaymentDetail>>;
     updatePaymentStatus(paymentId: string, status: string, jwt: string): Promise<void>;
     getClientInvoices(jwt: string, { page, limit, sort, search }: PaginationRequest, userID?: string): Promise<PaginatedTotal<ClientInvoice[]>>;
+    getInvoices(jwt: string, { page, limit, sort, search, status, }: PaginationWithStatus): Promise<PaginatedTotal<InvoiceList[]>>;
 }
 
 declare class BookingService {
@@ -1051,6 +1082,20 @@ declare class AccessService {
     checkIn(jwt: string, data: CheckIn): Promise<CheckInResponse>;
 }
 
+declare class ReportService {
+    client: Client;
+    constructor(client: Client);
+    mostUsedServices(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    salesByCategory(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    salesByHour(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    salesByPaymentMethod(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    topInstructors(jwt: string, start: string, end: string): Promise<DataResponse<ChartData[]>>;
+    topBranches(jwt: string): Promise<DataResponse<TopBranch[]>>;
+    globalStats(jwt: string): Promise<DataResponse<TopBranch[]>>;
+    totalActiveBranches(jwt: string): Promise<DataResponse<number>>;
+    totalClients(jwt: string): Promise<DataResponse<number>>;
+}
+
 declare class APIError extends Error {
     status: number;
     messages: string[];
@@ -1077,9 +1122,10 @@ declare class VitalFit {
     billing: BillingService;
     booking: BookingService;
     access: AccessService;
+    report: ReportService;
     constructor(isDevMode: boolean, origin?: string);
     static getInstance(isDevMode?: boolean): VitalFit;
     version(): string;
 }
 
-export { APIError, type AddPaymentToInvoicePayload, type AddPaymentToInvoiceResponse, type BankTransferConfig, type Banner, type BannerResponse, type BaseModel, type BookClassRequest, type BranchClassInfo, type BranchDetails, type BranchEquipmentInventory, type BranchInfo, type BranchInstructorInfo, type BranchPaymentMethod, type BranchPaymentMethodInfo, type BranchPaymentVisibility, type BranchScheduleResponse, type BranchServicePrice, type BranchStatusCount, type CancellationReason, type CheckIn, type CheckInResponse, type ClientBookingResponse, type ClientInvoice, type ClientMembership, type ClientMembershipDetail, type ClientMembershipItem, type ClientMembershipUser, type ClientProfile, type CreateBanner, type CreateBranchEquipment, type CreateBranchRequest, type CreateBranchServicePriceItem, type CreateClassPayload, type CreateEquipment, type CreateInvoiceItem, type CreateInvoicePayload, type CreateInvoiceResponse, type CreateMembershipType, type CreatePackagePayload, type CreatePaymentMethod, type CreateRole, type CreateService, type CreateServiceImage, type DataResponse, type Equipment, type EquipmentCategory, type EquipmentInfo, type EquipmentStatus, type GetUserResponse, type Instructor, type InstructorData, type InstructorDataList, type InstructorsSummary, type InvoiceDetail, type InvoiceItemDetail, type InvoicePaymentDetail, type LoginRequest, type LoginResponse, type MembershipType, type MembershipTypeDetail, type MembershipsSummary, type Oauth, type OperatingHour, type PackageDetail, type PackageItemDetail, type PackageItemInput, type PackageListItem, type PackagePublicItem, type PaginatedBranch, type PaginatedEquipmentRequest, type PaginatedInstructor, type PaginatedServiceRequest, type PaginatedTotal, type Pagination, type PaginationBranchRequest, type PaginationRequest, type PagoMovilConfig, type PaymentConfiguration, type PaymentDetail, type PaymentMethod, type PaymentMethodTypes, type Permission, type PublicMembershipResponse, type PublicPaginatedPackage, type PublicPaginationService, type QrToken, type Role, type RoleResponse, type ServiceCategoryInfo, type ServiceFullDetail, type ServiceImageResponse, type ServicePublicItem, type ServicesSummary, type SignUpRequest, type Specialty, type UUIDModel, type UpdateBanner, type UpdateBranchEquipmentDetails, type UpdateBranchPaymentMethod, type UpdateBranchRequest, type UpdateBranchServicePrice, type UpdateClassPayload, type UpdateClientMembershipRequest, type UpdateEquipment, type UpdateMembershipType, type UpdateOperatingHour, type UpdatePackagePayload, type UpdateServiceImageManual, type UpdateServiceManual, type UpdateUserRequest, type UpdateUserStaffRequest, type User, type UserApiResponse, UserGender, type UserPaginationOptions, VitalFit, type ZelleConfig, isAPIError, mainCurrencies };
+export { APIError, type AddPaymentToInvoicePayload, type AddPaymentToInvoiceResponse, type BankTransferConfig, type Banner, type BannerResponse, type BaseModel, type BookClassRequest, type BranchClassInfo, type BranchDetails, type BranchEquipmentInventory, type BranchInfo, type BranchInstructorInfo, type BranchPaymentMethod, type BranchPaymentMethodInfo, type BranchPaymentVisibility, type BranchScheduleResponse, type BranchServicePrice, type BranchStatusCount, type CancellationReason, type ChartData, type CheckIn, type CheckInResponse, type ClientBookingResponse, type ClientInvoice, type ClientMembership, type ClientMembershipDetail, type ClientMembershipItem, type ClientMembershipUser, type ClientProfile, type CreateBanner, type CreateBranchEquipment, type CreateBranchRequest, type CreateBranchServicePriceItem, type CreateClassPayload, type CreateEquipment, type CreateInvoiceItem, type CreateInvoicePayload, type CreateInvoiceResponse, type CreateMembershipType, type CreatePackagePayload, type CreatePaymentMethod, type CreateRole, type CreateService, type CreateServiceImage, type DataResponse, type Equipment, type EquipmentCategory, type EquipmentInfo, type EquipmentStatus, type GetUserResponse, type GlobalStat, type Instructor, type InstructorData, type InstructorDataList, type InstructorsSummary, type InvoiceDetail, type InvoiceItemDetail, type InvoiceList, type InvoicePaymentDetail, type LoginRequest, type LoginResponse, type MembershipType, type MembershipTypeDetail, type MembershipsSummary, type Oauth, type OperatingHour, type PackageDetail, type PackageItemDetail, type PackageItemInput, type PackageListItem, type PackagePublicItem, type PaginatedBranch, type PaginatedEquipmentRequest, type PaginatedInstructor, type PaginatedServiceRequest, type PaginatedTotal, type Pagination, type PaginationBranchRequest, type PaginationRequest, type PaginationWithStatus, type PagoMovilConfig, type PaymentConfiguration, type PaymentDetail, type PaymentMethod, type PaymentMethodTypes, type Permission, type PublicMembershipResponse, type PublicPaginatedPackage, type PublicPaginationService, type QrToken, type Role, type RoleResponse, type ServiceCategoryInfo, type ServiceFullDetail, type ServiceImageResponse, type ServicePublicItem, type ServicesSummary, type SignUpRequest, type Specialty, type TopBranch, type UUIDModel, type UpdateBanner, type UpdateBranchEquipmentDetails, type UpdateBranchPaymentMethod, type UpdateBranchRequest, type UpdateBranchServicePrice, type UpdateClassPayload, type UpdateClientMembershipRequest, type UpdateEquipment, type UpdateMembershipType, type UpdateOperatingHour, type UpdatePackagePayload, type UpdateServiceImageManual, type UpdateServiceManual, type UpdateUserRequest, type UpdateUserStaffRequest, type User, type UserApiResponse, UserGender, type UserPaginationOptions, VitalFit, type ZelleConfig, isAPIError, mainCurrencies };

package/dist/index.js

@@ -1214,6 +1214,7 @@ var BillingService = class {
     this.getPaymentByID = this.getPaymentByID.bind(this);
     this.updatePaymentStatus = this.updatePaymentStatus.bind(this);
     this.getClientInvoices = this.getClientInvoices.bind(this);
+    this.getInvoices = this.getInvoices.bind(this);
   }
   async createInvoice(data, jwt) {
     const response = await this.client.post({
@@ -1267,6 +1268,26 @@ var BillingService = class {
     });
     return response;
   }
+  async getInvoices(jwt, {
+    page = 1,
+    limit = 10,
+    sort = "desc",
+    search,
+    status
+  }) {
+    const response = await this.client.get({
+      url: "/billing/invoices",
+      jwt,
+      params: {
+        page,
+        limit,
+        sort,
+        search,
+        status
+      }
+    });
+    return response;
+  }
 };
 
 // src/services/booking.ts
@@ -1325,6 +1346,106 @@ var AccessService = class {
   }
 };
 
+// src/services/reports.ts
+var ReportService = class {
+  client;
+  constructor(client) {
+    this.client = client;
+    this.mostUsedServices = this.mostUsedServices.bind(this);
+    this.salesByCategory = this.salesByCategory.bind(this);
+    this.salesByHour = this.salesByHour.bind(this);
+    this.salesByPaymentMethod = this.salesByPaymentMethod.bind(this);
+    this.topInstructors = this.topInstructors.bind(this);
+    this.topBranches = this.topBranches.bind(this);
+    this.globalStats = this.globalStats.bind(this);
+    this.totalActiveBranches = this.totalActiveBranches.bind(this);
+    this.totalClients = this.totalClients.bind(this);
+  }
+  async mostUsedServices(jwt, start, end) {
+    const response = await this.client.get({
+      url: "/reports/charts/most-used-services",
+      jwt,
+      params: {
+        start,
+        end
+      }
+    });
+    return response;
+  }
+  async salesByCategory(jwt, start, end) {
+    const response = await this.client.get({
+      url: "/reports/charts/sales-by-category",
+      jwt,
+      params: {
+        start,
+        end
+      }
+    });
+    return response;
+  }
+  async salesByHour(jwt, start, end) {
+    const response = await this.client.get({
+      url: "/reports/charts/sales-by-hour",
+      jwt,
+      params: {
+        start,
+        end
+      }
+    });
+    return response;
+  }
+  async salesByPaymentMethod(jwt, start, end) {
+    const response = await this.client.get({
+      url: "/reports/charts/sales-by-payment-method",
+      jwt,
+      params: {
+        start,
+        end
+      }
+    });
+    return response;
+  }
+  async topInstructors(jwt, start, end) {
+    const response = await this.client.get({
+      url: "/reports/charts/sales-by-payment-method",
+      jwt,
+      params: {
+        start,
+        end
+      }
+    });
+    return response;
+  }
+  async topBranches(jwt) {
+    const response = await this.client.get({
+      url: "/reports/stats/top-branches",
+      jwt
+    });
+    return response;
+  }
+  async globalStats(jwt) {
+    const response = await this.client.get({
+      url: "/reports/stats/global",
+      jwt
+    });
+    return response;
+  }
+  async totalActiveBranches(jwt) {
+    const response = await this.client.get({
+      url: "/reports/stats/total-active-branches",
+      jwt
+    });
+    return response;
+  }
+  async totalClients(jwt) {
+    const response = await this.client.get({
+      url: "/reports/stats/total-clients",
+      jwt
+    });
+    return response;
+  }
+};
+
 // src/types/auth.ts
 var UserGender = /* @__PURE__ */ ((UserGender2) => {
   UserGender2["male"] = "male";
@@ -1445,6 +1566,7 @@ var VitalFit = class _VitalFit {
   billing;
   booking;
   access;
+  report;
   constructor(isDevMode, origin) {
     this.client = new Client(isDevMode, origin);
     this.auth = new AuthService(this.client);
@@ -1463,6 +1585,7 @@ var VitalFit = class _VitalFit {
     this.billing = new BillingService(this.client);
     this.booking = new BookingService(this.client);
     this.access = new AccessService(this.client);
+    this.report = new ReportService(this.client);
   }
   static getInstance(isDevMode = false) {
     if (!_VitalFit.instance) {
@@ -1471,7 +1594,7 @@ var VitalFit = class _VitalFit {
     return _VitalFit.instance;
   }
   version() {
-    return "0.0.76";
+    return "0.0.77";
   }
 };
 export {