@gymspace/sdk 1.2.15 → 1.2.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +439 -26
- package/dist/index.d.ts +439 -26
- package/dist/index.js +656 -88
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +634 -83
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +26 -4
- package/src/models/bulk-messaging.ts +1 -9
- package/src/models/clients.ts +13 -0
- package/src/models/commissions.ts +336 -0
- package/src/models/contracts.ts +1 -19
- package/src/models/index.ts +1 -0
- package/src/resources/commission-calculations.ts +93 -0
- package/src/resources/commission-config.ts +66 -0
- package/src/resources/commission-promotions.ts +76 -0
- package/src/resources/commission-reports.ts +69 -0
- package/src/resources/commission-rules.ts +99 -0
- package/src/resources/index.ts +5 -0
- package/src/sdk.ts +15 -0
- package/dist/.tsbuildinfo +0 -1
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { AxiosRequestConfig } from 'axios';
|
|
2
|
-
import { PaginationParams as PaginationParams$1, ListCollaboratorsParams, Collaborator, UpdateCollaboratorDto, UpdateCollaboratorRoleDto, UpdateCollaboratorStatusDto, ActivityQueryParams, ActivityItem, StatsQueryParams, CollaboratorStats, Role, ContractStatus, CreateInvitationDto, Invitation, ValidateByCodeDto, AcceptInvitationDto } from '@gymspace/shared';
|
|
2
|
+
import { PaginationParams as PaginationParams$1, ListCollaboratorsParams, Collaborator, UpdateCollaboratorDto, UpdateCollaboratorRoleDto, UpdateCollaboratorStatusDto, ActivityQueryParams, ActivityItem, StatsQueryParams, CollaboratorStats, Role, ContractStatus, CancellationReason, SuspensionType, CreateInvitationDto, Invitation, ValidateByCodeDto, AcceptInvitationDto, BulkMessageVariable } from '@gymspace/shared';
|
|
3
3
|
export * from '@gymspace/shared';
|
|
4
|
+
export { BulkMessageVariable } from '@gymspace/shared';
|
|
4
5
|
|
|
5
6
|
interface GymSpaceConfig {
|
|
6
7
|
baseURL: string;
|
|
@@ -658,6 +659,13 @@ declare class RolesResource extends BaseResource {
|
|
|
658
659
|
getAvailablePermissions(options?: RequestOptions): Promise<PermissionsGroup>;
|
|
659
660
|
}
|
|
660
661
|
|
|
662
|
+
interface ClientTag {
|
|
663
|
+
tag: {
|
|
664
|
+
id: string;
|
|
665
|
+
name: string;
|
|
666
|
+
color: string;
|
|
667
|
+
};
|
|
668
|
+
}
|
|
661
669
|
interface CreateClientDto {
|
|
662
670
|
name: string;
|
|
663
671
|
email?: string;
|
|
@@ -736,6 +744,7 @@ interface Client {
|
|
|
736
744
|
name: string;
|
|
737
745
|
};
|
|
738
746
|
}>;
|
|
747
|
+
clientTags?: ClientTag[];
|
|
739
748
|
_count?: {
|
|
740
749
|
evaluations: number;
|
|
741
750
|
checkIns: number;
|
|
@@ -790,6 +799,9 @@ interface SearchClientsParams {
|
|
|
790
799
|
includeContractStatus?: boolean;
|
|
791
800
|
notCheckedInToday?: boolean;
|
|
792
801
|
checkedInToday?: boolean;
|
|
802
|
+
tagIds?: string[];
|
|
803
|
+
tagOperator?: 'and' | 'or';
|
|
804
|
+
includeTags?: boolean;
|
|
793
805
|
}
|
|
794
806
|
|
|
795
807
|
declare class ClientsResource extends BaseResource {
|
|
@@ -884,21 +896,6 @@ declare class MembershipPlansResource extends BaseResource {
|
|
|
884
896
|
getMembershipPlanStats(id: string, options?: RequestOptions): Promise<MembershipPlanStats>;
|
|
885
897
|
}
|
|
886
898
|
|
|
887
|
-
declare enum CancellationReason {
|
|
888
|
-
PRICE_TOO_HIGH = "PRICE_TOO_HIGH",
|
|
889
|
-
NOT_USING_SERVICE = "NOT_USING_SERVICE",
|
|
890
|
-
MOVING_LOCATION = "MOVING_LOCATION",
|
|
891
|
-
FINANCIAL_ISSUES = "FINANCIAL_ISSUES",
|
|
892
|
-
SERVICE_DISSATISFACTION = "SERVICE_DISSATISFACTION",
|
|
893
|
-
TEMPORARY_BREAK = "TEMPORARY_BREAK",
|
|
894
|
-
OTHER = "OTHER"
|
|
895
|
-
}
|
|
896
|
-
declare enum SuspensionType {
|
|
897
|
-
VACATION = "vacation",
|
|
898
|
-
MEDICAL = "medical",
|
|
899
|
-
FINANCIAL = "financial",
|
|
900
|
-
OTHER = "other"
|
|
901
|
-
}
|
|
902
899
|
interface CreateContractDto {
|
|
903
900
|
gymClientId: string;
|
|
904
901
|
gymMembershipPlanId: string;
|
|
@@ -2579,15 +2576,7 @@ interface UpdateBulkTemplateDto {
|
|
|
2579
2576
|
tags?: string[];
|
|
2580
2577
|
isActive?: boolean;
|
|
2581
2578
|
}
|
|
2582
|
-
|
|
2583
|
-
name: string;
|
|
2584
|
-
placeholder: string;
|
|
2585
|
-
description: string;
|
|
2586
|
-
example: string;
|
|
2587
|
-
category: 'client' | 'gym' | 'membership' | 'datetime' | 'custom';
|
|
2588
|
-
required: boolean;
|
|
2589
|
-
formatter?: 'text' | 'currency' | 'date' | 'number';
|
|
2590
|
-
}
|
|
2579
|
+
|
|
2591
2580
|
interface SendBulkMessagesDto {
|
|
2592
2581
|
templateId?: string;
|
|
2593
2582
|
message: string;
|
|
@@ -3017,6 +3006,425 @@ declare class TagsResource extends BaseResource {
|
|
|
3017
3006
|
getClientTags(clientId: string, options?: RequestOptions): Promise<ClientTagsResponse>;
|
|
3018
3007
|
}
|
|
3019
3008
|
|
|
3009
|
+
declare enum CommissionRuleType {
|
|
3010
|
+
PLAN = "PLAN",
|
|
3011
|
+
AMOUNT = "AMOUNT",
|
|
3012
|
+
PROMOTION = "PROMOTION"
|
|
3013
|
+
}
|
|
3014
|
+
declare enum CommissionStatus {
|
|
3015
|
+
PENDING = "PENDING",
|
|
3016
|
+
CONFIRMED = "CONFIRMED",
|
|
3017
|
+
PAID = "PAID",
|
|
3018
|
+
REVERSED = "REVERSED"
|
|
3019
|
+
}
|
|
3020
|
+
declare enum CommissionChangeType {
|
|
3021
|
+
CREATED = "CREATED",
|
|
3022
|
+
UPDATED = "UPDATED",
|
|
3023
|
+
DELETED = "DELETED"
|
|
3024
|
+
}
|
|
3025
|
+
declare enum CommissionEntityType {
|
|
3026
|
+
CONFIG = "CONFIG",
|
|
3027
|
+
RULE = "RULE"
|
|
3028
|
+
}
|
|
3029
|
+
interface RuleCriteria {
|
|
3030
|
+
planId?: string;
|
|
3031
|
+
minAmount?: number;
|
|
3032
|
+
maxAmount?: number;
|
|
3033
|
+
planIds?: string[];
|
|
3034
|
+
}
|
|
3035
|
+
interface CommissionConfigDto {
|
|
3036
|
+
id: string;
|
|
3037
|
+
gymId: string;
|
|
3038
|
+
defaultPercentage: number;
|
|
3039
|
+
reversalPeriodDays: number;
|
|
3040
|
+
minimumContractDays: number;
|
|
3041
|
+
isActive: boolean;
|
|
3042
|
+
createdAt: string;
|
|
3043
|
+
updatedAt: string;
|
|
3044
|
+
}
|
|
3045
|
+
interface CreateCommissionConfigDto {
|
|
3046
|
+
defaultPercentage: number;
|
|
3047
|
+
reversalPeriodDays: number;
|
|
3048
|
+
minimumContractDays: number;
|
|
3049
|
+
isActive: boolean;
|
|
3050
|
+
}
|
|
3051
|
+
interface UpdateCommissionConfigDto {
|
|
3052
|
+
defaultPercentage?: number;
|
|
3053
|
+
reversalPeriodDays?: number;
|
|
3054
|
+
minimumContractDays?: number;
|
|
3055
|
+
isActive?: boolean;
|
|
3056
|
+
}
|
|
3057
|
+
interface CommissionRuleDto {
|
|
3058
|
+
id: string;
|
|
3059
|
+
gymId: string;
|
|
3060
|
+
name: string;
|
|
3061
|
+
type: CommissionRuleType;
|
|
3062
|
+
percentage: number;
|
|
3063
|
+
priority: number;
|
|
3064
|
+
criteria: RuleCriteria;
|
|
3065
|
+
startDate?: string;
|
|
3066
|
+
endDate?: string;
|
|
3067
|
+
description?: string;
|
|
3068
|
+
isActive: boolean;
|
|
3069
|
+
createdAt: string;
|
|
3070
|
+
updatedAt: string;
|
|
3071
|
+
usageCount: number;
|
|
3072
|
+
}
|
|
3073
|
+
interface CreateCommissionRuleDto {
|
|
3074
|
+
name: string;
|
|
3075
|
+
type: CommissionRuleType;
|
|
3076
|
+
percentage: number;
|
|
3077
|
+
criteria: RuleCriteria;
|
|
3078
|
+
startDate?: string;
|
|
3079
|
+
endDate?: string;
|
|
3080
|
+
description?: string;
|
|
3081
|
+
}
|
|
3082
|
+
interface UpdateCommissionRuleDto {
|
|
3083
|
+
name?: string;
|
|
3084
|
+
percentage?: number;
|
|
3085
|
+
criteria?: RuleCriteria;
|
|
3086
|
+
startDate?: string;
|
|
3087
|
+
endDate?: string;
|
|
3088
|
+
description?: string;
|
|
3089
|
+
isActive?: boolean;
|
|
3090
|
+
}
|
|
3091
|
+
interface ReorderCommissionRulesDto {
|
|
3092
|
+
ruleIds: string[];
|
|
3093
|
+
}
|
|
3094
|
+
interface CommissionRuleFiltersDto {
|
|
3095
|
+
type?: CommissionRuleType;
|
|
3096
|
+
isActive?: boolean;
|
|
3097
|
+
search?: string;
|
|
3098
|
+
page: number;
|
|
3099
|
+
limit: number;
|
|
3100
|
+
}
|
|
3101
|
+
interface CommissionCalculationDto {
|
|
3102
|
+
id: string;
|
|
3103
|
+
gymId: string;
|
|
3104
|
+
contractId: string;
|
|
3105
|
+
collaboratorId: string;
|
|
3106
|
+
ruleId: string | null;
|
|
3107
|
+
percentage: number;
|
|
3108
|
+
baseAmount: number;
|
|
3109
|
+
amount: number;
|
|
3110
|
+
status: CommissionStatus;
|
|
3111
|
+
saleDate: string;
|
|
3112
|
+
createdAt: string;
|
|
3113
|
+
updatedAt: string;
|
|
3114
|
+
}
|
|
3115
|
+
interface CommissionFiltersDto {
|
|
3116
|
+
status?: CommissionStatus;
|
|
3117
|
+
collaboratorId?: string;
|
|
3118
|
+
startDate?: string;
|
|
3119
|
+
endDate?: string;
|
|
3120
|
+
page: number;
|
|
3121
|
+
limit: number;
|
|
3122
|
+
}
|
|
3123
|
+
interface CommissionSummaryDto {
|
|
3124
|
+
period: {
|
|
3125
|
+
start: string;
|
|
3126
|
+
end: string;
|
|
3127
|
+
};
|
|
3128
|
+
totals: {
|
|
3129
|
+
totalCommissions: number;
|
|
3130
|
+
totalContracts: number;
|
|
3131
|
+
averageCommission: number;
|
|
3132
|
+
totalPaid: number;
|
|
3133
|
+
totalPending: number;
|
|
3134
|
+
};
|
|
3135
|
+
byStatus: {
|
|
3136
|
+
status: CommissionStatus;
|
|
3137
|
+
count: number;
|
|
3138
|
+
total: number;
|
|
3139
|
+
}[];
|
|
3140
|
+
}
|
|
3141
|
+
interface SimulateCommissionDto {
|
|
3142
|
+
collaboratorId: string;
|
|
3143
|
+
planId: string;
|
|
3144
|
+
baseAmount: number;
|
|
3145
|
+
saleDate: string;
|
|
3146
|
+
}
|
|
3147
|
+
interface CommissionSimulationDto {
|
|
3148
|
+
percentage: number;
|
|
3149
|
+
baseAmount: number;
|
|
3150
|
+
amount: number;
|
|
3151
|
+
appliedRule: {
|
|
3152
|
+
id: string;
|
|
3153
|
+
name: string;
|
|
3154
|
+
type: CommissionRuleType;
|
|
3155
|
+
percentage: number;
|
|
3156
|
+
} | null;
|
|
3157
|
+
isDefault: boolean;
|
|
3158
|
+
}
|
|
3159
|
+
interface CommissionComparisonDto {
|
|
3160
|
+
scenarios: CommissionSimulationDto[];
|
|
3161
|
+
bestScenario: {
|
|
3162
|
+
index: number;
|
|
3163
|
+
amount: number;
|
|
3164
|
+
difference: number;
|
|
3165
|
+
};
|
|
3166
|
+
}
|
|
3167
|
+
interface ReportFiltersDto {
|
|
3168
|
+
startDate?: string;
|
|
3169
|
+
endDate?: string;
|
|
3170
|
+
period?: 'week' | 'month' | 'quarter' | 'year';
|
|
3171
|
+
ruleId?: string;
|
|
3172
|
+
collaboratorId?: string;
|
|
3173
|
+
limit?: number;
|
|
3174
|
+
offset?: number;
|
|
3175
|
+
}
|
|
3176
|
+
interface CommissionSummaryReportDto {
|
|
3177
|
+
period: {
|
|
3178
|
+
start: string;
|
|
3179
|
+
end: string;
|
|
3180
|
+
};
|
|
3181
|
+
totals: {
|
|
3182
|
+
totalCommissions: number;
|
|
3183
|
+
totalContracts: number;
|
|
3184
|
+
averageCommission: number;
|
|
3185
|
+
totalPaid: number;
|
|
3186
|
+
totalPending: number;
|
|
3187
|
+
};
|
|
3188
|
+
byStatus: {
|
|
3189
|
+
status: string;
|
|
3190
|
+
count: number;
|
|
3191
|
+
total: number;
|
|
3192
|
+
}[];
|
|
3193
|
+
byRule: {
|
|
3194
|
+
ruleId: string;
|
|
3195
|
+
ruleName: string;
|
|
3196
|
+
ruleType: string;
|
|
3197
|
+
contractsCount: number;
|
|
3198
|
+
totalCommissions: number;
|
|
3199
|
+
averageCommission: number;
|
|
3200
|
+
}[];
|
|
3201
|
+
byCollaborator: {
|
|
3202
|
+
collaboratorId: string;
|
|
3203
|
+
collaboratorName: string;
|
|
3204
|
+
contractsCount: number;
|
|
3205
|
+
totalCommissions: number;
|
|
3206
|
+
averageCommission: number;
|
|
3207
|
+
}[];
|
|
3208
|
+
trend: {
|
|
3209
|
+
date: string;
|
|
3210
|
+
commissions: number;
|
|
3211
|
+
contracts: number;
|
|
3212
|
+
}[];
|
|
3213
|
+
}
|
|
3214
|
+
interface RuleReportDto {
|
|
3215
|
+
ruleId: string;
|
|
3216
|
+
ruleName: string;
|
|
3217
|
+
ruleType: string;
|
|
3218
|
+
percentage: number;
|
|
3219
|
+
contractsCount: number;
|
|
3220
|
+
totalCommissions: number;
|
|
3221
|
+
averageCommission: number;
|
|
3222
|
+
minCommission: number;
|
|
3223
|
+
maxCommission: number;
|
|
3224
|
+
effectiveness: {
|
|
3225
|
+
usageRate: number;
|
|
3226
|
+
conversionImpact: number;
|
|
3227
|
+
roi: number;
|
|
3228
|
+
};
|
|
3229
|
+
}
|
|
3230
|
+
interface CollaboratorReportDto {
|
|
3231
|
+
collaboratorId: string;
|
|
3232
|
+
collaboratorName: string;
|
|
3233
|
+
roleName: string;
|
|
3234
|
+
contractsCount: number;
|
|
3235
|
+
totalCommissions: number;
|
|
3236
|
+
averageCommission: number;
|
|
3237
|
+
totalPaid: number;
|
|
3238
|
+
totalPending: number;
|
|
3239
|
+
performance: {
|
|
3240
|
+
rank: number;
|
|
3241
|
+
percentile: number;
|
|
3242
|
+
comparisonWithAverage: number;
|
|
3243
|
+
};
|
|
3244
|
+
rulesUsed: {
|
|
3245
|
+
ruleId: string;
|
|
3246
|
+
ruleName: string;
|
|
3247
|
+
count: number;
|
|
3248
|
+
total: number;
|
|
3249
|
+
}[];
|
|
3250
|
+
}
|
|
3251
|
+
interface PromotionReportFiltersDto {
|
|
3252
|
+
promotionId?: string;
|
|
3253
|
+
status?: 'active' | 'scheduled' | 'expired';
|
|
3254
|
+
startDate?: string;
|
|
3255
|
+
endDate?: string;
|
|
3256
|
+
}
|
|
3257
|
+
interface PromotionReportDto {
|
|
3258
|
+
promotionId: string;
|
|
3259
|
+
promotionName: string;
|
|
3260
|
+
percentage: number;
|
|
3261
|
+
startDate: string;
|
|
3262
|
+
endDate: string;
|
|
3263
|
+
status: string;
|
|
3264
|
+
impact: {
|
|
3265
|
+
contractsCreated: number;
|
|
3266
|
+
totalCommissions: number;
|
|
3267
|
+
averageCommission: number;
|
|
3268
|
+
comparisonWithNormal: {
|
|
3269
|
+
normalCommissions: number;
|
|
3270
|
+
promotionalCommissions: number;
|
|
3271
|
+
additionalCost: number;
|
|
3272
|
+
percentageIncrease: number;
|
|
3273
|
+
};
|
|
3274
|
+
salesIncrease: {
|
|
3275
|
+
contractsBeforePromotion: number;
|
|
3276
|
+
contractsDuringPromotion: number;
|
|
3277
|
+
percentageIncrease: number;
|
|
3278
|
+
};
|
|
3279
|
+
roi: {
|
|
3280
|
+
additionalRevenue: number;
|
|
3281
|
+
additionalCost: number;
|
|
3282
|
+
netBenefit: number;
|
|
3283
|
+
roiPercentage: number;
|
|
3284
|
+
};
|
|
3285
|
+
};
|
|
3286
|
+
}
|
|
3287
|
+
interface CommissionHistoryFiltersDto {
|
|
3288
|
+
entityType?: CommissionEntityType;
|
|
3289
|
+
changeType?: CommissionChangeType;
|
|
3290
|
+
startDate?: string;
|
|
3291
|
+
endDate?: string;
|
|
3292
|
+
page: number;
|
|
3293
|
+
limit: number;
|
|
3294
|
+
}
|
|
3295
|
+
interface CommissionHistoryDto {
|
|
3296
|
+
id: string;
|
|
3297
|
+
configId: string | null;
|
|
3298
|
+
ruleId: string | null;
|
|
3299
|
+
changeType: CommissionChangeType;
|
|
3300
|
+
entityType: CommissionEntityType;
|
|
3301
|
+
previousValue: any;
|
|
3302
|
+
newValue: any;
|
|
3303
|
+
changedBy: {
|
|
3304
|
+
id: string;
|
|
3305
|
+
name: string;
|
|
3306
|
+
email: string;
|
|
3307
|
+
};
|
|
3308
|
+
changedAt: string;
|
|
3309
|
+
reason: string | null;
|
|
3310
|
+
impact: string | null;
|
|
3311
|
+
}
|
|
3312
|
+
interface PaginatedCommissionResult<T> {
|
|
3313
|
+
items: T[];
|
|
3314
|
+
total: number;
|
|
3315
|
+
limit: number;
|
|
3316
|
+
offset: number;
|
|
3317
|
+
}
|
|
3318
|
+
|
|
3319
|
+
declare class CommissionConfigResource extends BaseResource {
|
|
3320
|
+
private basePath;
|
|
3321
|
+
createConfig(data: CreateCommissionConfigDto, options?: RequestOptions): Promise<CommissionConfigDto>;
|
|
3322
|
+
getActiveConfig(options?: RequestOptions): Promise<CommissionConfigDto>;
|
|
3323
|
+
getConfig(id: string, options?: RequestOptions): Promise<CommissionConfigDto>;
|
|
3324
|
+
listConfigs(params?: {
|
|
3325
|
+
page: number;
|
|
3326
|
+
limit: number;
|
|
3327
|
+
}, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionConfigDto>>;
|
|
3328
|
+
updateConfig(id: string, data: UpdateCommissionConfigDto, options?: RequestOptions): Promise<CommissionConfigDto>;
|
|
3329
|
+
deactivateConfig(id: string, options?: RequestOptions): Promise<CommissionConfigDto>;
|
|
3330
|
+
getConfigHistory(id: string, params?: CommissionHistoryFiltersDto, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionHistoryDto>>;
|
|
3331
|
+
validateConfig(data: CreateCommissionConfigDto, options?: RequestOptions): Promise<{
|
|
3332
|
+
valid: boolean;
|
|
3333
|
+
errors?: string[];
|
|
3334
|
+
}>;
|
|
3335
|
+
}
|
|
3336
|
+
|
|
3337
|
+
declare class CommissionRulesResource extends BaseResource {
|
|
3338
|
+
private basePath;
|
|
3339
|
+
createRule(data: CreateCommissionRuleDto, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3340
|
+
getRule(id: string, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3341
|
+
listRules(params?: CommissionRuleFiltersDto, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionRuleDto>>;
|
|
3342
|
+
updateRule(id: string, data: UpdateCommissionRuleDto, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3343
|
+
deleteRule(id: string, options?: RequestOptions): Promise<{
|
|
3344
|
+
success: boolean;
|
|
3345
|
+
}>;
|
|
3346
|
+
activateRule(id: string, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3347
|
+
deactivateRule(id: string, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3348
|
+
getRuleHistory(id: string, params?: CommissionHistoryFiltersDto, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionHistoryDto>>;
|
|
3349
|
+
validateRule(data: CreateCommissionRuleDto, options?: RequestOptions): Promise<{
|
|
3350
|
+
valid: boolean;
|
|
3351
|
+
errors?: string[];
|
|
3352
|
+
conflicts?: CommissionRuleDto[];
|
|
3353
|
+
}>;
|
|
3354
|
+
getMyRules(options?: RequestOptions): Promise<CommissionRuleDto[]>;
|
|
3355
|
+
getApplicableRule(params: {
|
|
3356
|
+
collaboratorId: string;
|
|
3357
|
+
planId?: string;
|
|
3358
|
+
amount?: number;
|
|
3359
|
+
promotionId?: string;
|
|
3360
|
+
}, options?: RequestOptions): Promise<CommissionRuleDto | null>;
|
|
3361
|
+
reorderRules(data: ReorderCommissionRulesDto, options?: RequestOptions): Promise<CommissionRuleDto[]>;
|
|
3362
|
+
}
|
|
3363
|
+
|
|
3364
|
+
declare class CommissionCalculationsResource extends BaseResource {
|
|
3365
|
+
private basePath;
|
|
3366
|
+
createCalculation(data: {
|
|
3367
|
+
contractId: string;
|
|
3368
|
+
collaboratorId: string;
|
|
3369
|
+
}, options?: RequestOptions): Promise<CommissionCalculationDto>;
|
|
3370
|
+
getCalculation(id: string, options?: RequestOptions): Promise<CommissionCalculationDto>;
|
|
3371
|
+
getCalculations(params?: CommissionFiltersDto, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionCalculationDto>>;
|
|
3372
|
+
getCollaboratorCalculations(collaboratorId: string, params?: CommissionFiltersDto, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionCalculationDto>>;
|
|
3373
|
+
confirmCalculation(id: string, data: {
|
|
3374
|
+
note?: string;
|
|
3375
|
+
}, options?: RequestOptions): Promise<CommissionCalculationDto>;
|
|
3376
|
+
reverseCalculation(id: string, data: {
|
|
3377
|
+
reason: string;
|
|
3378
|
+
}, options?: RequestOptions): Promise<CommissionCalculationDto>;
|
|
3379
|
+
markAsPaid(id: string, data: {
|
|
3380
|
+
paidDate: string;
|
|
3381
|
+
note?: string;
|
|
3382
|
+
}, options?: RequestOptions): Promise<CommissionCalculationDto>;
|
|
3383
|
+
simulate(data: SimulateCommissionDto, options?: RequestOptions): Promise<CommissionSimulationDto>;
|
|
3384
|
+
getMyCommissions(params?: CommissionFiltersDto, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionCalculationDto>>;
|
|
3385
|
+
getMyCommissionsSummary(options?: RequestOptions): Promise<CommissionSummaryDto>;
|
|
3386
|
+
}
|
|
3387
|
+
|
|
3388
|
+
declare class CommissionReportsResource extends BaseResource {
|
|
3389
|
+
private basePath;
|
|
3390
|
+
getSummary(params?: ReportFiltersDto, options?: RequestOptions): Promise<CommissionSummaryReportDto>;
|
|
3391
|
+
getByRule(params?: ReportFiltersDto, options?: RequestOptions): Promise<RuleReportDto[]>;
|
|
3392
|
+
getByCollaborator(params?: ReportFiltersDto, options?: RequestOptions): Promise<CollaboratorReportDto[]>;
|
|
3393
|
+
getPromotionAnalytics(params?: PromotionReportFiltersDto, options?: RequestOptions): Promise<PromotionReportDto[]>;
|
|
3394
|
+
exportToCSV(params?: ReportFiltersDto, options?: RequestOptions): Promise<Blob>;
|
|
3395
|
+
getTrends(params?: ReportFiltersDto, options?: RequestOptions): Promise<{
|
|
3396
|
+
date: string;
|
|
3397
|
+
commissions: number;
|
|
3398
|
+
contracts: number;
|
|
3399
|
+
}[]>;
|
|
3400
|
+
getTopPerformers(params?: ReportFiltersDto & {
|
|
3401
|
+
limit?: number;
|
|
3402
|
+
}, options?: RequestOptions): Promise<CollaboratorReportDto[]>;
|
|
3403
|
+
}
|
|
3404
|
+
|
|
3405
|
+
declare class CommissionPromotionsResource extends BaseResource {
|
|
3406
|
+
private basePath;
|
|
3407
|
+
createPromotion(data: CreateCommissionRuleDto, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3408
|
+
getPromotion(id: string, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3409
|
+
listPromotions(params?: CommissionRuleFiltersDto, options?: RequestOptions): Promise<PaginatedResponseDto<CommissionRuleDto>>;
|
|
3410
|
+
updatePromotion(id: string, data: UpdateCommissionRuleDto, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3411
|
+
deletePromotion(id: string, options?: RequestOptions): Promise<{
|
|
3412
|
+
success: boolean;
|
|
3413
|
+
}>;
|
|
3414
|
+
activatePromotion(id: string, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3415
|
+
deactivatePromotion(id: string, options?: RequestOptions): Promise<CommissionRuleDto>;
|
|
3416
|
+
validatePromotion(data: CreateCommissionRuleDto, options?: RequestOptions): Promise<{
|
|
3417
|
+
valid: boolean;
|
|
3418
|
+
errors?: string[];
|
|
3419
|
+
conflicts?: CommissionRuleDto[];
|
|
3420
|
+
}>;
|
|
3421
|
+
estimateImpact(id: string, options?: RequestOptions): Promise<{
|
|
3422
|
+
estimatedContracts: number;
|
|
3423
|
+
estimatedCommissions: number;
|
|
3424
|
+
estimatedCost: number;
|
|
3425
|
+
}>;
|
|
3426
|
+
}
|
|
3427
|
+
|
|
3020
3428
|
declare class GymSpaceSdk {
|
|
3021
3429
|
client: ApiClient;
|
|
3022
3430
|
private expoFetch?;
|
|
@@ -3049,6 +3457,11 @@ declare class GymSpaceSdk {
|
|
|
3049
3457
|
bulkMessaging: BulkMessagingResource;
|
|
3050
3458
|
activities: ActivitiesResource;
|
|
3051
3459
|
tags: TagsResource;
|
|
3460
|
+
commissionConfig: CommissionConfigResource;
|
|
3461
|
+
commissionRules: CommissionRulesResource;
|
|
3462
|
+
commissionCalculations: CommissionCalculationsResource;
|
|
3463
|
+
commissionReports: CommissionReportsResource;
|
|
3464
|
+
commissionPromotions: CommissionPromotionsResource;
|
|
3052
3465
|
constructor(config: GymSpaceConfig);
|
|
3053
3466
|
/**
|
|
3054
3467
|
* Set the authentication token
|
|
@@ -3118,4 +3531,4 @@ declare class NetworkError extends GymSpaceError {
|
|
|
3118
3531
|
constructor(message?: string);
|
|
3119
3532
|
}
|
|
3120
3533
|
|
|
3121
|
-
export { type ActivateRenewalDto, ActivitiesResource, type Activity, type ActivityNotification, type ActivityPlanRestriction, type ActivityStats, type ActivityStatsParams, AdminSubscriptionManagementResource, type AdminSubscriptionStatusDto, type AffiliateOrganizationDto, type Amenities, ApiClient, type ApiResponse, type AssetResponseDto, AssetsResource, type AssignTagsDto, type AssignTagsResponse, AuthResource, AuthenticationError, AuthorizationError, type AvailablePlanDto, type BulkLogsResponse, type BulkLogsResponseDto, type BulkMessageLog, type BulkMessageLogDto, type BulkMessageResult, type BulkMessageResultDto,
|
|
3534
|
+
export { type ActivateRenewalDto, ActivitiesResource, type Activity, type ActivityNotification, type ActivityPlanRestriction, type ActivityStats, type ActivityStatsParams, AdminSubscriptionManagementResource, type AdminSubscriptionStatusDto, type AffiliateOrganizationDto, type Amenities, ApiClient, type ApiResponse, type AssetResponseDto, AssetsResource, type AssignTagsDto, type AssignTagsResponse, AuthResource, AuthenticationError, AuthorizationError, type AvailablePlanDto, type BulkLogsResponse, type BulkLogsResponseDto, type BulkMessageLog, type BulkMessageLogDto, type BulkMessageResult, type BulkMessageResultDto, BulkMessagingResource, type BulkTemplate, type BusinessHours, type CancelContractDto, type CancelSubscriptionDto, type CancellationAnalytics, type CatalogGym, type ChangePasswordDto, type ChangePasswordResponseDto, type CheckIn, type CheckInDetail, type CheckInListResponse, type CheckInStats, type CheckInSystemFeatures, type CheckIns, type CheckInsList, CheckInsResource, type CheckLimitResponse, type CityWithGyms, type Client, type ClientCheckInHistory, type ClientManagementFeatures, type ClientStat, type ClientStats, type ClientTag, type ClientTagsResponse, ClientsResource, type CollaboratorReportDto, type CollaboratorRoleDto, CollaboratorsResource, type CommissionCalculationDto, CommissionCalculationsResource, CommissionChangeType, type CommissionComparisonDto, type CommissionConfigDto, CommissionConfigResource, CommissionEntityType, type CommissionFiltersDto, type CommissionHistoryDto, type CommissionHistoryFiltersDto, CommissionPromotionsResource, CommissionReportsResource, type CommissionRuleDto, type CommissionRuleFiltersDto, CommissionRuleType, CommissionRulesResource, type CommissionSimulationDto, CommissionStatus, type CommissionSummaryDto, type CommissionSummaryReportDto, type CompleteGuidedSetupData, type ConfigureFeaturesData, type ConnectionStatusResponse, type Contact, type Contract, type ContractLifecycleEvent, type ContractSettings, ContractsResource, type ContractsRevenue, type CreateActivityDto, type CreateActivityNotificationDto, type CreateBulkTemplateDto, type CreateCheckInDto, type CreateClientDto, type CreateCommissionConfigDto, type CreateCommissionRuleDto, type CreateContractDto, type CreateGymDto, type CreateMembershipPlanDto, type CreatePaymentMethodDto, type CreateProductCategoryDto, type CreateProductDto, type CreateSaleDto, type CreateServiceDto, type CreateSubscriptionPlanDto, type CreateSupplierDto, type CreateTagDto, type CreateTemplateDto, type CreateWhatsAppConfigDto, type CurrentSessionResponse, type CurrentlyInGymResponse, type CustomerSalesReport, DashboardResource, type DashboardStats, type DateRangeParams, type DaySchedule, type Debts, type DeleteActivityParams, type DeleteTagResponse, type DisconnectResponse, type EligibleClient, type EligibleClientsResponse, type ExpiringContract, type FileResponseDto, FilesResource, type FreezeContractDto, type GenerateAIMessageDto, type GenerateAIMessageParams, type GenerateAIMessageResponse, type GenerateAIMessageResponseDto, type GetBulkLogsQueryDto, type GetCheckInStatsParams, type GetClientCheckInHistoryParams, type GetContractsParams, type GetFeaturedGymsParams, type GetGymInvitationsParams, type GetMembershipPlansParams, type GetTagClientsParams, type Gym, type GymAmenities, type GymSchedule, type GymSettings, type GymSocialMedia, type GymSpaceConfig, GymSpaceError, GymSpaceSdk, type GymStats, GymsResource, HealthResource, type HealthResponse, type InitializeConnectionResponse, type InventorySettings, type InvitationValidationResponse, InvitationsResource, type ListContactsResponse, type LoginDto, type LoginResponseDto, type MembershipManagementFeatures, type MembershipPlan, type MembershipPlanStats, MembershipPlansResource, NetworkError, type NewClients, NotFoundError, type NotificationSettings, OnboardingResource, type OnboardingResponse, type OnboardingStatus, OnboardingStep, type Organization, type OrganizationAdminDetails, type OrganizationStats, type OrganizationWithDetails, OrganizationsResource, type PaginatedCommissionResult, type PaginatedResponse, type PaginatedResponseDto, type PaginationParams, type PaginationQueryDto, type PaySaleDto, type PaymentMethod, type PaymentMethodStats, PaymentMethodsResource, type PermissionsGroup, type PreviewTemplateResponse, type PriceDto, type PricingDto, type Product, type ProductCategory, ProductsResource, type PromotionReportDto, type PromotionReportFiltersDto, PublicCatalogResource, type ReactivateContractDto, type ReadyResponse, type RegisterCollaboratorDto, type RegisterOwnerDto, type RejectedClient, type RejectedClientDto, type RemoveTagsDto, type RemoveTagsResponse, type RenewContractDto, type ReorderCommissionRulesDto, type ReportFiltersDto, type RequestOptions, type RequestPasswordResetDto, type RequestPasswordResetResponseDto, type ResendResetCodeDto, type ResendResetCodeResponseDto, type ResendVerificationDto, type ResetPasswordDto, type ResetPasswordResponseDto, type ResumeContractDto, RolesResource, type RuleCriteria, type RuleReportDto, type Sale, type SaleItem, type SaleItemDto, SalesResource, type SalesRevenue, type SalesStats, type SearchActivitiesParams, type SearchCatalogParams, type SearchCheckInsParams, type SearchClientsParams, type SearchPaymentMethodsParams, type SearchProductsParams, type SearchSalesParams, type SearchSuppliersParams, type SearchTagsParams, type SearchTemplatesDto, type SearchWhatsAppMessagesDto, type SendBulkMessagesDto, type SendWhatsAppMessageDto, type SentActivityNotification, type SimulateCommissionDto, type SocialMedia, type StartOnboardingData, type StartOnboardingResponse, type StockMovement, type Subscription, type SubscriptionHistoryDto, type SubscriptionPlan, type SubscriptionPlanDto, SubscriptionPlansResource, type SubscriptionStatusDto, SubscriptionsResource, type Supplier, SuppliersResource, type SuppliersStats, type SuspendContractDto, type Tag, type TagClientsResponse, type TagStatsResponse, type TagWithAssignment, TagsResource, type TimeSlot, type TopSellingProduct, type UpdateActivityDto, type UpdateActivityNotificationDto, type UpdateBulkTemplateDto, type UpdateClientDto, type UpdateCommissionConfigDto, type UpdateCommissionRuleDto, type UpdateGymContractSettingsDto, type UpdateGymDto, type UpdateGymInventorySettingsDto, type UpdateGymScheduleDto, type UpdateGymSettingsData, type UpdateGymSocialMediaDto, type UpdateMembershipPlanDto, type UpdateOrganizationDto, type UpdatePaymentMethodDto, type UpdatePaymentStatusDto, type UpdateProductCategoryDto, type UpdateProductDto, type UpdateProfileDto, type UpdateSaleDto, type UpdateStockDto, type UpdateSubscriptionPlanDto, type UpdateSupplierDto, type UpdateTagDto, type UpdateTemplateDto, type UpdateWhatsAppConfigDto, type UpgradeSubscriptionDto, type UploadAssetDto, type UploadFileDto, type UserProfileDto, UsersResource, ValidationError, type VerifyEmailDto, type VerifyResetCodeDto, type VerifyResetCodeResponseDto, type WeeklySchedule, type WhatsAppConfig, type WhatsAppMessage, WhatsAppResource, type WhatsAppTemplate, WhatsAppTemplatesResource };
|