@vrplatform/log 2.0.0-alpha.45 → 2.0.0-alpha.48

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

@@ -1,82 +1,7 @@
 export type TrackProps = OptionalUser<{
     groupId: string;
-    event: TrackingEvent;
-    properties: Record<string, string | number | boolean | null | undefined>;
     timestamp?: Date;
-}>;
-export type IdentifyProps = {
-    userId: string;
-    traits?: {
-        id?: string;
-        email?: string;
-        avatar?: string;
-        name?: string;
-        firstName?: string;
-        lastName?: string;
-        createdAt?: string;
-        country?: string;
-        isSuperAdmin?: boolean;
-        isVrpAdmin?: boolean;
-        isPartnerAdmin?: boolean;
-        isTeamAdmin?: boolean;
-        role?: UserRole;
-        [key: string]: string | number | boolean | null | undefined;
-    };
-    disableGeoip?: boolean;
-    timestamp?: Date;
-};
-export type GroupProps = OptionalUser<{
-    groupId: string;
-    traits: {
-        name: string;
-        type?: TenantType;
-        avatar?: string;
-        createdAt?: string;
-        partner?: string;
-        partnerId?: string;
-        billingCustomerId?: string;
-        billingSubscriptionStatus?: string;
-        status?: TenantStatus;
-        isOnboarding?: boolean;
-        accountingPartner?: string;
-        billingPartner?: string;
-        pms?: string;
-        apps?: string;
-        accountingSoftware?: string;
-        activeListings?: number;
-        mrr?: number;
-        plan?: string;
-        paymentMethodType?: string;
-        [key: string]: string | number | boolean | null | undefined;
-    };
-    timestamp?: Date;
-}>;
-export type UserRole = 'super-admin' | 'vrp-admin' | 'partner-admin' | 'team-admin' | 'admin' | 'owner' | 'user';
-export type TenantType = 'admin' | 'partner' | 'propertyManager';
-export type TenantStatus = 'active' | 'inactive';
-type OptionalUser<T> = T & ({
-    userId: string;
-    anonymousId?: string;
-} | {
-    userId?: string;
-    anonymousId: string;
-});
-type AuthEvent = 'account_signin_completed' | 'account_signup_code_requested' | 'account_signup_code_completed' | 'account_signup_code_failed' | 'account_signup_completed' | 'account_password_reset_requested' | 'account_password_reset_failed' | 'account_password_reset_completed' | 'account_invitation_accepted' | 'account_signed_out';
-type TeamEvent = 'team_added' | 'team_info_updated' | 'team_deleted' | 'team_member_removed';
-type ConnectionEvent = 'connection_created' | 'connection_reconnected' | 'connection_deleted' | 'connection_requested';
-type OwnershipEvent = 'ownership_created' | 'ownership_updated' | 'ownership_deleted';
-type OwnerEvent = 'owner_created' | 'owner_updated' | 'owner_deleted' | 'owner_tax_info_modal_opened' | 'owner_tax_info_modal_submitted';
-type SetupEvent = 'setup_classes_set' | 'setup_accounting_version_completed' | 'setup_accounting_config_completed' | 'setup_owner_imported' | 'setup_listing_imported';
-type AutomationEvent = 'automation_created' | 'automation_updated' | 'automation_deleted';
-type TaxStatementEvent = 'tax_statement_preview_opened' | 'tax_statement_downloaded';
-type GLOwnerStatementEvent = 'gl_owner_statement_preview_opened' | 'gl_owner_statement_downloaded';
-type HyperlineEvent = 'hyperline_invoice_ready' | 'hyperline_invoice_settled' | 'hyperline_trial_started' | 'hyperline_trial_ended' | 'hyperline_subscription_activated' | 'hyperline_subscription_cancelled' | 'hyperline_subscription_created' | 'hyperline_subscription_errored' | 'hyperline_subscription_paused' | 'hyperline_subscription_voided' | 'hyperline_subscription_charged' | 'hyperline_customer_created' | 'hyperline_customer_updated' | 'hyperline_payment_method_created' | 'hyperline_payment_method_errored' | 'hyperline_payment_method_deleted';
-type ListingEvent = 'listing_activated' | 'listing_deactivated';
-type ReportEvent = 'listings_reported';
-type UserEvent = 'update_refresh_accepted' | 'owner_statement_opened';
-type TestEvent = 'test_event' | 'test_error';
-export type TrackingEvent = AuthEvent | TeamEvent | ConnectionEvent | OwnershipEvent | OwnerEvent | SetupEvent | AutomationEvent | TaxStatementEvent | GLOwnerStatementEvent | HyperlineEvent | UserEvent | ListingEvent | ReportEvent | TestEvent;
-export type TrackingProps = {
+} & ({
     event: 'account_invitation_accepted';
     properties: AccountInvitationAcceptedProps;
 } | {
@@ -268,137 +193,209 @@ export type TrackingProps = {
 } | {
     event: 'listings_reported';
     properties: ListingsReported;
+})>;
+export type IdentifyProps = {
+    userId: string;
+    traits?: {
+        id?: string;
+        email?: string;
+        avatar?: string;
+        name?: string;
+        firstName?: string;
+        lastName?: string;
+        createdAt?: string;
+        country?: string;
+        isSuperAdmin?: boolean;
+        isVrpAdmin?: boolean;
+        isPartnerAdmin?: boolean;
+        isTeamAdmin?: boolean;
+        role?: UserRole;
+        [key: string]: string | number | boolean | null | undefined;
+    };
+    disableGeoip?: boolean;
+    timestamp?: Date;
 };
-type AccountInvitationAcceptedProps = {
+export type GroupProps = OptionalUser<{
+    groupId: string;
+    traits?: {
+        name?: string;
+        type?: TenantType;
+        avatar?: string;
+        createdAt?: string;
+        partner?: string;
+        partnerId?: string;
+        billingCustomerId?: string;
+        billingSubscriptionStatus?: string;
+        status?: TenantStatus;
+        isOnboarding?: boolean;
+        accountingPartner?: string;
+        billingPartner?: string;
+        pms?: string;
+        apps?: string;
+        accountingSoftware?: string;
+        activeListings?: number;
+        mrr?: number;
+        plan?: string;
+        paymentMethodType?: string;
+        [key: string]: string | number | boolean | null | undefined;
+    };
+    timestamp?: Date;
+}>;
+export type UserRole = 'super-admin' | 'vrp-admin' | 'partner-admin' | 'team-admin' | 'admin' | 'owner' | 'user';
+export type TenantType = 'admin' | 'partner' | 'propertyManager';
+export type TenantStatus = 'active' | 'inactive';
+type OptionalUser<T> = T & ({
+    userId: string;
+    anonymousId?: string;
+} | {
+    userId?: string;
+    anonymousId: string;
+});
+type AuthEvent = 'account_signin_completed' | 'account_signup_code_requested' | 'account_signup_code_completed' | 'account_signup_code_failed' | 'account_signup_completed' | 'account_password_reset_requested' | 'account_password_reset_failed' | 'account_password_reset_completed' | 'account_invitation_accepted' | 'account_signed_out';
+type TeamEvent = 'team_added' | 'team_info_updated' | 'team_deleted' | 'team_member_removed';
+type ConnectionEvent = 'connection_created' | 'connection_reconnected' | 'connection_deleted' | 'connection_requested';
+type OwnershipEvent = 'ownership_created' | 'ownership_updated' | 'ownership_deleted';
+type OwnerEvent = 'owner_created' | 'owner_updated' | 'owner_deleted' | 'owner_tax_info_modal_opened' | 'owner_tax_info_modal_submitted';
+type SetupEvent = 'setup_classes_set' | 'setup_accounting_version_completed' | 'setup_accounting_config_completed' | 'setup_owner_imported' | 'setup_listing_imported';
+type AutomationEvent = 'automation_created' | 'automation_updated' | 'automation_deleted';
+type TaxStatementEvent = 'tax_statement_preview_opened' | 'tax_statement_downloaded';
+type GLOwnerStatementEvent = 'gl_owner_statement_preview_opened' | 'gl_owner_statement_downloaded';
+type HyperlineEvent = 'hyperline_invoice_ready' | 'hyperline_invoice_settled' | 'hyperline_trial_started' | 'hyperline_trial_ended' | 'hyperline_subscription_activated' | 'hyperline_subscription_cancelled' | 'hyperline_subscription_created' | 'hyperline_subscription_errored' | 'hyperline_subscription_paused' | 'hyperline_subscription_voided' | 'hyperline_subscription_charged' | 'hyperline_customer_created' | 'hyperline_customer_updated' | 'hyperline_payment_method_created' | 'hyperline_payment_method_errored' | 'hyperline_payment_method_deleted';
+type ListingEvent = 'listing_activated' | 'listing_deactivated';
+type ReportEvent = 'listings_reported';
+type UserEvent = 'update_refresh_accepted' | 'owner_statement_opened';
+type TestEvent = 'test_event' | 'test_error';
+export type TrackingEvent = AuthEvent | TeamEvent | ConnectionEvent | OwnershipEvent | OwnerEvent | SetupEvent | AutomationEvent | TaxStatementEvent | GLOwnerStatementEvent | HyperlineEvent | UserEvent | ListingEvent | ReportEvent | TestEvent;
+type AccountInvitationAcceptedProps = Partial<{
     userId: string;
     userEmail: string;
     userRole: 'owner' | 'user' | 'admin';
     tenantId: string;
     isNewUser: boolean;
-};
-type AccountPasswordResetCompletedProps = {
+}>;
+type AccountPasswordResetCompletedProps = Partial<{
     userEmail: string;
-};
-type AccountPasswordResetFailedProps = {
+}>;
+type AccountPasswordResetFailedProps = Partial<{
     userEmail: string;
-    status: string;
-};
-type AccountPasswordResetRequestedProps = {
+    status: 'needs_second_factor' | 'needs_identifier' | 'needs_first_factor' | 'needs_new_password' | null | any;
+}>;
+type AccountPasswordResetRequestedProps = Partial<{
     userEmail: string;
-};
-type AccountSignedOutProps = {
+}>;
+type AccountSignedOutProps = Partial<{
     userId: string;
     userEmail: string;
     tenantId: string;
     firstName: string;
     lastName: string;
-};
-type AccountSigninCompletedProps = {
+}>;
+type AccountSigninCompletedProps = Partial<{
     firstName: string;
     lastName: string;
     userEmail: string;
-};
-type AccountSignupCodeCompletedProps = {
+}>;
+type AccountSignupCodeCompletedProps = Partial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: string;
-};
-type AccountSignupCodeFailedProps = {
+    type: 'property_manager' | 'partner';
+}>;
+type AccountSignupCodeFailedProps = Partial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: string;
-    status: string;
-};
-type AccountSignupCodeRequestedProps = {
+    type: 'property_manager' | 'partner';
+    status: 'missing_requirements' | 'abandoned' | null | any;
+}>;
+type AccountSignupCodeRequestedProps = Partial<{
     firstName: string;
     lastName: string;
     userEmail: string;
     companyName: string;
-    type: string;
-};
-type AccountSignupCompletedProps = {
+    type: 'property_manager' | 'partner';
+}>;
+type AccountSignupCompletedProps = Partial<{
     tenantId: string;
     userEmail: string;
     firstName: string;
     lastName: string;
     userId: string;
-};
-type AutomationCreatedProps = {
+}>;
+type AutomationCreatedProps = Partial<{
     automationId: string;
     templateId: string;
-    type: string;
+    type?: string | null;
     uniqueRef: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
-type AutomationDeletedProps = {
+}>;
+type AutomationDeletedProps = Partial<{
     automationId: string;
     templateId: string;
-    type: string;
+    type?: string | null;
     uniqueRef: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
+}>;
 type AutomationUpdated = any;
-type ConnectionCreatedProps = {
+type ConnectionCreatedProps = Partial<{
     connectionId: string;
     tenantId: string;
     userId: string;
     userEmail: string;
     appId: string;
-    type: string;
-};
-type ConnectionDeletedProps = {
+    type?: string;
+}>;
+type ConnectionDeletedProps = Partial<{
     connectionId: string;
     tenantId: string;
-    type: string;
+    type?: string;
     userId: string;
     appId: string;
     userEmail: string;
-};
-type ConnectionReconnectedProps = {
+}>;
+type ConnectionReconnectedProps = Partial<{
     connectionId: string;
     tenantId: string;
     userId: string;
     userEmail: string;
     appId: string;
-};
-type ConnectionRequestedProps = {
-    type: string;
+}>;
+type ConnectionRequestedProps = Partial<{
+    type: 'PMS' | 'Accounting';
     website: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
-type GlOwnerStatementDownloadedProps = {
+}>;
+type GlOwnerStatementDownloadedProps = Partial<{
     ownerStatementId: string;
     ownerStatementUrls: string[];
-    userType: string;
-};
-type GlOwnerStatementPreviewOpenedProps = {
+    userType: 'owner' | 'property_manager';
+}>;
+type GlOwnerStatementPreviewOpenedProps = Partial<{
     ownerStatementStatus: string;
     ownerStatementId: string;
     ownerStatementUrls: string[];
-    userType: string;
-};
-type HyperlineCustomerCreatedProps = {
+    userType: 'owner' | 'property_manager';
+}>;
+type HyperlineCustomerCreatedProps = Partial<{
     userId: string;
     tenantId: string;
     customerId: string;
-};
-type HyperlineCustomerUpdatedProps = {
+}>;
+type HyperlineCustomerUpdatedProps = Partial<{
     userId: string;
     tenantId: string;
     customerId: string;
-};
-type HyperlineInvoiceReadyProps = {
-    status: string;
+}>;
+type HyperlineInvoiceReadyProps = Partial<{
+    status: 'ready';
     paymentMethodType: string;
     invoiceId: string;
     amount: number;
@@ -407,9 +404,9 @@ type HyperlineInvoiceReadyProps = {
     customerId: string;
     taxAmount: string;
     readyAt: string;
-};
-type HyperlineInvoiceSettledProps = {
-    status: string;
+}>;
+type HyperlineInvoiceSettledProps = Partial<{
+    status: 'settled';
     paymentMethodType: string;
     invoiceId: string;
     amount: number;
@@ -418,44 +415,44 @@ type HyperlineInvoiceSettledProps = {
     customerId: string;
     taxAmount: string;
     settledAt: string;
-};
-type HyperlinePaymentMethodCreatedProps = {
+}>;
+type HyperlinePaymentMethodCreatedProps = Partial<{
     userId: string;
     tenantId: string;
     payloadCreatedAt: string;
-    payloadType: string;
-    payloadState: string;
+    payloadType: 'card' | 'direct_debit_sepa' | 'direct_debit_ach' | 'direct_debit_bacs';
+    payloadState: 'active' | 'pending';
     payloadId: string;
     payloadCustomerId: string;
-    webhookEventType: string;
-};
-type HyperlinePaymentMethodDeletedProps = {
+    webhookEventType: 'payment_method.created';
+}>;
+type HyperlinePaymentMethodDeletedProps = Partial<{
     userId: string;
     tenantId: string;
     payloadCreatedAt: string;
-    payloadType: string;
-    payloadState: string;
+    payloadType: 'card' | 'direct_debit_sepa' | 'direct_debit_ach' | 'direct_debit_bacs';
+    payloadState: 'active' | 'pending';
     payloadId: string;
     payloadCustomerId: string;
-    webhookEventType: string;
-};
-type HyperlinePaymentMethodErroredProps = {
+    webhookEventType: 'payment_method.deleted';
+}>;
+type HyperlinePaymentMethodErroredProps = Partial<{
     userId: string;
     tenantId: string;
     payloadCreatedAt: string;
-    payloadType: string;
-    payloadState: string;
+    payloadType: 'card' | 'direct_debit_sepa' | 'direct_debit_ach' | 'direct_debit_bacs';
+    payloadState: 'active' | 'pending';
     payloadId: string;
     payloadCustomerId: string;
-    webhookEventType: string;
-};
-type HyperlineSubscriptionActivatedProps = {
+    webhookEventType: 'payment_method.errored';
+}>;
+type HyperlineSubscriptionActivatedProps = Partial<{
     userId: string;
     tenantId: string;
-    tenantBillingStatus: string;
-    webhookEventType: string;
-};
-type HyperlineSubscriptionCancelledProps = {
+    tenantBillingStatus: 'pending' | 'active' | 'canceled';
+    webhookEventType: 'subscription.activated';
+}>;
+type HyperlineSubscriptionCancelledProps = Partial<{
     trialEndAt: string;
     plan: string;
     subscriptionId: string;
@@ -465,18 +462,18 @@ type HyperlineSubscriptionCancelledProps = {
     customerId: string;
     userId: string;
     tenantId: string;
-    webhookEventType: string;
-    tenantBillingStatus: string;
-};
-type HyperlineSubscriptionChargedProps = {
+    webhookEventType: 'subscription.cancelled';
+    tenantBillingStatus: 'pending' | 'active' | 'canceled';
+}>;
+type HyperlineSubscriptionChargedProps = Partial<{
     plan: string;
     subscriptionId: string;
     subscriptionStartDate: string;
     subscriptionStatus: string;
     paymentMethodType: string;
     customerId: string;
-};
-type HyperlineSubscriptionCreatedProps = {
+}>;
+type HyperlineSubscriptionCreatedProps = Partial<{
     trialStartDate: string;
     plan: string;
     subscriptionId: string;
@@ -484,165 +481,158 @@ type HyperlineSubscriptionCreatedProps = {
     subscriptionStatus: string;
     paymentMethodType: string;
     customerId: string;
-};
-type HyperlineSubscriptionErroredProps = {
+}>;
+type HyperlineSubscriptionErroredProps = Partial<{
     userId: string;
     tenantId: string;
-    tenantBillingStatus: string;
-    webhookEventType: string;
-};
-type HyperlineSubscriptionPausedProps = {
+    tenantBillingStatus: 'pending' | 'active' | 'canceled';
+    webhookEventType: 'subscription.errored';
+}>;
+type HyperlineSubscriptionPausedProps = Partial<{
     userId: string;
     tenantId: string;
-    tenantBillingStatus: string;
-    webhookEventType: string;
-};
-type HyperlineSubscriptionVoidedProps = {
+    tenantBillingStatus: 'pending' | 'active' | 'canceled';
+    webhookEventType: 'subscription.paused';
+}>;
+type HyperlineSubscriptionVoidedProps = Partial<{
     userId: string;
     tenantId: string;
-    tenantBillingStatus: string;
-    webhookEventType: string;
-};
-type HyperlineTrialEndedProps = {
+    tenantBillingStatus: 'pending' | 'active' | 'canceled';
+    webhookEventType: 'subscription.voided';
+}>;
+type HyperlineTrialEndedProps = Partial<{
     trialStartDate: string;
     trialEndDate: string;
     plan: string;
     subscriptionId: string;
     subscriptionStartDate: string;
     subscriptionStatus: string;
-    paymentMethodType: string;
-};
-type HyperlineTrialStartedProps = {
-    tenantId: string;
-    userId: string;
-    tenantBillingStatus: string;
-    webhookEventType: string;
-};
-type OwnerCreatedProps = {
-    userId: string;
+    paymentMethodType: 'card';
+}>;
+type HyperlineTrialStartedProps = Partial<{
     tenantId: string;
-    ownerId: string;
-};
-type OwnerDeletedProps = {
     userId: string;
-    tenantId: string;
-    ownerId: string;
-};
-type OwnerTaxInfoModalOpenedProps = {
+    tenantBillingStatus: 'pending' | 'active' | 'canceled';
+    webhookEventType: 'payment_method.created';
+}>;
+type OwnerCreatedProps = Partial<{
     userId: string;
     tenantId: string;
     ownerId: string;
-    taxId: string;
-};
-type OwnerTaxInfoModalSubmittedProps = {
+}>;
+type OwnerDeletedProps = Partial<{
     userId: string;
     tenantId: string;
     ownerId: string;
-    taxId: string;
-    status: string;
-};
-type OwnerUpdatedProps = {
+}>;
+type OwnerTaxInfoModalOpenedProps = Partial<{
+    flag: string;
+}>;
+type OwnerTaxInfoModalSubmittedProps = Partial<{
+    flag: string;
+}>;
+type OwnerUpdatedProps = Partial<{
     userId: string;
     tenantId: string;
     ownerId: string;
-};
-type OwnershipCreatedProps = {
+}>;
+type OwnershipCreatedProps = Partial<{
     ownershipId: string;
     ownerId: string;
     listingId: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
-type OwnershipDeletedProps = {
+}>;
+type OwnershipDeletedProps = Partial<{
     ownershipId: string;
     ownerId: string;
     listingId: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
-type OwnershipUpdatedProps = {
+}>;
+type OwnershipUpdatedProps = Partial<{
     ownershipId: string;
     ownerId: string;
     listingId: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
+}>;
 type SetupAccountingConfigCompleted = any;
 type SetupAccountingVersionCompleted = any;
 type SetupClassesSet = any;
 type SetupEntitiesSet = any;
-type SetupListingImportedProps = {
+type SetupListingImportedProps = Partial<{
     appId: string;
-};
-type SetupOwnerImportedProps = {
+}>;
+type SetupOwnerImportedProps = Partial<{
     appId: string;
-};
-type SetupReservationImportedProps = {
+}>;
+type SetupReservationImportedProps = Partial<{
     appId: string;
-};
+}>;
 type SetupVendorsSet = any;
-type TaxStatementDownloadedProps = {
-    taxStatementStatus: string;
+type TaxStatementDownloadedProps = Partial<{
+    taxStatementStatus?: 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted';
     taxStatementId: string;
     taxStatementUrl: string;
     userType: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
-type TaxStatementPreviewOpenedProps = {
-    taxStatementStatus: string;
+}>;
+type TaxStatementPreviewOpenedProps = Partial<{
+    taxStatementStatus?: 'draft' | 'ignored' | 'inReview' | 'ready' | 'submitted';
     taxStatementId: string;
     taxStatementUrl: string;
     userType: string;
     userId: string;
     userEmail: string;
     tenantId: string;
-};
-type TeamAddedProps = {
+}>;
+type TeamAddedProps = Partial<{
     tenantId: string;
     tenantName: string;
     partnerId: string;
     userType: string;
     userId: string;
     userEmail: string;
-};
-type TeamDeletedProps = {
+}>;
+type TeamDeletedProps = Partial<{
     tenantId: string;
     userId: string;
     userEmail: string;
-};
-type TeamInfoUpdatedProps = {
+}>;
+type TeamInfoUpdatedProps = Partial<{
     userId: string;
     tenantId: string;
     userEmail: string;
-};
-type TeamMemberRemovedProps = {
+}>;
+type TeamMemberRemovedProps = Partial<{
     userId: string;
     removedUserId: string;
     tenantId: string;
     userEmail: string;
-};
-type TestErrorProps = {
+}>;
+type TestErrorProps = Partial<{
     userId: string;
     tenantId: string;
-};
-type TestEventProps = {
-    success: string;
-};
-type UserForcedReloadedProps = {
+}>;
+type TestEventProps = Partial<{
+    success: boolean;
+}>;
+type UserForcedReloadedProps = Partial<{
     appName: string;
-};
-type OwnerStatementOpenedProps = {
+}>;
+type OwnerStatementOpenedProps = Partial<{
     userId: string;
     tenantId: string;
     userEmail: string;
     listingId: string;
     startAt: string;
-};
+}>;
 type ListingActivated = any;
 type ListingDeactivated = any;
 type ListingsReported = any;