@vitalfit/sdk 0.3.7 → 0.3.9

package/dist/index.d.cts

@@ -1,8 +1,11 @@
+import { ResponseType } from 'axios';
+
 type ClientConfig = {
     url: string;
     jwt?: string;
     data?: object;
     params?: object;
+    responseType?: ResponseType;
 };
 declare class Client {
     private client;
@@ -24,6 +27,10 @@ declare class Client {
     put(config: ClientConfig): Promise<any>;
     patch(config: ClientConfig): Promise<any>;
     delete(config: ClientConfig): Promise<any>;
+    download(config: ClientConfig): Promise<{
+        blob: Blob;
+        filename?: string;
+    }>;
 }
 
 type PaginationRequest = {
@@ -100,6 +107,115 @@ type RenewTokenRequest = {
     refresh_token: string;
 };
 
+interface ServiceCategoryInfo {
+    category_id: string;
+    name: string;
+}
+interface ServiceImageResponse {
+    image_id: string;
+    image_url: string;
+    alt_text: string;
+    display_order: number;
+    is_primary: boolean;
+}
+interface BannerResponse {
+    banner_id: string;
+    name: string;
+    image_url: string;
+    link_url: string;
+    is_active: boolean;
+}
+interface ServiceFullDetail {
+    service_id: string;
+    category_id: string;
+    name: string;
+    description: string;
+    duration_minutes: number;
+    priority_score: number;
+    is_featured: boolean;
+    created_at: string;
+    updated_at: string;
+    service_category: ServiceCategoryInfo;
+    images: ServiceImageResponse[];
+    banners: BannerResponse[];
+}
+type CreateServiceImage = {
+    alt_text: string;
+    display_order: number;
+    image_url: string;
+    is_primary: boolean;
+};
+type CreateService = {
+    banner_id: string;
+    category_id: string;
+    description: string;
+    duration: number;
+    is_featured: boolean;
+    name: string;
+    priority: number;
+    service_images: CreateServiceImage[];
+};
+type UpdateServiceImageManual = {
+    alt_text?: string;
+    display_order?: number;
+    image_url?: string;
+    is_primary?: boolean;
+};
+type UpdateServiceManual = {
+    banner_id?: string;
+    category_id?: string;
+    description?: string;
+    duration?: number;
+    is_featured?: boolean;
+    name?: string;
+    priority?: number;
+    service_images?: UpdateServiceImageManual[];
+};
+type BranchServicePrice = {
+    branch_id: string;
+    service_id: string;
+    service_name: string;
+    is_visible: boolean;
+    max_capacity: number;
+    price_for_member: number;
+    price_for_non_member: number;
+};
+type CreateBranchServicePriceItem = {
+    service_id: string;
+    is_visible: boolean;
+    max_capacity: number;
+    price_for_member: number;
+    price_for_non_member: number;
+};
+type UpdateBranchServicePrice = {
+    is_visible?: boolean;
+    max_capacity?: number;
+    price_for_member?: number;
+    price_for_non_member?: number;
+};
+type PaginatedServiceRequest = PaginationRequest & {
+    category?: string;
+};
+type ServicesSummary = {
+    total: number;
+    actives: number;
+    featured: number;
+};
+type ServicePublicItem = ServiceFullDetail & {
+    lowest_price_member: number;
+    lowest_price_no_member: number;
+    base_currency: string;
+    ref_lowest_price_member: string;
+    ref_lowest_price_no_member: string;
+    ref_base_currency: string;
+};
+type PublicPaginationService = PaginationRequest & {
+    currency: string;
+    category: string;
+    price: number;
+    sortby: string;
+};
+
 type ClientProfile = {
     user_id: string;
     qr_code: string;
@@ -141,6 +257,8 @@ type User = {
     ClientProfile: ClientProfile;
     role_id: string;
     role: Role;
+    category?: string;
+    has_active_membership?: boolean;
     client_membership?: ClientMembership;
     created_at: string;
     updated_at: string;
@@ -194,6 +312,16 @@ type MedicalProfile = {
     medications: string;
     warnings: string;
 };
+type BlockUserRequest = {
+    block_justification: string;
+};
+type ClientBalance = {
+    user_id: string;
+    service_id: string;
+    balance: number;
+    updated_at: string;
+    service?: ServiceFullDetail;
+};
 
 type PaginatedBranch = {
     branch_id: string;
@@ -397,6 +525,14 @@ type InstructorsSummary = {
     actives: number;
     blocked: number;
 };
+type AssignedClientResponse = {
+    user_id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone: string;
+    total_bookings: number;
+};
 
 interface Permission {
     created_at?: string;
@@ -539,115 +675,6 @@ type BranchInfo = {
     phone: string;
 };
 
-interface ServiceCategoryInfo {
-    category_id: string;
-    name: string;
-}
-interface ServiceImageResponse {
-    image_id: string;
-    image_url: string;
-    alt_text: string;
-    display_order: number;
-    is_primary: boolean;
-}
-interface BannerResponse {
-    banner_id: string;
-    name: string;
-    image_url: string;
-    link_url: string;
-    is_active: boolean;
-}
-interface ServiceFullDetail {
-    service_id: string;
-    category_id: string;
-    name: string;
-    description: string;
-    duration_minutes: number;
-    priority_score: number;
-    is_featured: boolean;
-    created_at: string;
-    updated_at: string;
-    service_category: ServiceCategoryInfo;
-    images: ServiceImageResponse[];
-    banners: BannerResponse[];
-}
-type CreateServiceImage = {
-    alt_text: string;
-    display_order: number;
-    image_url: string;
-    is_primary: boolean;
-};
-type CreateService = {
-    banner_id: string;
-    category_id: string;
-    description: string;
-    duration: number;
-    is_featured: boolean;
-    name: string;
-    priority: number;
-    service_images: CreateServiceImage[];
-};
-type UpdateServiceImageManual = {
-    alt_text?: string;
-    display_order?: number;
-    image_url?: string;
-    is_primary?: boolean;
-};
-type UpdateServiceManual = {
-    banner_id?: string;
-    category_id?: string;
-    description?: string;
-    duration?: number;
-    is_featured?: boolean;
-    name?: string;
-    priority?: number;
-    service_images?: UpdateServiceImageManual[];
-};
-type BranchServicePrice = {
-    branch_id: string;
-    service_id: string;
-    service_name: string;
-    is_visible: boolean;
-    max_capacity: number;
-    price_for_member: number;
-    price_for_non_member: number;
-};
-type CreateBranchServicePriceItem = {
-    service_id: string;
-    is_visible: boolean;
-    max_capacity: number;
-    price_for_member: number;
-    price_for_non_member: number;
-};
-type UpdateBranchServicePrice = {
-    is_visible?: boolean;
-    max_capacity?: number;
-    price_for_member?: number;
-    price_for_non_member?: number;
-};
-type PaginatedServiceRequest = PaginationRequest & {
-    category?: string;
-};
-type ServicesSummary = {
-    total: number;
-    actives: number;
-    featured: number;
-};
-type ServicePublicItem = ServiceFullDetail & {
-    lowest_price_member: number;
-    lowest_price_no_member: number;
-    base_currency: string;
-    ref_lowest_price_member: string;
-    ref_lowest_price_no_member: string;
-    ref_base_currency: string;
-};
-type PublicPaginationService = PaginationRequest & {
-    currency: string;
-    category: string;
-    price: number;
-    sortby: string;
-};
-
 type EquipmentCategory = 'Cardio' | 'Strength' | 'FreeWeight' | 'Functional' | 'Accessory';
 type Equipment = {
     equipment_id: string;
@@ -943,7 +970,8 @@ type PaymentDetail = {
 
 type CheckIn = {
     branch_id: string;
-    qr_jwt: string;
+    qr_jwt?: string;
+    user_id?: string;
 };
 type CheckInResponse = {
     access_type: string;
@@ -1146,7 +1174,7 @@ declare class AuthService {
     revokeSessionByID(sessionId: string, jwt: string): Promise<void>;
     getUserSessions(jwt: string): Promise<DataResponse<UserSession[]>>;
     getUserSessionByID(userId: string, jwt: string): Promise<DataResponse<UserSession[]>>;
-    login({ email, password, context, }: LoginRequest): Promise<LoginResponse>;
+    login({ email, password, context, device_token, }: LoginRequest): Promise<LoginResponse>;
     logout(): void;
     saveJWT(jwt: string): void;
     saveTokens(access: string, refresh: string): void;
@@ -1175,6 +1203,7 @@ declare class UserService {
     QrToken(jwt: string): Promise<QrToken>;
     resendActivateOtp(email: string): Promise<void>;
     UpgradePassword(jwt: string, currentPassword: string, newPassword: string, confirmPassword: string): Promise<void>;
+    blockUser(userId: string, data: BlockUserRequest, jwt: string): Promise<void>;
     createMedicalProfile(userId: string, data: MedicalProfile, jwt: string): Promise<void>;
     getMedicalProfile(userId: string, jwt: string): Promise<DataResponse<MedicalProfile>>;
     updateMedicalProfile(userId: string, data: MedicalProfile, jwt: string): Promise<void>;
@@ -1217,6 +1246,7 @@ declare class InstructorService {
     deleteInstructor(instructorId: string, jwt: string): Promise<void>;
     addSpecialty(instructorId: string, specialty: Specialty[], jwt: string): Promise<void>;
     removeSpecialty(instructorId: string, specialtyId: string, jwt: string): Promise<void>;
+    getAssignedClients(instructorId: string, jwt: string, { page, limit, sort, search }?: PaginationRequest): Promise<PaginatedTotal<AssignedClientResponse[]>>;
     addBranchInstructor(branchId: string, instructorIDs: string[], jwt: string): Promise<void>;
     removeBranchInstructor(branchId: string, instructorId: string, jwt: string): Promise<void>;
     getBranchInstructors(branchId: string, { search, identity_doc }: PaginatedInstructor, jwt: string): Promise<DataResponse<BranchInstructorInfo[]>>;
@@ -1286,6 +1316,7 @@ declare class ProductsService {
     createService(data: CreateService, jwt: string): Promise<void>;
     getServices(jwt: string, { page, limit, sort, search, category, }: PaginatedServiceRequest): Promise<PaginatedTotal<ServiceFullDetail[]>>;
     getSummary(jwt: string): Promise<DataResponse<ServicesSummary>>;
+    getClientBalances(jwt: string, userId?: string): Promise<DataResponse<ClientBalance[]>>;
     getServiceByID(serviceId: string, jwt: string): Promise<DataResponse<ServiceFullDetail>>;
     updateService(serviceId: string, data: UpdateServiceManual, jwt: string): Promise<void>;
     deleteService(serviceId: string, jwt: string): Promise<void>;
@@ -1315,11 +1346,12 @@ declare class EquipmentService {
 declare class ScheduleService {
     private client;
     constructor(client: Client);
-    ListBranchesClass(branchID: string, jwt: string): Promise<DataResponse<BranchClassInfo[]>>;
+    ListBranchesClass(branchID: string, jwt: string, month?: number, year?: number): Promise<DataResponse<BranchClassInfo[]>>;
     CreateClass(branchID: string, data: CreateClassPayload, jwt: string): Promise<void>;
     GetClassByID(classID: string, jwt: string): Promise<DataResponse<BranchClassInfo>>;
     UpdateClass(classID: string, data: UpdateClassPayload, jwt: string): Promise<void>;
     DeleteClass(classID: string, jwt: string): Promise<void>;
+    GetClassesByInstructor(jwt: string, userId?: string, month?: number, year?: number): Promise<DataResponse<BranchClassInfo[]>>;
 }
 
 declare class PackagesService {
@@ -1366,8 +1398,10 @@ declare class AccessService {
     private client;
     constructor(client: Client);
     checkIn(jwt: string, data: CheckIn): Promise<CheckInResponse>;
+    checkInManual(jwt: string, data: CheckIn): Promise<CheckInResponse>;
     getClientAttendanceHistory(jwt: string, userId: string, start?: string, end?: string, { page, limit, sort }?: PaginationRequest): Promise<PaginatedTotal<AttendanceHistory[]>>;
     getClientServiceUsage(jwt: string, userId: string, start?: string, end?: string, { page, limit, sort }?: PaginationRequest): Promise<PaginatedTotal<ServiceUsage[]>>;
+    getClassAttendanceHistory(jwt: string, classId: string, start?: string, end?: string, status?: 'Attended' | 'NoShow' | 'Cancelled'): Promise<DataResponse<AttendanceHistory[]>>;
 }
 
 declare class ReportService {
@@ -1460,6 +1494,28 @@ declare class NotificationService {
     sendBroadcast(data: BroadcastRequest, jwt: string): Promise<void>;
 }
 
+type DownloadResponse = {
+    blob: Blob;
+    filename?: string;
+};
+declare class ExportsService {
+    private client;
+    constructor(client: Client);
+    exportFinancialReport(jwt: string, start?: string, end?: string, branchId?: string): Promise<DownloadResponse>;
+    exportClientsReport(jwt: string, start?: string, end?: string, branchId?: string): Promise<DownloadResponse>;
+    exportSalesReport(jwt: string, start?: string, end?: string, branchId?: string): Promise<DownloadResponse>;
+    exportClients(jwt: string): Promise<DownloadResponse>;
+    exportStaff(jwt: string): Promise<DownloadResponse>;
+    exportInstructors(jwt: string): Promise<DownloadResponse>;
+    exportEquipmentTypes(jwt: string): Promise<DownloadResponse>;
+    exportBranchEquipment(branchId: string, jwt: string): Promise<DownloadResponse>;
+    exportServices(jwt: string): Promise<DownloadResponse>;
+    exportBranchServices(branchId: string, jwt: string): Promise<DownloadResponse>;
+    exportMembershipPlans(jwt: string): Promise<DownloadResponse>;
+    exportPackages(jwt: string): Promise<DownloadResponse>;
+    exportPaymentMethods(jwt: string): Promise<DownloadResponse>;
+}
+
 declare class APIError extends Error {
     status: number;
     messages: string[];
@@ -1492,9 +1548,10 @@ declare class VitalFit {
     policy: PolicyService;
     audit: AuditService;
     notification: NotificationService;
+    exports: ExportsService;
     constructor(isDevMode: boolean, origin?: string);
     static getInstance(isDevMode?: boolean): VitalFit;
     version(): string;
 }
 
-export { APIError, type AddPaymentToInvoicePayload, type AddPaymentToInvoiceResponse, type AddToWishlistRequest, type AttendanceHistory, type AuditLog, type BankTransferConfig, type Banner, type BannerResponse, type BaseModel, type BillingMatrix, type BillingMatrixRow, type BookClassRequest, type BookingParticipant, type BranchClassInfo, type BranchDetails, type BranchEquipmentInventory, type BranchInfo, type BranchInstructorInfo, type BranchPaymentMethod, type BranchPaymentMethodInfo, type BranchPaymentVisibility, type BranchPerformance, type BranchScheduleResponse, type BranchServicePrice, type BranchStaff, type BranchStatusCount, type BroadcastRequest, type CancellationReason, type ChartData, type CheckIn, type CheckInResponse, type ClassBookingCount, type ClassCapacityStats, type ClassScheduleItem, type ClientBookingResponse, type ClientInvoice, type ClientMembership, type ClientMembershipDetail, type ClientMembershipItem, type ClientMembershipUser, type ClientProfile, type CohortRetention, type CreateBanner, type CreateBranchEquipment, type CreateBranchRequest, type CreateBranchServicePriceItem, type CreateCancellationReason, type CreateClassPayload, type CreateEquipment, type CreateFiscalDocumentRequest, type CreateInvoiceItem, type CreateInvoicePayload, type CreateInvoiceResponse, type CreateMembershipType, type CreatePackagePayload, type CreatePaymentMethod, type CreatePromotion, type CreateRole, type CreateService, type CreateServiceImage, type DataResponse, type Equipment, type EquipmentCategory, type EquipmentInfo, type EquipmentStatus, type ExchangeRateResponse, type FinancialSummary, type FinancialSummaryItem, type FiscalDocument, type GetUserResponse, type GlobalSalesStats, type GlobalStat, type HeatmapPoint, type Instructor, type InstructorData, type InstructorDataList, type InstructorsSummary, type InvoiceDetail, type InvoiceItemDetail, type InvoiceList, type InvoicePaymentDetail, type KPICard, type LoginRequest, type LoginResponse, type MedicalProfile, type MembershipType, type MembershipTypeDetail, type MembershipsSummary, type NotificationResponse, 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 Policy, type Promotion, type PublicMembershipResponse, type PublicPaginatedPackage, type PublicPaginationService, type QrToken, type RandomBanner, type RecentAttendanceItem, type RenewTokenRequest, type Role, type RoleResponse, type ServiceCategoryInfo, type ServiceFullDetail, type ServiceImageResponse, type ServicePublicItem, type ServiceUsage, type ServicesSummary, type SignUpRequest, type Specialty, type StackedChartData, type Staff, type TaxRate, type TopBranch, type TotalSalesStats, type UUIDModel, type UnreadCountResponse, 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, type UserSession, VitalFit, type WishlistItemResponse, type ZelleConfig, isAPIError, mainCurrencies, type updatePolicy };
+export { APIError, type AddPaymentToInvoicePayload, type AddPaymentToInvoiceResponse, type AddToWishlistRequest, type AssignedClientResponse, type AttendanceHistory, type AuditLog, type BankTransferConfig, type Banner, type BannerResponse, type BaseModel, type BillingMatrix, type BillingMatrixRow, type BlockUserRequest, type BookClassRequest, type BookingParticipant, type BranchClassInfo, type BranchDetails, type BranchEquipmentInventory, type BranchInfo, type BranchInstructorInfo, type BranchPaymentMethod, type BranchPaymentMethodInfo, type BranchPaymentVisibility, type BranchPerformance, type BranchScheduleResponse, type BranchServicePrice, type BranchStaff, type BranchStatusCount, type BroadcastRequest, type CancellationReason, type ChartData, type CheckIn, type CheckInResponse, type ClassBookingCount, type ClassCapacityStats, type ClassScheduleItem, type ClientBalance, type ClientBookingResponse, type ClientInvoice, type ClientMembership, type ClientMembershipDetail, type ClientMembershipItem, type ClientMembershipUser, type ClientProfile, type CohortRetention, type CreateBanner, type CreateBranchEquipment, type CreateBranchRequest, type CreateBranchServicePriceItem, type CreateCancellationReason, type CreateClassPayload, type CreateEquipment, type CreateFiscalDocumentRequest, type CreateInvoiceItem, type CreateInvoicePayload, type CreateInvoiceResponse, type CreateMembershipType, type CreatePackagePayload, type CreatePaymentMethod, type CreatePromotion, type CreateRole, type CreateService, type CreateServiceImage, type DataResponse, type Equipment, type EquipmentCategory, type EquipmentInfo, type EquipmentStatus, type ExchangeRateResponse, type FinancialSummary, type FinancialSummaryItem, type FiscalDocument, type GetUserResponse, type GlobalSalesStats, type GlobalStat, type HeatmapPoint, type Instructor, type InstructorData, type InstructorDataList, type InstructorsSummary, type InvoiceDetail, type InvoiceItemDetail, type InvoiceList, type InvoicePaymentDetail, type KPICard, type LoginRequest, type LoginResponse, type MedicalProfile, type MembershipType, type MembershipTypeDetail, type MembershipsSummary, type NotificationResponse, 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 Policy, type Promotion, type PublicMembershipResponse, type PublicPaginatedPackage, type PublicPaginationService, type QrToken, type RandomBanner, type RecentAttendanceItem, type RenewTokenRequest, type Role, type RoleResponse, type ServiceCategoryInfo, type ServiceFullDetail, type ServiceImageResponse, type ServicePublicItem, type ServiceUsage, type ServicesSummary, type SignUpRequest, type Specialty, type StackedChartData, type Staff, type TaxRate, type TopBranch, type TotalSalesStats, type UUIDModel, type UnreadCountResponse, 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, type UserSession, VitalFit, type WishlistItemResponse, type ZelleConfig, isAPIError, mainCurrencies, type updatePolicy };