@gymspace/shared 1.9.0 → 1.9.2
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 +101 -4
- package/dist/index.d.ts +101 -4
- package/dist/index.js +55 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +55 -3
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/constants/template-codes.constants.ts +40 -0
- package/src/constants.ts +3 -0
- package/src/enums.ts +8 -0
- package/src/interfaces.ts +18 -0
- package/src/types/whatsapp-templates.types.ts +48 -2
package/dist/index.d.mts
CHANGED
|
@@ -13,6 +13,8 @@ declare const TEMPLATE_CODES: {
|
|
|
13
13
|
readonly PAYMENT_RECEIPT: "PAYMENT_RECEIPT";
|
|
14
14
|
readonly SHARE_CATALOG: "SHARE_CATALOG";
|
|
15
15
|
readonly SALE_PAYMENT_REMINDER: "SALE_PAYMENT_REMINDER";
|
|
16
|
+
readonly MEMBER_INVITE: "MEMBER_INVITE";
|
|
17
|
+
readonly CONTRACT_INSTALLMENT_REMINDER: "CONTRACT_INSTALLMENT_REMINDER";
|
|
16
18
|
};
|
|
17
19
|
/**
|
|
18
20
|
* Event names for WhatsApp template events
|
|
@@ -173,6 +175,36 @@ declare const TEMPLATE_METADATA: {
|
|
|
173
175
|
readonly currency: "S/ ";
|
|
174
176
|
};
|
|
175
177
|
};
|
|
178
|
+
readonly MEMBER_INVITE: {
|
|
179
|
+
readonly code: "MEMBER_INVITE";
|
|
180
|
+
readonly title: "Invitación Portal de Miembros";
|
|
181
|
+
readonly description: "Invitación para que el socio se registre en el portal";
|
|
182
|
+
readonly icon: "UserPlus";
|
|
183
|
+
readonly variables: readonly ["clientName", "gymName", "inviteCode", "inviteUrl", "expiryDate"];
|
|
184
|
+
readonly exampleValues: {
|
|
185
|
+
readonly clientName: "Juan Pérez";
|
|
186
|
+
readonly gymName: "GymSpace";
|
|
187
|
+
readonly inviteCode: "123456";
|
|
188
|
+
readonly inviteUrl: "https://gymspace.app/members/invite/abc-123";
|
|
189
|
+
readonly expiryDate: "20/02/2024";
|
|
190
|
+
};
|
|
191
|
+
};
|
|
192
|
+
readonly CONTRACT_INSTALLMENT_REMINDER: {
|
|
193
|
+
readonly code: "CONTRACT_INSTALLMENT_REMINDER";
|
|
194
|
+
readonly title: "Recordatorio de Cuota de Contrato";
|
|
195
|
+
readonly description: "Recordatorio de pago para cuotas de membresía";
|
|
196
|
+
readonly icon: "DollarSign";
|
|
197
|
+
readonly variables: readonly ["clientName", "planName", "contractNumber", "installmentNumber", "dueDate", "amount", "outstandingAmount"];
|
|
198
|
+
readonly exampleValues: {
|
|
199
|
+
readonly clientName: "María López";
|
|
200
|
+
readonly planName: "Premium";
|
|
201
|
+
readonly contractNumber: "#202512340001";
|
|
202
|
+
readonly installmentNumber: "2";
|
|
203
|
+
readonly dueDate: "25/02/2024";
|
|
204
|
+
readonly amount: "S/ 150.00";
|
|
205
|
+
readonly outstandingAmount: "S/ 300.00";
|
|
206
|
+
};
|
|
207
|
+
};
|
|
176
208
|
};
|
|
177
209
|
|
|
178
210
|
interface BulkMessageVariable {
|
|
@@ -292,12 +324,13 @@ declare const PERMISSIONS: {
|
|
|
292
324
|
readonly CREDITS_READ: "CREDITS_READ";
|
|
293
325
|
readonly CREDITS_MANAGE: "CREDITS_MANAGE";
|
|
294
326
|
readonly CREDITS_ADJUST: "CREDITS_ADJUST";
|
|
327
|
+
readonly MEMBERS_PORTAL_ACCESS: "MEMBERS_PORTAL_ACCESS";
|
|
295
328
|
readonly SUPER_ADMIN: "SUPER_ADMIN";
|
|
296
329
|
readonly OWNER: "OWNER";
|
|
297
330
|
readonly All: "ALL";
|
|
298
331
|
};
|
|
299
332
|
declare const ROLE_PERMISSIONS: {
|
|
300
|
-
readonly ADMIN: ("ORGANIZATIONS_CREATE" | "ORGANIZATIONS_READ" | "ORGANIZATIONS_UPDATE" | "ORGANIZATIONS_DELETE" | "GYMS_CREATE" | "GYMS_READ" | "GYMS_UPDATE" | "GYMS_DELETE" | "COLLABORATORS_CREATE" | "COLLABORATORS_READ" | "COLLABORATORS_UPDATE" | "COLLABORATORS_DELETE" | "CLIENTS_CREATE" | "CLIENTS_READ" | "CLIENTS_UPDATE" | "CLIENTS_DELETE" | "CONTRACTS_CREATE" | "CONTRACTS_READ" | "CONTRACTS_UPDATE" | "CONTRACTS_DELETE" | "CONTRACTS_APPROVE" | "CONTRACTS_CANCEL" | "MEMBERSHIP_PLANS_CREATE" | "MEMBERSHIP_PLANS_READ" | "MEMBERSHIP_PLANS_UPDATE" | "MEMBERSHIP_PLANS_DELETE" | "CHECKINS_CREATE" | "CHECKINS_READ" | "REPORTS_VIEW" | "REPORTS_FINANCIAL" | "SETTINGS_UPDATE" | "ASSETS_CREATE" | "ASSETS_READ" | "ASSETS_DELETE" | "FILES_CREATE" | "FILES_READ" | "FILES_DELETE" | "PRODUCTS_CREATE" | "PRODUCTS_READ" | "PRODUCTS_UPDATE" | "PRODUCTS_DELETE" | "PRODUCT_CATEGORIES_CREATE" | "PRODUCT_CATEGORIES_READ" | "PRODUCT_CATEGORIES_UPDATE" | "PRODUCT_CATEGORIES_DELETE" | "SALES_CREATE" | "SALES_READ" | "SALES_UPDATE" | "SALES_DELETE" | "SUPPLIERS_CREATE" | "SUPPLIERS_READ" | "SUPPLIERS_UPDATE" | "SUPPLIERS_DELETE" | "PAYMENT_METHODS_CREATE" | "PAYMENT_METHODS_READ" | "PAYMENT_METHODS_UPDATE" | "PAYMENT_METHODS_DELETE" | "WHATSAPP_READ" | "WHATSAPP_SEND" | "WHATSAPP_MANAGE" | "WHATSAPP_BULK_SEND" | "WHATSAPP_BULK_MANAGE" | "MESSAGES_READ" | "MESSAGES_CREATE" | "MESSAGES_RETRY" | "MESSAGES_CANCEL" | "ACTIVITIES_CREATE" | "ACTIVITIES_READ" | "ACTIVITIES_UPDATE" | "ACTIVITIES_DELETE" | "ACTIVITIES_MANAGE_NOTIFICATIONS" | "TAGS_CREATE" | "TAGS_READ" | "TAGS_UPDATE" | "TAGS_DELETE" | "COMMISSIONS_CONFIG_CREATE" | "COMMISSIONS_CONFIG_READ" | "COMMISSIONS_CONFIG_UPDATE" | "COMMISSIONS_RULES_CREATE" | "COMMISSIONS_RULES_READ" | "COMMISSIONS_RULES_UPDATE" | "COMMISSIONS_RULES_DELETE" | "COMMISSIONS_CALCULATIONS_READ" | "COMMISSIONS_REPORTS_VIEW" | "CATALOG_READ" | "CATALOG_UPDATE" | "CATALOG_MANAGE" | "CREDITS_READ" | "CREDITS_MANAGE" | "CREDITS_ADJUST" | "SUPER_ADMIN" | "OWNER" | "ALL")[];
|
|
333
|
+
readonly ADMIN: ("ORGANIZATIONS_CREATE" | "ORGANIZATIONS_READ" | "ORGANIZATIONS_UPDATE" | "ORGANIZATIONS_DELETE" | "GYMS_CREATE" | "GYMS_READ" | "GYMS_UPDATE" | "GYMS_DELETE" | "COLLABORATORS_CREATE" | "COLLABORATORS_READ" | "COLLABORATORS_UPDATE" | "COLLABORATORS_DELETE" | "CLIENTS_CREATE" | "CLIENTS_READ" | "CLIENTS_UPDATE" | "CLIENTS_DELETE" | "CONTRACTS_CREATE" | "CONTRACTS_READ" | "CONTRACTS_UPDATE" | "CONTRACTS_DELETE" | "CONTRACTS_APPROVE" | "CONTRACTS_CANCEL" | "MEMBERSHIP_PLANS_CREATE" | "MEMBERSHIP_PLANS_READ" | "MEMBERSHIP_PLANS_UPDATE" | "MEMBERSHIP_PLANS_DELETE" | "CHECKINS_CREATE" | "CHECKINS_READ" | "REPORTS_VIEW" | "REPORTS_FINANCIAL" | "SETTINGS_UPDATE" | "ASSETS_CREATE" | "ASSETS_READ" | "ASSETS_DELETE" | "FILES_CREATE" | "FILES_READ" | "FILES_DELETE" | "PRODUCTS_CREATE" | "PRODUCTS_READ" | "PRODUCTS_UPDATE" | "PRODUCTS_DELETE" | "PRODUCT_CATEGORIES_CREATE" | "PRODUCT_CATEGORIES_READ" | "PRODUCT_CATEGORIES_UPDATE" | "PRODUCT_CATEGORIES_DELETE" | "SALES_CREATE" | "SALES_READ" | "SALES_UPDATE" | "SALES_DELETE" | "SUPPLIERS_CREATE" | "SUPPLIERS_READ" | "SUPPLIERS_UPDATE" | "SUPPLIERS_DELETE" | "PAYMENT_METHODS_CREATE" | "PAYMENT_METHODS_READ" | "PAYMENT_METHODS_UPDATE" | "PAYMENT_METHODS_DELETE" | "WHATSAPP_READ" | "WHATSAPP_SEND" | "WHATSAPP_MANAGE" | "WHATSAPP_BULK_SEND" | "WHATSAPP_BULK_MANAGE" | "MESSAGES_READ" | "MESSAGES_CREATE" | "MESSAGES_RETRY" | "MESSAGES_CANCEL" | "ACTIVITIES_CREATE" | "ACTIVITIES_READ" | "ACTIVITIES_UPDATE" | "ACTIVITIES_DELETE" | "ACTIVITIES_MANAGE_NOTIFICATIONS" | "TAGS_CREATE" | "TAGS_READ" | "TAGS_UPDATE" | "TAGS_DELETE" | "COMMISSIONS_CONFIG_CREATE" | "COMMISSIONS_CONFIG_READ" | "COMMISSIONS_CONFIG_UPDATE" | "COMMISSIONS_RULES_CREATE" | "COMMISSIONS_RULES_READ" | "COMMISSIONS_RULES_UPDATE" | "COMMISSIONS_RULES_DELETE" | "COMMISSIONS_CALCULATIONS_READ" | "COMMISSIONS_REPORTS_VIEW" | "CATALOG_READ" | "CATALOG_UPDATE" | "CATALOG_MANAGE" | "CREDITS_READ" | "CREDITS_MANAGE" | "CREDITS_ADJUST" | "MEMBERS_PORTAL_ACCESS" | "SUPER_ADMIN" | "OWNER" | "ALL")[];
|
|
301
334
|
readonly MANAGER: readonly ["GYMS_READ", "COLLABORATORS_READ", "CLIENTS_CREATE", "CLIENTS_READ", "CLIENTS_UPDATE", "CONTRACTS_CREATE", "CONTRACTS_READ", "CHECKINS_CREATE", "CHECKINS_READ", "REPORTS_VIEW", "ASSETS_CREATE", "ASSETS_READ", "ASSETS_DELETE", "FILES_CREATE", "FILES_READ", "FILES_DELETE", "PRODUCTS_CREATE", "PRODUCTS_READ", "PRODUCTS_UPDATE", "PRODUCTS_DELETE", "PRODUCT_CATEGORIES_CREATE", "PRODUCT_CATEGORIES_READ", "PRODUCT_CATEGORIES_UPDATE", "PRODUCT_CATEGORIES_DELETE", "SALES_CREATE", "SALES_READ", "SALES_UPDATE", "SUPPLIERS_CREATE", "SUPPLIERS_READ", "SUPPLIERS_UPDATE", "SUPPLIERS_DELETE", "PAYMENT_METHODS_CREATE", "PAYMENT_METHODS_READ", "PAYMENT_METHODS_UPDATE", "PAYMENT_METHODS_DELETE", "COMMISSIONS_RULES_READ", "COMMISSIONS_CALCULATIONS_READ"];
|
|
302
335
|
};
|
|
303
336
|
declare const CACHE_TTL: {
|
|
@@ -397,6 +430,13 @@ declare enum PaymentFrequency {
|
|
|
397
430
|
QUARTERLY = "quarterly",
|
|
398
431
|
ANNUAL = "annual"
|
|
399
432
|
}
|
|
433
|
+
declare enum ContractInstallmentStatus {
|
|
434
|
+
PENDING = "pending",
|
|
435
|
+
PARTIALLY_PAID = "partially_paid",
|
|
436
|
+
PAID = "paid",
|
|
437
|
+
OVERDUE = "overdue",
|
|
438
|
+
CANCELLED = "cancelled"
|
|
439
|
+
}
|
|
400
440
|
declare enum AssetStatus {
|
|
401
441
|
ACTIVE = "active",
|
|
402
442
|
DELETED = "deleted"
|
|
@@ -612,6 +652,8 @@ declare const TemplateCode: {
|
|
|
612
652
|
readonly PAYMENT_RECEIPT: "PAYMENT_RECEIPT";
|
|
613
653
|
readonly SHARE_CATALOG: "SHARE_CATALOG";
|
|
614
654
|
readonly SALE_PAYMENT_REMINDER: "SALE_PAYMENT_REMINDER";
|
|
655
|
+
readonly MEMBER_INVITE: "MEMBER_INVITE";
|
|
656
|
+
readonly CONTRACT_INSTALLMENT_REMINDER: "CONTRACT_INSTALLMENT_REMINDER";
|
|
615
657
|
};
|
|
616
658
|
type TemplateCode = TemplateCodeValue;
|
|
617
659
|
type TemplateTypeValue = (typeof TemplateType)[keyof typeof TemplateType];
|
|
@@ -631,7 +673,7 @@ interface WhatsAppTemplateData {
|
|
|
631
673
|
clientId: string;
|
|
632
674
|
phoneNumber: string;
|
|
633
675
|
templateCode: TemplateCode;
|
|
634
|
-
variables: Record<string,
|
|
676
|
+
variables: Record<string, unknown>;
|
|
635
677
|
metadata?: {
|
|
636
678
|
contractId?: string;
|
|
637
679
|
userId?: string;
|
|
@@ -763,10 +805,32 @@ interface SalePaymentReminderTemplateData extends Omit<WhatsAppTemplateData, 'te
|
|
|
763
805
|
instanceName?: string;
|
|
764
806
|
};
|
|
765
807
|
}
|
|
808
|
+
/**
|
|
809
|
+
* Contract installment reminder template data
|
|
810
|
+
*/
|
|
811
|
+
interface ContractInstallmentReminderTemplateData extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
|
|
812
|
+
templateCode: typeof TemplateCode.CONTRACT_INSTALLMENT_REMINDER;
|
|
813
|
+
variables: {
|
|
814
|
+
clientName: string;
|
|
815
|
+
planName: string;
|
|
816
|
+
contractNumber: string;
|
|
817
|
+
installmentNumber: string;
|
|
818
|
+
dueDate: string;
|
|
819
|
+
amount: string;
|
|
820
|
+
outstandingAmount?: string;
|
|
821
|
+
};
|
|
822
|
+
metadata?: {
|
|
823
|
+
contractId?: string;
|
|
824
|
+
installmentId?: string;
|
|
825
|
+
userId?: string;
|
|
826
|
+
source?: string;
|
|
827
|
+
instanceName?: string;
|
|
828
|
+
};
|
|
829
|
+
}
|
|
766
830
|
/**
|
|
767
831
|
* Union type for all template data types
|
|
768
832
|
*/
|
|
769
|
-
type WhatsAppTemplateEventData = WelcomeTemplateData | MembershipPurchaseTemplateData | MembershipRenewalTemplateData | MembershipExpiringTemplateData | PaymentReminderTemplateData | BirthdayTemplateData | PaymentReceiptTemplateData | ShareCatalogTemplateData | SalePaymentReminderTemplateData;
|
|
833
|
+
type WhatsAppTemplateEventData = WelcomeTemplateData | MembershipPurchaseTemplateData | MembershipRenewalTemplateData | MembershipExpiringTemplateData | PaymentReminderTemplateData | BirthdayTemplateData | PaymentReceiptTemplateData | ShareCatalogTemplateData | SalePaymentReminderTemplateData | ContractInstallmentReminderTemplateData | MemberInviteTemplateData;
|
|
770
834
|
/**
|
|
771
835
|
* Template metadata interface
|
|
772
836
|
*/
|
|
@@ -778,6 +842,23 @@ interface TemplateMetadata {
|
|
|
778
842
|
variables: string[];
|
|
779
843
|
exampleValues: Record<string, string>;
|
|
780
844
|
}
|
|
845
|
+
/**
|
|
846
|
+
* Member invite template data
|
|
847
|
+
*/
|
|
848
|
+
interface MemberInviteTemplateData extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables' | 'metadata'> {
|
|
849
|
+
templateCode: typeof TemplateCode.MEMBER_INVITE;
|
|
850
|
+
variables: {
|
|
851
|
+
clientName: string;
|
|
852
|
+
gymName: string;
|
|
853
|
+
inviteCode: string;
|
|
854
|
+
inviteUrl?: string;
|
|
855
|
+
expiryDate?: string;
|
|
856
|
+
};
|
|
857
|
+
metadata?: {
|
|
858
|
+
gymClientId: string;
|
|
859
|
+
inviteId: string;
|
|
860
|
+
};
|
|
861
|
+
}
|
|
781
862
|
|
|
782
863
|
type UUID = string;
|
|
783
864
|
type Currency = 'USD' | 'EUR' | 'PEN' | 'MXN' | 'COP' | 'ARS' | 'CLP';
|
|
@@ -1008,6 +1089,22 @@ interface IRequestContext {
|
|
|
1008
1089
|
getTimezone(): string;
|
|
1009
1090
|
readonly isOwner: boolean;
|
|
1010
1091
|
readonly isCollaborator: boolean;
|
|
1092
|
+
getContextType(): 'owner' | 'collaborator' | 'member';
|
|
1093
|
+
getMemberId(): UUID | undefined;
|
|
1094
|
+
isMember(): boolean;
|
|
1095
|
+
}
|
|
1096
|
+
interface IGymClient {
|
|
1097
|
+
id: UUID;
|
|
1098
|
+
gymId: UUID;
|
|
1099
|
+
clientNumber: string;
|
|
1100
|
+
name: string;
|
|
1101
|
+
phone?: string;
|
|
1102
|
+
email?: string;
|
|
1103
|
+
documentValue?: string;
|
|
1104
|
+
documentType?: string;
|
|
1105
|
+
status: 'active' | 'inactive';
|
|
1106
|
+
pinSet?: boolean;
|
|
1107
|
+
lastLoginAt?: Date;
|
|
1011
1108
|
}
|
|
1012
1109
|
|
|
1013
1110
|
declare const templateGenerationRequestSchema: z.ZodObject<{
|
|
@@ -1171,4 +1268,4 @@ declare function normalizePhoneForEvolution(phoneNumber: string): string;
|
|
|
1171
1268
|
*/
|
|
1172
1269
|
declare function isValidPeruvianPhone(phoneNumber: string): boolean;
|
|
1173
1270
|
|
|
1174
|
-
export { ACTIVITY_EVENTS, ACTIVITY_MESSAGE_VARIABLES, type AIGeneratedTemplate, ALLOWED_IMAGE_MIMES, type AcceptInvitationDto, type ActivityItem, type ActivityNotification, type ActivityNotificationGenerationRequest, type ActivityQueryParams, AssetCategory, AssetStatus, type AuditFields, BULK_MESSAGE_VARIABLES, BULK_MESSAGE_VARIABLE_CATEGORIES, BULK_MESSAGING_EVENTS, type BirthdayTemplateData, type BulkMessage, type BulkMessageArray, type BulkMessageEventData, type BulkMessageGenerationRequest, type BulkMessageStatusUpdate, type BulkMessageType, type BulkMessageVariable, CACHE_TTL, CancellationReason, ClientStatus, type Collaborator, type CollaboratorStats, CollaboratorStatus, ContractAssetType, ContractStatus, type CreateInvitationDto, type Currency, DATE_FORMATS, type EntityType, FILE_LIMITS, FeatureType, HEADERS, type ICollaborator, type IGym, INTER_MESSAGE_DELAY_MS, type IOrganization, type IRequestContext, type IRole, type ISubscription, type ISubscriptionPlan, type IUser, type Invitation, InvitationStatus, type ListCollaboratorsParams, MAX_CAPTION_LENGTH, MAX_IMAGES_PER_CAMPAIGN, MAX_MESSAGES_PER_CAMPAIGN, type MembershipExpiringTemplateData, type MembershipPurchaseTemplateData, type MembershipRenewalTemplateData, MessageStatus, PAGINATION_DEFAULTS, PERMISSIONS, type PaginatedResponse, type PaginationMeta, type PaginationParams, PaymentFrequency, type PaymentReceiptTemplateData, type PaymentReminderTemplateData, type Permission, PlanStatus, PlanType, ROLE_NAMES, ROLE_PERMISSIONS, type Role, type RoleName, RoleNames, SUPPORTED_MESSAGE_TYPES, type SalePaymentReminderTemplateData, type SendActivityNotificationEvent, type SendBulkMessagesEvent, type ShareCatalogTemplateData, type StatsQueryParams, SubscriptionStatus, SuspensionType, TEMPLATE_CODES, TEMPLATE_METADATA, TemplateCode, type TemplateCodeValue, type TemplateGenerationRequest, type TemplateMetadata, TemplateType, type TemplateTypeValue, type UUID, type UpdateCollaboratorDto, type UpdateCollaboratorRoleDto, type UpdateCollaboratorStatusDto, type User, UserType, VARIABLE_CONTEXT_MAP, type ValidateByCodeDto, type ValidateByTokenDto, type VariableContextType, WHATSAPP_EVENTS, WHATSAPP_TEMPLATE_EVENTS, type WelcomeTemplateData, type WhatsAppMessageRetryEventData, type WhatsAppMessageSendEventData, type WhatsAppTemplateData, type WhatsAppTemplateEventData, activityNotificationGenerationRequestSchema, activityNotificationSchema, aiGeneratedTemplateSchema, bulkMessageGenerationRequestSchema, bulkMessageSchema, canAccessFeature, getRoleCapabilities, getRoleDescription, getRoleDisplayName, getVariablesByContext, isAdminRole, isEncargadoRole, isValidPeruvianPhone, normalizePhoneForEvolution, templateGenerationRequestSchema, validateVariablesInContext };
|
|
1271
|
+
export { ACTIVITY_EVENTS, ACTIVITY_MESSAGE_VARIABLES, type AIGeneratedTemplate, ALLOWED_IMAGE_MIMES, type AcceptInvitationDto, type ActivityItem, type ActivityNotification, type ActivityNotificationGenerationRequest, type ActivityQueryParams, AssetCategory, AssetStatus, type AuditFields, BULK_MESSAGE_VARIABLES, BULK_MESSAGE_VARIABLE_CATEGORIES, BULK_MESSAGING_EVENTS, type BirthdayTemplateData, type BulkMessage, type BulkMessageArray, type BulkMessageEventData, type BulkMessageGenerationRequest, type BulkMessageStatusUpdate, type BulkMessageType, type BulkMessageVariable, CACHE_TTL, CancellationReason, ClientStatus, type Collaborator, type CollaboratorStats, CollaboratorStatus, ContractAssetType, type ContractInstallmentReminderTemplateData, ContractInstallmentStatus, ContractStatus, type CreateInvitationDto, type Currency, DATE_FORMATS, type EntityType, FILE_LIMITS, FeatureType, HEADERS, type ICollaborator, type IGym, type IGymClient, INTER_MESSAGE_DELAY_MS, type IOrganization, type IRequestContext, type IRole, type ISubscription, type ISubscriptionPlan, type IUser, type Invitation, InvitationStatus, type ListCollaboratorsParams, MAX_CAPTION_LENGTH, MAX_IMAGES_PER_CAMPAIGN, MAX_MESSAGES_PER_CAMPAIGN, type MemberInviteTemplateData, type MembershipExpiringTemplateData, type MembershipPurchaseTemplateData, type MembershipRenewalTemplateData, MessageStatus, PAGINATION_DEFAULTS, PERMISSIONS, type PaginatedResponse, type PaginationMeta, type PaginationParams, PaymentFrequency, type PaymentReceiptTemplateData, type PaymentReminderTemplateData, type Permission, PlanStatus, PlanType, ROLE_NAMES, ROLE_PERMISSIONS, type Role, type RoleName, RoleNames, SUPPORTED_MESSAGE_TYPES, type SalePaymentReminderTemplateData, type SendActivityNotificationEvent, type SendBulkMessagesEvent, type ShareCatalogTemplateData, type StatsQueryParams, SubscriptionStatus, SuspensionType, TEMPLATE_CODES, TEMPLATE_METADATA, TemplateCode, type TemplateCodeValue, type TemplateGenerationRequest, type TemplateMetadata, TemplateType, type TemplateTypeValue, type UUID, type UpdateCollaboratorDto, type UpdateCollaboratorRoleDto, type UpdateCollaboratorStatusDto, type User, UserType, VARIABLE_CONTEXT_MAP, type ValidateByCodeDto, type ValidateByTokenDto, type VariableContextType, WHATSAPP_EVENTS, WHATSAPP_TEMPLATE_EVENTS, type WelcomeTemplateData, type WhatsAppMessageRetryEventData, type WhatsAppMessageSendEventData, type WhatsAppTemplateData, type WhatsAppTemplateEventData, activityNotificationGenerationRequestSchema, activityNotificationSchema, aiGeneratedTemplateSchema, bulkMessageGenerationRequestSchema, bulkMessageSchema, canAccessFeature, getRoleCapabilities, getRoleDescription, getRoleDisplayName, getVariablesByContext, isAdminRole, isEncargadoRole, isValidPeruvianPhone, normalizePhoneForEvolution, templateGenerationRequestSchema, validateVariablesInContext };
|
package/dist/index.d.ts
CHANGED
|
@@ -13,6 +13,8 @@ declare const TEMPLATE_CODES: {
|
|
|
13
13
|
readonly PAYMENT_RECEIPT: "PAYMENT_RECEIPT";
|
|
14
14
|
readonly SHARE_CATALOG: "SHARE_CATALOG";
|
|
15
15
|
readonly SALE_PAYMENT_REMINDER: "SALE_PAYMENT_REMINDER";
|
|
16
|
+
readonly MEMBER_INVITE: "MEMBER_INVITE";
|
|
17
|
+
readonly CONTRACT_INSTALLMENT_REMINDER: "CONTRACT_INSTALLMENT_REMINDER";
|
|
16
18
|
};
|
|
17
19
|
/**
|
|
18
20
|
* Event names for WhatsApp template events
|
|
@@ -173,6 +175,36 @@ declare const TEMPLATE_METADATA: {
|
|
|
173
175
|
readonly currency: "S/ ";
|
|
174
176
|
};
|
|
175
177
|
};
|
|
178
|
+
readonly MEMBER_INVITE: {
|
|
179
|
+
readonly code: "MEMBER_INVITE";
|
|
180
|
+
readonly title: "Invitación Portal de Miembros";
|
|
181
|
+
readonly description: "Invitación para que el socio se registre en el portal";
|
|
182
|
+
readonly icon: "UserPlus";
|
|
183
|
+
readonly variables: readonly ["clientName", "gymName", "inviteCode", "inviteUrl", "expiryDate"];
|
|
184
|
+
readonly exampleValues: {
|
|
185
|
+
readonly clientName: "Juan Pérez";
|
|
186
|
+
readonly gymName: "GymSpace";
|
|
187
|
+
readonly inviteCode: "123456";
|
|
188
|
+
readonly inviteUrl: "https://gymspace.app/members/invite/abc-123";
|
|
189
|
+
readonly expiryDate: "20/02/2024";
|
|
190
|
+
};
|
|
191
|
+
};
|
|
192
|
+
readonly CONTRACT_INSTALLMENT_REMINDER: {
|
|
193
|
+
readonly code: "CONTRACT_INSTALLMENT_REMINDER";
|
|
194
|
+
readonly title: "Recordatorio de Cuota de Contrato";
|
|
195
|
+
readonly description: "Recordatorio de pago para cuotas de membresía";
|
|
196
|
+
readonly icon: "DollarSign";
|
|
197
|
+
readonly variables: readonly ["clientName", "planName", "contractNumber", "installmentNumber", "dueDate", "amount", "outstandingAmount"];
|
|
198
|
+
readonly exampleValues: {
|
|
199
|
+
readonly clientName: "María López";
|
|
200
|
+
readonly planName: "Premium";
|
|
201
|
+
readonly contractNumber: "#202512340001";
|
|
202
|
+
readonly installmentNumber: "2";
|
|
203
|
+
readonly dueDate: "25/02/2024";
|
|
204
|
+
readonly amount: "S/ 150.00";
|
|
205
|
+
readonly outstandingAmount: "S/ 300.00";
|
|
206
|
+
};
|
|
207
|
+
};
|
|
176
208
|
};
|
|
177
209
|
|
|
178
210
|
interface BulkMessageVariable {
|
|
@@ -292,12 +324,13 @@ declare const PERMISSIONS: {
|
|
|
292
324
|
readonly CREDITS_READ: "CREDITS_READ";
|
|
293
325
|
readonly CREDITS_MANAGE: "CREDITS_MANAGE";
|
|
294
326
|
readonly CREDITS_ADJUST: "CREDITS_ADJUST";
|
|
327
|
+
readonly MEMBERS_PORTAL_ACCESS: "MEMBERS_PORTAL_ACCESS";
|
|
295
328
|
readonly SUPER_ADMIN: "SUPER_ADMIN";
|
|
296
329
|
readonly OWNER: "OWNER";
|
|
297
330
|
readonly All: "ALL";
|
|
298
331
|
};
|
|
299
332
|
declare const ROLE_PERMISSIONS: {
|
|
300
|
-
readonly ADMIN: ("ORGANIZATIONS_CREATE" | "ORGANIZATIONS_READ" | "ORGANIZATIONS_UPDATE" | "ORGANIZATIONS_DELETE" | "GYMS_CREATE" | "GYMS_READ" | "GYMS_UPDATE" | "GYMS_DELETE" | "COLLABORATORS_CREATE" | "COLLABORATORS_READ" | "COLLABORATORS_UPDATE" | "COLLABORATORS_DELETE" | "CLIENTS_CREATE" | "CLIENTS_READ" | "CLIENTS_UPDATE" | "CLIENTS_DELETE" | "CONTRACTS_CREATE" | "CONTRACTS_READ" | "CONTRACTS_UPDATE" | "CONTRACTS_DELETE" | "CONTRACTS_APPROVE" | "CONTRACTS_CANCEL" | "MEMBERSHIP_PLANS_CREATE" | "MEMBERSHIP_PLANS_READ" | "MEMBERSHIP_PLANS_UPDATE" | "MEMBERSHIP_PLANS_DELETE" | "CHECKINS_CREATE" | "CHECKINS_READ" | "REPORTS_VIEW" | "REPORTS_FINANCIAL" | "SETTINGS_UPDATE" | "ASSETS_CREATE" | "ASSETS_READ" | "ASSETS_DELETE" | "FILES_CREATE" | "FILES_READ" | "FILES_DELETE" | "PRODUCTS_CREATE" | "PRODUCTS_READ" | "PRODUCTS_UPDATE" | "PRODUCTS_DELETE" | "PRODUCT_CATEGORIES_CREATE" | "PRODUCT_CATEGORIES_READ" | "PRODUCT_CATEGORIES_UPDATE" | "PRODUCT_CATEGORIES_DELETE" | "SALES_CREATE" | "SALES_READ" | "SALES_UPDATE" | "SALES_DELETE" | "SUPPLIERS_CREATE" | "SUPPLIERS_READ" | "SUPPLIERS_UPDATE" | "SUPPLIERS_DELETE" | "PAYMENT_METHODS_CREATE" | "PAYMENT_METHODS_READ" | "PAYMENT_METHODS_UPDATE" | "PAYMENT_METHODS_DELETE" | "WHATSAPP_READ" | "WHATSAPP_SEND" | "WHATSAPP_MANAGE" | "WHATSAPP_BULK_SEND" | "WHATSAPP_BULK_MANAGE" | "MESSAGES_READ" | "MESSAGES_CREATE" | "MESSAGES_RETRY" | "MESSAGES_CANCEL" | "ACTIVITIES_CREATE" | "ACTIVITIES_READ" | "ACTIVITIES_UPDATE" | "ACTIVITIES_DELETE" | "ACTIVITIES_MANAGE_NOTIFICATIONS" | "TAGS_CREATE" | "TAGS_READ" | "TAGS_UPDATE" | "TAGS_DELETE" | "COMMISSIONS_CONFIG_CREATE" | "COMMISSIONS_CONFIG_READ" | "COMMISSIONS_CONFIG_UPDATE" | "COMMISSIONS_RULES_CREATE" | "COMMISSIONS_RULES_READ" | "COMMISSIONS_RULES_UPDATE" | "COMMISSIONS_RULES_DELETE" | "COMMISSIONS_CALCULATIONS_READ" | "COMMISSIONS_REPORTS_VIEW" | "CATALOG_READ" | "CATALOG_UPDATE" | "CATALOG_MANAGE" | "CREDITS_READ" | "CREDITS_MANAGE" | "CREDITS_ADJUST" | "SUPER_ADMIN" | "OWNER" | "ALL")[];
|
|
333
|
+
readonly ADMIN: ("ORGANIZATIONS_CREATE" | "ORGANIZATIONS_READ" | "ORGANIZATIONS_UPDATE" | "ORGANIZATIONS_DELETE" | "GYMS_CREATE" | "GYMS_READ" | "GYMS_UPDATE" | "GYMS_DELETE" | "COLLABORATORS_CREATE" | "COLLABORATORS_READ" | "COLLABORATORS_UPDATE" | "COLLABORATORS_DELETE" | "CLIENTS_CREATE" | "CLIENTS_READ" | "CLIENTS_UPDATE" | "CLIENTS_DELETE" | "CONTRACTS_CREATE" | "CONTRACTS_READ" | "CONTRACTS_UPDATE" | "CONTRACTS_DELETE" | "CONTRACTS_APPROVE" | "CONTRACTS_CANCEL" | "MEMBERSHIP_PLANS_CREATE" | "MEMBERSHIP_PLANS_READ" | "MEMBERSHIP_PLANS_UPDATE" | "MEMBERSHIP_PLANS_DELETE" | "CHECKINS_CREATE" | "CHECKINS_READ" | "REPORTS_VIEW" | "REPORTS_FINANCIAL" | "SETTINGS_UPDATE" | "ASSETS_CREATE" | "ASSETS_READ" | "ASSETS_DELETE" | "FILES_CREATE" | "FILES_READ" | "FILES_DELETE" | "PRODUCTS_CREATE" | "PRODUCTS_READ" | "PRODUCTS_UPDATE" | "PRODUCTS_DELETE" | "PRODUCT_CATEGORIES_CREATE" | "PRODUCT_CATEGORIES_READ" | "PRODUCT_CATEGORIES_UPDATE" | "PRODUCT_CATEGORIES_DELETE" | "SALES_CREATE" | "SALES_READ" | "SALES_UPDATE" | "SALES_DELETE" | "SUPPLIERS_CREATE" | "SUPPLIERS_READ" | "SUPPLIERS_UPDATE" | "SUPPLIERS_DELETE" | "PAYMENT_METHODS_CREATE" | "PAYMENT_METHODS_READ" | "PAYMENT_METHODS_UPDATE" | "PAYMENT_METHODS_DELETE" | "WHATSAPP_READ" | "WHATSAPP_SEND" | "WHATSAPP_MANAGE" | "WHATSAPP_BULK_SEND" | "WHATSAPP_BULK_MANAGE" | "MESSAGES_READ" | "MESSAGES_CREATE" | "MESSAGES_RETRY" | "MESSAGES_CANCEL" | "ACTIVITIES_CREATE" | "ACTIVITIES_READ" | "ACTIVITIES_UPDATE" | "ACTIVITIES_DELETE" | "ACTIVITIES_MANAGE_NOTIFICATIONS" | "TAGS_CREATE" | "TAGS_READ" | "TAGS_UPDATE" | "TAGS_DELETE" | "COMMISSIONS_CONFIG_CREATE" | "COMMISSIONS_CONFIG_READ" | "COMMISSIONS_CONFIG_UPDATE" | "COMMISSIONS_RULES_CREATE" | "COMMISSIONS_RULES_READ" | "COMMISSIONS_RULES_UPDATE" | "COMMISSIONS_RULES_DELETE" | "COMMISSIONS_CALCULATIONS_READ" | "COMMISSIONS_REPORTS_VIEW" | "CATALOG_READ" | "CATALOG_UPDATE" | "CATALOG_MANAGE" | "CREDITS_READ" | "CREDITS_MANAGE" | "CREDITS_ADJUST" | "MEMBERS_PORTAL_ACCESS" | "SUPER_ADMIN" | "OWNER" | "ALL")[];
|
|
301
334
|
readonly MANAGER: readonly ["GYMS_READ", "COLLABORATORS_READ", "CLIENTS_CREATE", "CLIENTS_READ", "CLIENTS_UPDATE", "CONTRACTS_CREATE", "CONTRACTS_READ", "CHECKINS_CREATE", "CHECKINS_READ", "REPORTS_VIEW", "ASSETS_CREATE", "ASSETS_READ", "ASSETS_DELETE", "FILES_CREATE", "FILES_READ", "FILES_DELETE", "PRODUCTS_CREATE", "PRODUCTS_READ", "PRODUCTS_UPDATE", "PRODUCTS_DELETE", "PRODUCT_CATEGORIES_CREATE", "PRODUCT_CATEGORIES_READ", "PRODUCT_CATEGORIES_UPDATE", "PRODUCT_CATEGORIES_DELETE", "SALES_CREATE", "SALES_READ", "SALES_UPDATE", "SUPPLIERS_CREATE", "SUPPLIERS_READ", "SUPPLIERS_UPDATE", "SUPPLIERS_DELETE", "PAYMENT_METHODS_CREATE", "PAYMENT_METHODS_READ", "PAYMENT_METHODS_UPDATE", "PAYMENT_METHODS_DELETE", "COMMISSIONS_RULES_READ", "COMMISSIONS_CALCULATIONS_READ"];
|
|
302
335
|
};
|
|
303
336
|
declare const CACHE_TTL: {
|
|
@@ -397,6 +430,13 @@ declare enum PaymentFrequency {
|
|
|
397
430
|
QUARTERLY = "quarterly",
|
|
398
431
|
ANNUAL = "annual"
|
|
399
432
|
}
|
|
433
|
+
declare enum ContractInstallmentStatus {
|
|
434
|
+
PENDING = "pending",
|
|
435
|
+
PARTIALLY_PAID = "partially_paid",
|
|
436
|
+
PAID = "paid",
|
|
437
|
+
OVERDUE = "overdue",
|
|
438
|
+
CANCELLED = "cancelled"
|
|
439
|
+
}
|
|
400
440
|
declare enum AssetStatus {
|
|
401
441
|
ACTIVE = "active",
|
|
402
442
|
DELETED = "deleted"
|
|
@@ -612,6 +652,8 @@ declare const TemplateCode: {
|
|
|
612
652
|
readonly PAYMENT_RECEIPT: "PAYMENT_RECEIPT";
|
|
613
653
|
readonly SHARE_CATALOG: "SHARE_CATALOG";
|
|
614
654
|
readonly SALE_PAYMENT_REMINDER: "SALE_PAYMENT_REMINDER";
|
|
655
|
+
readonly MEMBER_INVITE: "MEMBER_INVITE";
|
|
656
|
+
readonly CONTRACT_INSTALLMENT_REMINDER: "CONTRACT_INSTALLMENT_REMINDER";
|
|
615
657
|
};
|
|
616
658
|
type TemplateCode = TemplateCodeValue;
|
|
617
659
|
type TemplateTypeValue = (typeof TemplateType)[keyof typeof TemplateType];
|
|
@@ -631,7 +673,7 @@ interface WhatsAppTemplateData {
|
|
|
631
673
|
clientId: string;
|
|
632
674
|
phoneNumber: string;
|
|
633
675
|
templateCode: TemplateCode;
|
|
634
|
-
variables: Record<string,
|
|
676
|
+
variables: Record<string, unknown>;
|
|
635
677
|
metadata?: {
|
|
636
678
|
contractId?: string;
|
|
637
679
|
userId?: string;
|
|
@@ -763,10 +805,32 @@ interface SalePaymentReminderTemplateData extends Omit<WhatsAppTemplateData, 'te
|
|
|
763
805
|
instanceName?: string;
|
|
764
806
|
};
|
|
765
807
|
}
|
|
808
|
+
/**
|
|
809
|
+
* Contract installment reminder template data
|
|
810
|
+
*/
|
|
811
|
+
interface ContractInstallmentReminderTemplateData extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables'> {
|
|
812
|
+
templateCode: typeof TemplateCode.CONTRACT_INSTALLMENT_REMINDER;
|
|
813
|
+
variables: {
|
|
814
|
+
clientName: string;
|
|
815
|
+
planName: string;
|
|
816
|
+
contractNumber: string;
|
|
817
|
+
installmentNumber: string;
|
|
818
|
+
dueDate: string;
|
|
819
|
+
amount: string;
|
|
820
|
+
outstandingAmount?: string;
|
|
821
|
+
};
|
|
822
|
+
metadata?: {
|
|
823
|
+
contractId?: string;
|
|
824
|
+
installmentId?: string;
|
|
825
|
+
userId?: string;
|
|
826
|
+
source?: string;
|
|
827
|
+
instanceName?: string;
|
|
828
|
+
};
|
|
829
|
+
}
|
|
766
830
|
/**
|
|
767
831
|
* Union type for all template data types
|
|
768
832
|
*/
|
|
769
|
-
type WhatsAppTemplateEventData = WelcomeTemplateData | MembershipPurchaseTemplateData | MembershipRenewalTemplateData | MembershipExpiringTemplateData | PaymentReminderTemplateData | BirthdayTemplateData | PaymentReceiptTemplateData | ShareCatalogTemplateData | SalePaymentReminderTemplateData;
|
|
833
|
+
type WhatsAppTemplateEventData = WelcomeTemplateData | MembershipPurchaseTemplateData | MembershipRenewalTemplateData | MembershipExpiringTemplateData | PaymentReminderTemplateData | BirthdayTemplateData | PaymentReceiptTemplateData | ShareCatalogTemplateData | SalePaymentReminderTemplateData | ContractInstallmentReminderTemplateData | MemberInviteTemplateData;
|
|
770
834
|
/**
|
|
771
835
|
* Template metadata interface
|
|
772
836
|
*/
|
|
@@ -778,6 +842,23 @@ interface TemplateMetadata {
|
|
|
778
842
|
variables: string[];
|
|
779
843
|
exampleValues: Record<string, string>;
|
|
780
844
|
}
|
|
845
|
+
/**
|
|
846
|
+
* Member invite template data
|
|
847
|
+
*/
|
|
848
|
+
interface MemberInviteTemplateData extends Omit<WhatsAppTemplateData, 'templateCode' | 'variables' | 'metadata'> {
|
|
849
|
+
templateCode: typeof TemplateCode.MEMBER_INVITE;
|
|
850
|
+
variables: {
|
|
851
|
+
clientName: string;
|
|
852
|
+
gymName: string;
|
|
853
|
+
inviteCode: string;
|
|
854
|
+
inviteUrl?: string;
|
|
855
|
+
expiryDate?: string;
|
|
856
|
+
};
|
|
857
|
+
metadata?: {
|
|
858
|
+
gymClientId: string;
|
|
859
|
+
inviteId: string;
|
|
860
|
+
};
|
|
861
|
+
}
|
|
781
862
|
|
|
782
863
|
type UUID = string;
|
|
783
864
|
type Currency = 'USD' | 'EUR' | 'PEN' | 'MXN' | 'COP' | 'ARS' | 'CLP';
|
|
@@ -1008,6 +1089,22 @@ interface IRequestContext {
|
|
|
1008
1089
|
getTimezone(): string;
|
|
1009
1090
|
readonly isOwner: boolean;
|
|
1010
1091
|
readonly isCollaborator: boolean;
|
|
1092
|
+
getContextType(): 'owner' | 'collaborator' | 'member';
|
|
1093
|
+
getMemberId(): UUID | undefined;
|
|
1094
|
+
isMember(): boolean;
|
|
1095
|
+
}
|
|
1096
|
+
interface IGymClient {
|
|
1097
|
+
id: UUID;
|
|
1098
|
+
gymId: UUID;
|
|
1099
|
+
clientNumber: string;
|
|
1100
|
+
name: string;
|
|
1101
|
+
phone?: string;
|
|
1102
|
+
email?: string;
|
|
1103
|
+
documentValue?: string;
|
|
1104
|
+
documentType?: string;
|
|
1105
|
+
status: 'active' | 'inactive';
|
|
1106
|
+
pinSet?: boolean;
|
|
1107
|
+
lastLoginAt?: Date;
|
|
1011
1108
|
}
|
|
1012
1109
|
|
|
1013
1110
|
declare const templateGenerationRequestSchema: z.ZodObject<{
|
|
@@ -1171,4 +1268,4 @@ declare function normalizePhoneForEvolution(phoneNumber: string): string;
|
|
|
1171
1268
|
*/
|
|
1172
1269
|
declare function isValidPeruvianPhone(phoneNumber: string): boolean;
|
|
1173
1270
|
|
|
1174
|
-
export { ACTIVITY_EVENTS, ACTIVITY_MESSAGE_VARIABLES, type AIGeneratedTemplate, ALLOWED_IMAGE_MIMES, type AcceptInvitationDto, type ActivityItem, type ActivityNotification, type ActivityNotificationGenerationRequest, type ActivityQueryParams, AssetCategory, AssetStatus, type AuditFields, BULK_MESSAGE_VARIABLES, BULK_MESSAGE_VARIABLE_CATEGORIES, BULK_MESSAGING_EVENTS, type BirthdayTemplateData, type BulkMessage, type BulkMessageArray, type BulkMessageEventData, type BulkMessageGenerationRequest, type BulkMessageStatusUpdate, type BulkMessageType, type BulkMessageVariable, CACHE_TTL, CancellationReason, ClientStatus, type Collaborator, type CollaboratorStats, CollaboratorStatus, ContractAssetType, ContractStatus, type CreateInvitationDto, type Currency, DATE_FORMATS, type EntityType, FILE_LIMITS, FeatureType, HEADERS, type ICollaborator, type IGym, INTER_MESSAGE_DELAY_MS, type IOrganization, type IRequestContext, type IRole, type ISubscription, type ISubscriptionPlan, type IUser, type Invitation, InvitationStatus, type ListCollaboratorsParams, MAX_CAPTION_LENGTH, MAX_IMAGES_PER_CAMPAIGN, MAX_MESSAGES_PER_CAMPAIGN, type MembershipExpiringTemplateData, type MembershipPurchaseTemplateData, type MembershipRenewalTemplateData, MessageStatus, PAGINATION_DEFAULTS, PERMISSIONS, type PaginatedResponse, type PaginationMeta, type PaginationParams, PaymentFrequency, type PaymentReceiptTemplateData, type PaymentReminderTemplateData, type Permission, PlanStatus, PlanType, ROLE_NAMES, ROLE_PERMISSIONS, type Role, type RoleName, RoleNames, SUPPORTED_MESSAGE_TYPES, type SalePaymentReminderTemplateData, type SendActivityNotificationEvent, type SendBulkMessagesEvent, type ShareCatalogTemplateData, type StatsQueryParams, SubscriptionStatus, SuspensionType, TEMPLATE_CODES, TEMPLATE_METADATA, TemplateCode, type TemplateCodeValue, type TemplateGenerationRequest, type TemplateMetadata, TemplateType, type TemplateTypeValue, type UUID, type UpdateCollaboratorDto, type UpdateCollaboratorRoleDto, type UpdateCollaboratorStatusDto, type User, UserType, VARIABLE_CONTEXT_MAP, type ValidateByCodeDto, type ValidateByTokenDto, type VariableContextType, WHATSAPP_EVENTS, WHATSAPP_TEMPLATE_EVENTS, type WelcomeTemplateData, type WhatsAppMessageRetryEventData, type WhatsAppMessageSendEventData, type WhatsAppTemplateData, type WhatsAppTemplateEventData, activityNotificationGenerationRequestSchema, activityNotificationSchema, aiGeneratedTemplateSchema, bulkMessageGenerationRequestSchema, bulkMessageSchema, canAccessFeature, getRoleCapabilities, getRoleDescription, getRoleDisplayName, getVariablesByContext, isAdminRole, isEncargadoRole, isValidPeruvianPhone, normalizePhoneForEvolution, templateGenerationRequestSchema, validateVariablesInContext };
|
|
1271
|
+
export { ACTIVITY_EVENTS, ACTIVITY_MESSAGE_VARIABLES, type AIGeneratedTemplate, ALLOWED_IMAGE_MIMES, type AcceptInvitationDto, type ActivityItem, type ActivityNotification, type ActivityNotificationGenerationRequest, type ActivityQueryParams, AssetCategory, AssetStatus, type AuditFields, BULK_MESSAGE_VARIABLES, BULK_MESSAGE_VARIABLE_CATEGORIES, BULK_MESSAGING_EVENTS, type BirthdayTemplateData, type BulkMessage, type BulkMessageArray, type BulkMessageEventData, type BulkMessageGenerationRequest, type BulkMessageStatusUpdate, type BulkMessageType, type BulkMessageVariable, CACHE_TTL, CancellationReason, ClientStatus, type Collaborator, type CollaboratorStats, CollaboratorStatus, ContractAssetType, type ContractInstallmentReminderTemplateData, ContractInstallmentStatus, ContractStatus, type CreateInvitationDto, type Currency, DATE_FORMATS, type EntityType, FILE_LIMITS, FeatureType, HEADERS, type ICollaborator, type IGym, type IGymClient, INTER_MESSAGE_DELAY_MS, type IOrganization, type IRequestContext, type IRole, type ISubscription, type ISubscriptionPlan, type IUser, type Invitation, InvitationStatus, type ListCollaboratorsParams, MAX_CAPTION_LENGTH, MAX_IMAGES_PER_CAMPAIGN, MAX_MESSAGES_PER_CAMPAIGN, type MemberInviteTemplateData, type MembershipExpiringTemplateData, type MembershipPurchaseTemplateData, type MembershipRenewalTemplateData, MessageStatus, PAGINATION_DEFAULTS, PERMISSIONS, type PaginatedResponse, type PaginationMeta, type PaginationParams, PaymentFrequency, type PaymentReceiptTemplateData, type PaymentReminderTemplateData, type Permission, PlanStatus, PlanType, ROLE_NAMES, ROLE_PERMISSIONS, type Role, type RoleName, RoleNames, SUPPORTED_MESSAGE_TYPES, type SalePaymentReminderTemplateData, type SendActivityNotificationEvent, type SendBulkMessagesEvent, type ShareCatalogTemplateData, type StatsQueryParams, SubscriptionStatus, SuspensionType, TEMPLATE_CODES, TEMPLATE_METADATA, TemplateCode, type TemplateCodeValue, type TemplateGenerationRequest, type TemplateMetadata, TemplateType, type TemplateTypeValue, type UUID, type UpdateCollaboratorDto, type UpdateCollaboratorRoleDto, type UpdateCollaboratorStatusDto, type User, UserType, VARIABLE_CONTEXT_MAP, type ValidateByCodeDto, type ValidateByTokenDto, type VariableContextType, WHATSAPP_EVENTS, WHATSAPP_TEMPLATE_EVENTS, type WelcomeTemplateData, type WhatsAppMessageRetryEventData, type WhatsAppMessageSendEventData, type WhatsAppTemplateData, type WhatsAppTemplateEventData, activityNotificationGenerationRequestSchema, activityNotificationSchema, aiGeneratedTemplateSchema, bulkMessageGenerationRequestSchema, bulkMessageSchema, canAccessFeature, getRoleCapabilities, getRoleDescription, getRoleDisplayName, getVariablesByContext, isAdminRole, isEncargadoRole, isValidPeruvianPhone, normalizePhoneForEvolution, templateGenerationRequestSchema, validateVariablesInContext };
|
package/dist/index.js
CHANGED
|
@@ -12,7 +12,9 @@ var TemplateCode = {
|
|
|
12
12
|
BIRTHDAY: "BIRTHDAY",
|
|
13
13
|
PAYMENT_RECEIPT: "PAYMENT_RECEIPT",
|
|
14
14
|
SHARE_CATALOG: "SHARE_CATALOG",
|
|
15
|
-
SALE_PAYMENT_REMINDER: "SALE_PAYMENT_REMINDER"
|
|
15
|
+
SALE_PAYMENT_REMINDER: "SALE_PAYMENT_REMINDER",
|
|
16
|
+
MEMBER_INVITE: "MEMBER_INVITE",
|
|
17
|
+
CONTRACT_INSTALLMENT_REMINDER: "CONTRACT_INSTALLMENT_REMINDER"
|
|
16
18
|
};
|
|
17
19
|
var TemplateType = {
|
|
18
20
|
STATIC: "STATIC",
|
|
@@ -29,7 +31,9 @@ var TEMPLATE_CODES = {
|
|
|
29
31
|
BIRTHDAY: TemplateCode.BIRTHDAY,
|
|
30
32
|
PAYMENT_RECEIPT: TemplateCode.PAYMENT_RECEIPT,
|
|
31
33
|
SHARE_CATALOG: TemplateCode.SHARE_CATALOG,
|
|
32
|
-
SALE_PAYMENT_REMINDER: TemplateCode.SALE_PAYMENT_REMINDER
|
|
34
|
+
SALE_PAYMENT_REMINDER: TemplateCode.SALE_PAYMENT_REMINDER,
|
|
35
|
+
MEMBER_INVITE: TemplateCode.MEMBER_INVITE,
|
|
36
|
+
CONTRACT_INSTALLMENT_REMINDER: TemplateCode.CONTRACT_INSTALLMENT_REMINDER
|
|
33
37
|
};
|
|
34
38
|
var WHATSAPP_TEMPLATE_EVENTS = {
|
|
35
39
|
SEND_TEMPLATE: "whatsapp/template.send",
|
|
@@ -186,6 +190,44 @@ var TEMPLATE_METADATA = {
|
|
|
186
190
|
],
|
|
187
191
|
currency: "S/ "
|
|
188
192
|
}
|
|
193
|
+
},
|
|
194
|
+
[TemplateCode.MEMBER_INVITE]: {
|
|
195
|
+
code: TemplateCode.MEMBER_INVITE,
|
|
196
|
+
title: "Invitaci\xF3n Portal de Miembros",
|
|
197
|
+
description: "Invitaci\xF3n para que el socio se registre en el portal",
|
|
198
|
+
icon: "UserPlus",
|
|
199
|
+
variables: ["clientName", "gymName", "inviteCode", "inviteUrl", "expiryDate"],
|
|
200
|
+
exampleValues: {
|
|
201
|
+
clientName: "Juan P\xE9rez",
|
|
202
|
+
gymName: "GymSpace",
|
|
203
|
+
inviteCode: "123456",
|
|
204
|
+
inviteUrl: "https://gymspace.app/members/invite/abc-123",
|
|
205
|
+
expiryDate: "20/02/2024"
|
|
206
|
+
}
|
|
207
|
+
},
|
|
208
|
+
[TemplateCode.CONTRACT_INSTALLMENT_REMINDER]: {
|
|
209
|
+
code: TemplateCode.CONTRACT_INSTALLMENT_REMINDER,
|
|
210
|
+
title: "Recordatorio de Cuota de Contrato",
|
|
211
|
+
description: "Recordatorio de pago para cuotas de membres\xEDa",
|
|
212
|
+
icon: "DollarSign",
|
|
213
|
+
variables: [
|
|
214
|
+
"clientName",
|
|
215
|
+
"planName",
|
|
216
|
+
"contractNumber",
|
|
217
|
+
"installmentNumber",
|
|
218
|
+
"dueDate",
|
|
219
|
+
"amount",
|
|
220
|
+
"outstandingAmount"
|
|
221
|
+
],
|
|
222
|
+
exampleValues: {
|
|
223
|
+
clientName: "Mar\xEDa L\xF3pez",
|
|
224
|
+
planName: "Premium",
|
|
225
|
+
contractNumber: "#202512340001",
|
|
226
|
+
installmentNumber: "2",
|
|
227
|
+
dueDate: "25/02/2024",
|
|
228
|
+
amount: "S/ 150.00",
|
|
229
|
+
outstandingAmount: "S/ 300.00"
|
|
230
|
+
}
|
|
189
231
|
}
|
|
190
232
|
};
|
|
191
233
|
|
|
@@ -644,6 +686,8 @@ var PERMISSIONS = {
|
|
|
644
686
|
CREDITS_READ: "CREDITS_READ",
|
|
645
687
|
CREDITS_MANAGE: "CREDITS_MANAGE",
|
|
646
688
|
CREDITS_ADJUST: "CREDITS_ADJUST",
|
|
689
|
+
// Members
|
|
690
|
+
MEMBERS_PORTAL_ACCESS: "MEMBERS_PORTAL_ACCESS",
|
|
647
691
|
// Special permissions
|
|
648
692
|
SUPER_ADMIN: "SUPER_ADMIN",
|
|
649
693
|
OWNER: "OWNER",
|
|
@@ -811,6 +855,14 @@ var PaymentFrequency = /* @__PURE__ */ ((PaymentFrequency2) => {
|
|
|
811
855
|
PaymentFrequency2["ANNUAL"] = "annual";
|
|
812
856
|
return PaymentFrequency2;
|
|
813
857
|
})(PaymentFrequency || {});
|
|
858
|
+
var ContractInstallmentStatus = /* @__PURE__ */ ((ContractInstallmentStatus2) => {
|
|
859
|
+
ContractInstallmentStatus2["PENDING"] = "pending";
|
|
860
|
+
ContractInstallmentStatus2["PARTIALLY_PAID"] = "partially_paid";
|
|
861
|
+
ContractInstallmentStatus2["PAID"] = "paid";
|
|
862
|
+
ContractInstallmentStatus2["OVERDUE"] = "overdue";
|
|
863
|
+
ContractInstallmentStatus2["CANCELLED"] = "cancelled";
|
|
864
|
+
return ContractInstallmentStatus2;
|
|
865
|
+
})(ContractInstallmentStatus || {});
|
|
814
866
|
var AssetStatus = /* @__PURE__ */ ((AssetStatus2) => {
|
|
815
867
|
AssetStatus2["ACTIVE"] = "active";
|
|
816
868
|
AssetStatus2["DELETED"] = "deleted";
|
|
@@ -1049,6 +1101,7 @@ exports.CancellationReason = CancellationReason;
|
|
|
1049
1101
|
exports.ClientStatus = ClientStatus;
|
|
1050
1102
|
exports.CollaboratorStatus = CollaboratorStatus;
|
|
1051
1103
|
exports.ContractAssetType = ContractAssetType;
|
|
1104
|
+
exports.ContractInstallmentStatus = ContractInstallmentStatus;
|
|
1052
1105
|
exports.ContractStatus = ContractStatus;
|
|
1053
1106
|
exports.DATE_FORMATS = DATE_FORMATS;
|
|
1054
1107
|
exports.FILE_LIMITS = FILE_LIMITS;
|