@vrplatform/log 2.0.60 → 2.0.62

package/build/main/tracking/types.d.ts

@@ -1,3 +1,4 @@
+import type { Maybe } from '@finalytic/utils';
 export type TrackProps<T extends TrackingEvent> = OptionalUser<{
     groupId: string;
     packageName: string;
@@ -5,6 +6,9 @@ export type TrackProps<T extends TrackingEvent> = OptionalUser<{
     event: T;
     properties: TrackingEventProps[T];
 }>;
+type MaybePartial<T> = {
+    [P in keyof T]?: Maybe<T[P]>;
+};
 export type IdentifyProps = {
     userId: string;
     traits?: {
@@ -103,11 +107,6 @@ export type TrackingEventProps = {
     hyperline_trial_ended: HyperlineTrialEndedProps;
     hyperline_subscription_created: HyperlineSubscriptionCreatedProps;
     hyperline_subscription_cancellation_scheduled: HyperlineSubscriptionCancellationScheduledProps;
-    hyperline_subscription_activated: HyperlineSubscriptionActivatedProps;
-    hyperline_subscription_cancelled: HyperlineSubscriptionCancelledProps;
-    hyperline_subscription_errored: HyperlineSubscriptionErroredProps;
-    hyperline_subscription_paused: HyperlineSubscriptionPausedProps;
-    hyperline_subscription_voided: HyperlineSubscriptionVoidedProps;
     hyperline_subscription_charged: HyperlineSubscriptionChargedProps;
     hyperline_subscription_status_changed: HyperlineSubscriptionStatusChangedProps;
     hyperline_customer_created: HyperlineCustomerCreatedProps;
@@ -141,44 +140,45 @@ export type TenantType = 'admin' | 'partner' | 'propertyManager';
 export type TenantStatus = 'active' | 'inactive';
 export type SubscriptionStatus = 'active' | 'cancelled' | 'draft' | 'errored' | 'paused' | 'pending' | 'voided';
 export type OwnerStatementStatus = 'preview' | 'draft' | 'inReview' | 'void' | 'published' | 'posted';
+export type TaxStatementStatus = 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted' | 'error';
 export type PaymentMethodType = 'card' | 'direct_debit' | 'direct_debit_ach' | 'direct_debit_bacs' | 'transfer' | 'transfer_automated' | 'external';
-type AccountInvitationAcceptedProps = Partial<{
+type AccountInvitationAcceptedProps = MaybePartial<{
     userId: string;
     userEmail: string;
     userRole: 'owner' | 'user' | 'admin';
     tenantId: string;
     isNewUser: boolean;
 }>;
-type AccountPasswordResetCompletedProps = Partial<{
+type AccountPasswordResetCompletedProps = MaybePartial<{
     userEmail: string;
 }>;
-type AccountPasswordResetFailedProps = Partial<{
+type AccountPasswordResetFailedProps = MaybePartial<{
     userEmail: string;
     status: 'needs_second_factor' | 'needs_identifier' | 'needs_first_factor' | 'needs_new_password' | null | any;
 }>;
-type AccountPasswordResetRequestedProps = Partial<{
+type AccountPasswordResetRequestedProps = MaybePartial<{
     userEmail: string;
 }>;
-type AccountSignedOutProps = Partial<{
+type AccountSignedOutProps = MaybePartial<{
     userId: string;
     userEmail: string;
     tenantId: string;
     firstName: string;
     lastName: string;
 }>;
-type AccountSigninCompletedProps = Partial<{
+type AccountSigninCompletedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
 }>;
-type AccountSignupCodeCompletedProps = Partial<{
+type AccountSignupCodeCompletedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
     type: 'property_manager' | 'partner';
 }>;
-type AccountSignupCodeFailedProps = Partial<{
+type AccountSignupCodeFailedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
@@ -186,21 +186,21 @@ type AccountSignupCodeFailedProps = Partial<{
     type: 'property_manager' | 'partner';
     status: 'missing_requirements' | 'abandoned' | null | any;
 }>;
-type AccountSignupCodeRequestedProps = Partial<{
+type AccountSignupCodeRequestedProps = MaybePartial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
     type: 'property_manager' | 'partner';
 }>;
-type AccountSignupCompletedProps = Partial<{
+type AccountSignupCompletedProps = MaybePartial<{
     tenantId: string;
     userEmail: string;
     firstName: string;
     lastName: string;
     userId: string;
 }>;
-type AutomationCreatedProps = Partial<{
+type AutomationCreatedProps = MaybePartial<{
     automationId: string;
     templateId: string;
     type?: string | null;
@@ -209,7 +209,7 @@ type AutomationCreatedProps = Partial<{
     userEmail: string;
     tenantId: string;
 }>;
-type AutomationDeletedProps = Partial<{
+type AutomationDeletedProps = MaybePartial<{
     automationId: string;
     templateId: string;
     type?: string | null;
@@ -219,7 +219,7 @@ type AutomationDeletedProps = Partial<{
     tenantId: string;
 }>;
 type AutomationUpdatedProps = any;
-type ConnectionCreatedProps = Partial<{
+type ConnectionCreatedProps = MaybePartial<{
     connectionId: string;
     tenantId: string;
     userId: string;
@@ -227,7 +227,7 @@ type ConnectionCreatedProps = Partial<{
     appId: string;
     type?: string;
 }>;
-type ConnectionDeletedProps = Partial<{
+type ConnectionDeletedProps = MaybePartial<{
     connectionId: string;
     tenantId: string;
     type?: string;
@@ -235,32 +235,32 @@ type ConnectionDeletedProps = Partial<{
     appId: string;
     userEmail: string;
 }>;
-type ConnectionReconnectedProps = Partial<{
+type ConnectionReconnectedProps = MaybePartial<{
     connectionId: string;
     tenantId: string;
     userId: string;
     userEmail: string;
     appId: string;
 }>;
-type ConnectionRequestedProps = Partial<{
+type ConnectionRequestedProps = MaybePartial<{
     type: 'PMS' | 'Accounting';
     website: string;
     userId: string;
     userEmail: string;
     tenantId: string;
 }>;
-type GlOwnerStatementDownloadedProps = Partial<{
+type GlOwnerStatementDownloadedProps = MaybePartial<{
     ownerStatementId: string;
     ownerStatementUrls: string[];
     userType: 'owner' | 'property_manager';
 }>;
-type GlOwnerStatementPreviewOpenedProps = Partial<{
+type GlOwnerStatementPreviewOpenedProps = MaybePartial<{
     ownerStatementStatus: string;
     ownerStatementId: string;
     ownerStatementUrls: string[];
     userType: 'owner' | 'property_manager';
 }>;
-type HyperlineCustomerCreatedProps = Partial<{
+type HyperlineCustomerCreatedProps = MaybePartial<{
     tenantId: string;
     customerId: string;
     billingEmail: string;
@@ -270,7 +270,7 @@ type HyperlineCustomerCreatedProps = Partial<{
     vatNumber: string;
     webhookEventType: 'customer.created';
 }>;
-type HyperlineCustomerUpdatedProps = Partial<{
+type HyperlineCustomerUpdatedProps = MaybePartial<{
     tenantId: string;
     customerId: string;
     billingEmail: string;
@@ -280,7 +280,7 @@ type HyperlineCustomerUpdatedProps = Partial<{
     vatNumber: string;
     webhookEventType: 'customer.updated';
 }>;
-type HyperlineInvoiceErroredProps = Partial<{
+type HyperlineInvoiceErroredProps = MaybePartial<{
     status: 'errored';
     paymentMethodType: string;
     invoiceId: string;
@@ -289,7 +289,7 @@ type HyperlineInvoiceErroredProps = Partial<{
     customerId: string;
     erroredAt: string;
 }>;
-type HyperlineInvoiceReadyProps = Partial<{
+type HyperlineInvoiceReadyProps = MaybePartial<{
     status: 'ready';
     paymentMethodType: string;
     invoiceId: string;
@@ -300,7 +300,7 @@ type HyperlineInvoiceReadyProps = Partial<{
     taxAmount: number;
     readyAt: string;
 }>;
-type HyperlineInvoiceSettledProps = Partial<{
+type HyperlineInvoiceSettledProps = MaybePartial<{
     status: 'settled';
     paymentMethodType: string;
     invoiceId: string;
@@ -311,7 +311,7 @@ type HyperlineInvoiceSettledProps = Partial<{
     taxAmount: number;
     settledAt: string;
 }>;
-type HyperlineInvoiceVoidedProps = Partial<{
+type HyperlineInvoiceVoidedProps = MaybePartial<{
     status: 'voided';
     paymentMethodType: string;
     invoiceId: string;
@@ -320,7 +320,7 @@ type HyperlineInvoiceVoidedProps = Partial<{
     customerId: string;
     voidedAt: string;
 }>;
-type HyperlinePaymentMethodCreatedProps = Partial<{
+type HyperlinePaymentMethodCreatedProps = MaybePartial<{
     tenantId: string;
     subscriptionStartDate: string;
     paymentMethodType: PaymentMethodType;
@@ -329,7 +329,7 @@ type HyperlinePaymentMethodCreatedProps = Partial<{
     customerId: string;
     webhookEventType: 'payment_method.created';
 }>;
-type HyperlinePaymentMethodDeletedProps = Partial<{
+type HyperlinePaymentMethodDeletedProps = MaybePartial<{
     tenantId: string;
     subscriptionStartDate: string;
     paymentMethodType: PaymentMethodType;
@@ -338,7 +338,7 @@ type HyperlinePaymentMethodDeletedProps = Partial<{
     customerId: string;
     webhookEventType: 'payment_method.deleted';
 }>;
-type HyperlinePaymentMethodErroredProps = Partial<{
+type HyperlinePaymentMethodErroredProps = MaybePartial<{
     tenantId: string;
     subscriptionStartDate: string;
     paymentMethodType: PaymentMethodType;
@@ -347,7 +347,7 @@ type HyperlinePaymentMethodErroredProps = Partial<{
     customerId: string;
     webhookEventType: 'payment_method.errored';
 }>;
-type HyperlineSubscriptionCancellationScheduledProps = Partial<{
+type HyperlineSubscriptionCancellationScheduledProps = MaybePartial<{
     subscriptionId: string;
     cancellationStrategy: 'charge_prorata' | 'charge_custom' | 'refund_prorata' | 'refund_custom' | 'end_of_period' | 'do_nothing';
     cancelledAt: string;
@@ -356,7 +356,7 @@ type HyperlineSubscriptionCancellationScheduledProps = Partial<{
     tenantId: string;
     webhookEventType: 'subscription.cancellation_scheduled';
 }>;
-type HyperlineSubscriptionChargedProps = Partial<{
+type HyperlineSubscriptionChargedProps = MaybePartial<{
     plan: string;
     subscriptionId: string;
     subscriptionStartDate: string;
@@ -364,7 +364,7 @@ type HyperlineSubscriptionChargedProps = Partial<{
     paymentMethodType: string;
     customerId: string;
 }>;
-type HyperlineSubscriptionCreatedProps = Partial<{
+type HyperlineSubscriptionCreatedProps = MaybePartial<{
     trialStartDate: string;
     plan: string;
     subscriptionId: string;
@@ -373,7 +373,7 @@ type HyperlineSubscriptionCreatedProps = Partial<{
     paymentMethodType: string;
     customerId: string;
 }>;
-type HyperlineSubscriptionStatusChangedProps = Partial<{
+type HyperlineSubscriptionStatusChangedProps = MaybePartial<{
     subscriptionId: string;
     plan: string;
     tenantId: string;
@@ -384,48 +384,7 @@ type HyperlineSubscriptionStatusChangedProps = Partial<{
     mrr: number;
     customerId: string;
 }>;
-type HyperlineSubscriptionActivatedProps = Partial<{
-    subscriptionId: string;
-    subscriptionStatus: SubscriptionStatus;
-    plan: string;
-    tenantId: string;
-    webhookEventType: 'subscription.activated';
-}>;
-type HyperlineSubscriptionCancelledProps = Partial<{
-    subscriptionId: string;
-    subscriptionStatus: SubscriptionStatus;
-    plan: string;
-    trialEndAt: string;
-    subscriptionStartDate: string;
-    paymentMethodType: string;
-    mrr: number;
-    customerId: string;
-    tenantId: string;
-    webhookEventType: 'subscription.cancelled';
-}>;
-type HyperlineSubscriptionErroredProps = Partial<{
-    subscriptionId: string;
-    subscriptionStatus: SubscriptionStatus;
-    plan: string;
-    userId: string;
-    tenantId: string;
-    webhookEventType: 'subscription.errored';
-}>;
-type HyperlineSubscriptionPausedProps = Partial<{
-    subscriptionId: string;
-    subscriptionStatus: SubscriptionStatus;
-    plan: string;
-    tenantId: string;
-    webhookEventType: 'subscription.paused';
-}>;
-type HyperlineSubscriptionVoidedProps = Partial<{
-    subscriptionId: string;
-    subscriptionStatus: SubscriptionStatus;
-    plan: string;
-    tenantId: string;
-    webhookEventType: 'subscription.voided';
-}>;
-type HyperlineTrialEndedProps = Partial<{
+type HyperlineTrialEndedProps = MaybePartial<{
     trialStartDate: string;
     trialEndDate: string;
     plan: string;
@@ -434,13 +393,13 @@ type HyperlineTrialEndedProps = Partial<{
     subscriptionStatus: SubscriptionStatus;
     paymentMethodType: PaymentMethodType;
 }>;
-type HyperlineTrialStartedProps = Partial<{
+type HyperlineTrialStartedProps = MaybePartial<{
     tenantId: string;
     subscriptionStatus: SubscriptionStatus;
     trialUntil: string;
     webhookEventType: 'payment_method.created';
 }>;
-type OwnerCreatedProps = Partial<{
+type OwnerCreatedProps = MaybePartial<{
     userId: string;
     tenantId: string;
     ownerId: string;
@@ -448,7 +407,7 @@ type OwnerCreatedProps = Partial<{
     withUserInvite: boolean;
     userEmail: string;
 }>;
-type OwnerDeletedProps = Partial<{
+type OwnerDeletedProps = MaybePartial<{
     userId: string;
     tenantId: string;
     ownerId: string;
@@ -456,18 +415,18 @@ type OwnerDeletedProps = Partial<{
     listingId: string;
     ownershipId: string;
 }>;
-type OwnerTaxInfoModalOpenedProps = Partial<{
+type OwnerTaxInfoModalOpenedProps = MaybePartial<{
     flag: string;
 }>;
-type OwnerTaxInfoModalSubmittedProps = Partial<{
+type OwnerTaxInfoModalSubmittedProps = MaybePartial<{
     flag: string;
 }>;
-type OwnerUpdatedProps = Partial<{
+type OwnerUpdatedProps = MaybePartial<{
     userId: string;
     tenantId: string;
     ownerId: string;
 }>;
-type OwnershipCreatedProps = Partial<{
+type OwnershipCreatedProps = MaybePartial<{
     ownershipId: string;
     ownerId: string;
     listingId: string;
@@ -475,7 +434,7 @@ type OwnershipCreatedProps = Partial<{
     userEmail: string;
     tenantId: string;
 }>;
-type OwnershipDeletedProps = Partial<{
+type OwnershipDeletedProps = MaybePartial<{
     ownershipId: string;
     ownerId: string;
     listingId: string;
@@ -483,7 +442,7 @@ type OwnershipDeletedProps = Partial<{
     userEmail: string;
     tenantId: string;
 }>;
-type OwnershipUpdatedProps = Partial<{
+type OwnershipUpdatedProps = MaybePartial<{
     ownershipId: string;
     ownerId: string;
     listingId: string;
@@ -495,18 +454,18 @@ type SetupAccountingConfigCompletedProps = any;
 type SetupAccountingVersionCompletedProps = any;
 type SetupClassesSetProps = any;
 type SetupEntitiesSetProps = any;
-type SetupListingImportedProps = Partial<{
+type SetupListingImportedProps = MaybePartial<{
     appId: string;
 }>;
-type SetupOwnerImportedProps = Partial<{
+type SetupOwnerImportedProps = MaybePartial<{
     appId: string;
 }>;
-type SetupReservationImportedProps = Partial<{
+type SetupReservationImportedProps = MaybePartial<{
     appId: string;
 }>;
 type SetupVendorsSetProps = any;
-type TaxStatementDownloadedProps = Partial<{
-    taxStatementStatus?: 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted';
+type TaxStatementDownloadedProps = MaybePartial<{
+    taxStatementStatus?: TaxStatementStatus;
     taxStatementId: string;
     taxStatementUrl: string;
     userType: string;
@@ -514,8 +473,8 @@ type TaxStatementDownloadedProps = Partial<{
     userEmail: string;
     tenantId: string;
 }>;
-type TaxStatementPreviewOpenedProps = Partial<{
-    taxStatementStatus?: 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted';
+type TaxStatementPreviewOpenedProps = MaybePartial<{
+    taxStatementStatus?: TaxStatementStatus;
     taxStatementId: string;
     taxStatementUrl: string;
     userType: string;
@@ -523,7 +482,7 @@ type TaxStatementPreviewOpenedProps = Partial<{
     userEmail: string;
     tenantId: string;
 }>;
-type TeamAddedProps = Partial<{
+type TeamAddedProps = MaybePartial<{
     tenantId: string;
     tenantName: string;
     partnerId: string;
@@ -531,46 +490,46 @@ type TeamAddedProps = Partial<{
     userId: string;
     userEmail: string;
 }>;
-type TeamCanceledProps = Partial<{
+type TeamCanceledProps = MaybePartial<{
     tenantId: string;
     customerId: string;
     subscriptionId: string;
     feedback: string;
     reason: string;
 }>;
-type TeamDeletedProps = Partial<{
+type TeamDeletedProps = MaybePartial<{
     tenantId: string;
     userId: string;
     userEmail: string;
 }>;
-type TeamInfoUpdatedProps = Partial<{
+type TeamInfoUpdatedProps = MaybePartial<{
     userId: string;
     tenantId: string;
     userEmail: string;
 }>;
-type TeamMemberRemovedProps = Partial<{
+type TeamMemberRemovedProps = MaybePartial<{
     userId: string;
     removedUserId: string;
     tenantId: string;
     userEmail: string;
 }>;
-type TeamReinstatedProps = Partial<{
+type TeamReinstatedProps = MaybePartial<{
     tenantId: string;
     subscriptionId: string;
 }>;
-type TestErrorProps = Partial<{
+type TestErrorProps = MaybePartial<{
     userId: string;
     tenantId: string;
     [key: string]: any;
 }>;
-type TestEventProps = Partial<{
+type TestEventProps = MaybePartial<{
     success: boolean;
     [key: string]: any;
 }>;
-type UpdateRefreshAcceptedProps = Partial<{
+type UpdateRefreshAcceptedProps = MaybePartial<{
     appName: string;
 }>;
-type OwnerStatementStatusChangedProps = Partial<{
+type OwnerStatementStatusChangedProps = MaybePartial<{
     userId: string;
     tenantId: string;
     userEmail: string;
@@ -580,10 +539,20 @@ type OwnerStatementStatusChangedProps = Partial<{
     startAt: string;
     status: OwnerStatementStatus;
 }>;
-type ListingActivatedProps = any;
-type ListingDeactivatedProps = any;
-type ListingsReportedProps = any;
-type IntercomConversationCreated = Partial<{
+type ListingActivatedProps = MaybePartial<{
+    tenantId: string;
+    billingStatus: 'active' | 'inactive';
+    name: string;
+    vrpStatus: 'active' | 'disabled' | 'enabled' | 'inactive';
+    pmsStatus: string;
+}>;
+type ListingDeactivatedProps = ListingActivatedProps;
+type ListingsReportedProps = MaybePartial<{
+    userId: string;
+    tenantId: string;
+    activeListings: number;
+}>;
+type IntercomConversationCreated = MaybePartial<{
     userId: string;
     tenantId: string;
     userEmail: string;
@@ -595,14 +564,14 @@ type IntercomConversationCreated = Partial<{
     submittedFrom: 'user' | 'admin';
 }>;
 type IntercomConversationReplied = IntercomConversationCreated;
-type IntercomConversationClosed = Partial<{
+type IntercomConversationClosed = MaybePartial<{
     userId: string;
     tenantId: string;
     userEmail: string;
     conversationId: string;
     createdAt: string;
 }>;
-type IntercomConversationRated = Partial<{
+type IntercomConversationRated = MaybePartial<{
     userId: string;
     tenantId: string;
     userEmail: string;
@@ -611,7 +580,7 @@ type IntercomConversationRated = Partial<{
     remark: string;
     createdAt: string;
 }>;
-type MrrReportedProps = Partial<{
+type MrrReportedProps = MaybePartial<{
     mrr: number;
     subscriptionStatus: SubscriptionStatus;
 }>;