@vrplatform/log 2.0.60 → 2.0.62

package/src/tracking/types.ts

@@ -1,3 +1,5 @@
+import type { Maybe } from '@finalytic/utils';
+
 export type TrackProps<T extends TrackingEvent> = OptionalUser<{
   groupId: string;
   packageName: string;
@@ -6,6 +8,8 @@ export type TrackProps<T extends TrackingEvent> = OptionalUser<{
   properties: TrackingEventProps[T];
 }>;
 
+type MaybePartial<T> = { [P in keyof T]?: Maybe<T[P]> };
+
 // const plan = [
 //   'All-in-One VRP Subscription',
 //   'Essentials VRP Subscription',
@@ -117,11 +121,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;
@@ -178,6 +177,13 @@ export type OwnerStatementStatus =
   | 'void'
   | 'published'
   | 'posted';
+export type TaxStatementStatus =
+  | 'draft'
+  | 'ignored'
+  | 'inReview'
+  | 'ready'
+  | 'submitted'
+  | 'error';
 export type PaymentMethodType =
   | 'card'
   | 'direct_debit'
@@ -187,7 +193,7 @@ export type PaymentMethodType =
   | 'transfer_automated'
   | 'external';
 
-type AccountInvitationAcceptedProps = Partial<{
+type AccountInvitationAcceptedProps = MaybePartial<{
   userId: string;
   userEmail: string;
   userRole: 'owner' | 'user' | 'admin';
@@ -195,11 +201,11 @@ type AccountInvitationAcceptedProps = Partial<{
   isNewUser: boolean;
 }>;
 
-type AccountPasswordResetCompletedProps = Partial<{
+type AccountPasswordResetCompletedProps = MaybePartial<{
   userEmail: string;
 }>;
 
-type AccountPasswordResetFailedProps = Partial<{
+type AccountPasswordResetFailedProps = MaybePartial<{
   userEmail: string;
   status:
     | 'needs_second_factor'
@@ -210,11 +216,11 @@ type AccountPasswordResetFailedProps = Partial<{
     | any;
 }>;
 
-type AccountPasswordResetRequestedProps = Partial<{
+type AccountPasswordResetRequestedProps = MaybePartial<{
   userEmail: string;
 }>;
 
-type AccountSignedOutProps = Partial<{
+type AccountSignedOutProps = MaybePartial<{
   userId: string;
   userEmail: string;
   tenantId: string;
@@ -222,13 +228,13 @@ type AccountSignedOutProps = Partial<{
   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;
@@ -236,7 +242,7 @@ type AccountSignupCodeCompletedProps = Partial<{
   type: 'property_manager' | 'partner';
 }>;
 
-type AccountSignupCodeFailedProps = Partial<{
+type AccountSignupCodeFailedProps = MaybePartial<{
   firstName: string;
   lastName: string;
   userEmail: string;
@@ -245,7 +251,7 @@ type AccountSignupCodeFailedProps = Partial<{
   status: 'missing_requirements' | 'abandoned' | null | any;
 }>;
 
-type AccountSignupCodeRequestedProps = Partial<{
+type AccountSignupCodeRequestedProps = MaybePartial<{
   firstName: string;
   lastName: string;
   userEmail: string;
@@ -253,7 +259,7 @@ type AccountSignupCodeRequestedProps = Partial<{
   type: 'property_manager' | 'partner';
 }>;
 
-type AccountSignupCompletedProps = Partial<{
+type AccountSignupCompletedProps = MaybePartial<{
   tenantId: string;
   userEmail: string;
   firstName: string;
@@ -261,7 +267,7 @@ type AccountSignupCompletedProps = Partial<{
   userId: string;
 }>;
 
-type AutomationCreatedProps = Partial<{
+type AutomationCreatedProps = MaybePartial<{
   automationId: string;
   templateId: string;
   type?: string | null;
@@ -271,7 +277,7 @@ type AutomationCreatedProps = Partial<{
   tenantId: string;
 }>;
 
-type AutomationDeletedProps = Partial<{
+type AutomationDeletedProps = MaybePartial<{
   automationId: string;
   templateId: string;
   type?: string | null;
@@ -283,7 +289,7 @@ type AutomationDeletedProps = Partial<{
 
 type AutomationUpdatedProps = any;
 
-type ConnectionCreatedProps = Partial<{
+type ConnectionCreatedProps = MaybePartial<{
   connectionId: string;
   tenantId: string;
   userId: string;
@@ -292,7 +298,7 @@ type ConnectionCreatedProps = Partial<{
   type?: string;
 }>;
 
-type ConnectionDeletedProps = Partial<{
+type ConnectionDeletedProps = MaybePartial<{
   connectionId: string;
   tenantId: string;
   type?: string;
@@ -301,7 +307,7 @@ type ConnectionDeletedProps = Partial<{
   userEmail: string;
 }>;
 
-type ConnectionReconnectedProps = Partial<{
+type ConnectionReconnectedProps = MaybePartial<{
   connectionId: string;
   tenantId: string;
   userId: string;
@@ -309,7 +315,7 @@ type ConnectionReconnectedProps = Partial<{
   appId: string;
 }>;
 
-type ConnectionRequestedProps = Partial<{
+type ConnectionRequestedProps = MaybePartial<{
   type: 'PMS' | 'Accounting';
   website: string;
   userId: string;
@@ -317,20 +323,20 @@ type ConnectionRequestedProps = Partial<{
   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;
@@ -341,7 +347,7 @@ type HyperlineCustomerCreatedProps = Partial<{
   webhookEventType: 'customer.created';
 }>;
 
-type HyperlineCustomerUpdatedProps = Partial<{
+type HyperlineCustomerUpdatedProps = MaybePartial<{
   tenantId: string;
   customerId: string;
   billingEmail: string;
@@ -352,7 +358,7 @@ type HyperlineCustomerUpdatedProps = Partial<{
   webhookEventType: 'customer.updated';
 }>;
 
-type HyperlineInvoiceErroredProps = Partial<{
+type HyperlineInvoiceErroredProps = MaybePartial<{
   status: 'errored';
   paymentMethodType: string;
   invoiceId: string;
@@ -362,7 +368,7 @@ type HyperlineInvoiceErroredProps = Partial<{
   erroredAt: string;
 }>;
 
-type HyperlineInvoiceReadyProps = Partial<{
+type HyperlineInvoiceReadyProps = MaybePartial<{
   status: 'ready';
   paymentMethodType: string;
   invoiceId: string;
@@ -374,7 +380,7 @@ type HyperlineInvoiceReadyProps = Partial<{
   readyAt: string;
 }>;
 
-type HyperlineInvoiceSettledProps = Partial<{
+type HyperlineInvoiceSettledProps = MaybePartial<{
   status: 'settled';
   paymentMethodType: string;
   invoiceId: string;
@@ -386,7 +392,7 @@ type HyperlineInvoiceSettledProps = Partial<{
   settledAt: string;
 }>;
 
-type HyperlineInvoiceVoidedProps = Partial<{
+type HyperlineInvoiceVoidedProps = MaybePartial<{
   status: 'voided';
   paymentMethodType: string;
   invoiceId: string;
@@ -396,7 +402,7 @@ type HyperlineInvoiceVoidedProps = Partial<{
   voidedAt: string;
 }>;
 
-type HyperlinePaymentMethodCreatedProps = Partial<{
+type HyperlinePaymentMethodCreatedProps = MaybePartial<{
   tenantId: string;
   subscriptionStartDate: string;
   paymentMethodType: PaymentMethodType;
@@ -406,7 +412,7 @@ type HyperlinePaymentMethodCreatedProps = Partial<{
   webhookEventType: 'payment_method.created';
 }>;
 
-type HyperlinePaymentMethodDeletedProps = Partial<{
+type HyperlinePaymentMethodDeletedProps = MaybePartial<{
   tenantId: string;
   subscriptionStartDate: string;
   paymentMethodType: PaymentMethodType;
@@ -416,7 +422,7 @@ type HyperlinePaymentMethodDeletedProps = Partial<{
   webhookEventType: 'payment_method.deleted';
 }>;
 
-type HyperlinePaymentMethodErroredProps = Partial<{
+type HyperlinePaymentMethodErroredProps = MaybePartial<{
   tenantId: string;
   subscriptionStartDate: string;
   paymentMethodType: PaymentMethodType;
@@ -426,7 +432,7 @@ type HyperlinePaymentMethodErroredProps = Partial<{
   webhookEventType: 'payment_method.errored';
 }>;
 
-type HyperlineSubscriptionCancellationScheduledProps = Partial<{
+type HyperlineSubscriptionCancellationScheduledProps = MaybePartial<{
   subscriptionId: string;
   cancellationStrategy:
     | 'charge_prorata'
@@ -442,7 +448,7 @@ type HyperlineSubscriptionCancellationScheduledProps = Partial<{
   webhookEventType: 'subscription.cancellation_scheduled';
 }>;
 
-type HyperlineSubscriptionChargedProps = Partial<{
+type HyperlineSubscriptionChargedProps = MaybePartial<{
   plan: string;
   subscriptionId: string;
   subscriptionStartDate: string;
@@ -451,7 +457,7 @@ type HyperlineSubscriptionChargedProps = Partial<{
   customerId: string;
 }>;
 
-type HyperlineSubscriptionCreatedProps = Partial<{
+type HyperlineSubscriptionCreatedProps = MaybePartial<{
   trialStartDate: string;
   plan: string;
   subscriptionId: string;
@@ -461,7 +467,7 @@ type HyperlineSubscriptionCreatedProps = Partial<{
   customerId: string;
 }>;
 
-type HyperlineSubscriptionStatusChangedProps = Partial<{
+type HyperlineSubscriptionStatusChangedProps = MaybePartial<{
   subscriptionId: string;
   plan: string;
   tenantId: string;
@@ -473,53 +479,7 @@ type HyperlineSubscriptionStatusChangedProps = Partial<{
   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;
@@ -529,14 +489,14 @@ type HyperlineTrialEndedProps = Partial<{
   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;
@@ -552,7 +512,7 @@ type OwnerCreatedProps = Partial<{
   userEmail: string;
 }>;
 
-type OwnerDeletedProps = Partial<{
+type OwnerDeletedProps = MaybePartial<{
   userId: string;
   tenantId: string;
   ownerId: string;
@@ -561,21 +521,21 @@ type OwnerDeletedProps = Partial<{
   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;
@@ -584,7 +544,7 @@ type OwnershipCreatedProps = Partial<{
   tenantId: string;
 }>;
 
-type OwnershipDeletedProps = Partial<{
+type OwnershipDeletedProps = MaybePartial<{
   ownershipId: string;
   ownerId: string;
   listingId: string;
@@ -593,7 +553,7 @@ type OwnershipDeletedProps = Partial<{
   tenantId: string;
 }>;
 
-type OwnershipUpdatedProps = Partial<{
+type OwnershipUpdatedProps = MaybePartial<{
   ownershipId: string;
   ownerId: string;
   listingId: string;
@@ -610,22 +570,22 @@ 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;
@@ -634,8 +594,8 @@ type TaxStatementDownloadedProps = Partial<{
   tenantId: string;
 }>;
 
-type TaxStatementPreviewOpenedProps = Partial<{
-  taxStatementStatus?: 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted';
+type TaxStatementPreviewOpenedProps = MaybePartial<{
+  taxStatementStatus?: TaxStatementStatus;
   taxStatementId: string;
   taxStatementUrl: string;
   userType: string;
@@ -644,7 +604,7 @@ type TaxStatementPreviewOpenedProps = Partial<{
   tenantId: string;
 }>;
 
-type TeamAddedProps = Partial<{
+type TeamAddedProps = MaybePartial<{
   tenantId: string;
   tenantName: string;
   partnerId: string;
@@ -653,7 +613,7 @@ type TeamAddedProps = Partial<{
   userEmail: string;
 }>;
 
-type TeamCanceledProps = Partial<{
+type TeamCanceledProps = MaybePartial<{
   tenantId: string;
   customerId: string;
   subscriptionId: string;
@@ -661,46 +621,46 @@ type TeamCanceledProps = Partial<{
   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;
@@ -711,13 +671,23 @@ type OwnerStatementStatusChangedProps = Partial<{
   status: OwnerStatementStatus;
 }>;
 
-type ListingActivatedProps = any;
+type ListingActivatedProps = MaybePartial<{
+  tenantId: string;
+  billingStatus: 'active' | 'inactive';
+  name: string;
+  vrpStatus: 'active' | 'disabled' | 'enabled' | 'inactive';
+  pmsStatus: string;
+}>;
 
-type ListingDeactivatedProps = any;
+type ListingDeactivatedProps = ListingActivatedProps;
 
-type ListingsReportedProps = any;
+type ListingsReportedProps = MaybePartial<{
+  userId: string;
+  tenantId: string;
+  activeListings: number;
+}>;
 
-type IntercomConversationCreated = Partial<{
+type IntercomConversationCreated = MaybePartial<{
   userId: string;
   tenantId: string;
   userEmail: string;
@@ -731,7 +701,7 @@ type IntercomConversationCreated = Partial<{
 
 type IntercomConversationReplied = IntercomConversationCreated;
 
-type IntercomConversationClosed = Partial<{
+type IntercomConversationClosed = MaybePartial<{
   userId: string;
   tenantId: string;
   userEmail: string;
@@ -739,7 +709,7 @@ type IntercomConversationClosed = Partial<{
   createdAt: string;
 }>;
 
-type IntercomConversationRated = Partial<{
+type IntercomConversationRated = MaybePartial<{
   userId: string;
   tenantId: string;
   userEmail: string;
@@ -749,7 +719,7 @@ type IntercomConversationRated = Partial<{
   createdAt: string;
 }>;
 
-type MrrReportedProps = Partial<{
+type MrrReportedProps = MaybePartial<{
   mrr: number;
   subscriptionStatus: SubscriptionStatus;
 }>;