@vrplatform/log 2.0.0-alpha.47 → 2.0.0-alpha.49

package/src/tracking/types.ts

@@ -429,157 +429,177 @@ export type TrackingEvent =
   | ReportEvent
   | TestEvent;
 
-type AccountInvitationAcceptedProps = {
+type WebhookEventType =
+  | 'customer.created'
+  | 'customer.updated'
+  | 'subscription.activated'
+  | 'subscription.cancelled'
+  | 'subscription.created'
+  | 'subscription.errored'
+  | 'subscription.paused'
+  | 'subscription.voided'
+  | 'subscription.charged'
+  | 'payment_method.created'
+  | 'payment_method.errored'
+  | 'payment_method.deleted';
+
+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;
-};
+  status:
+    | 'needs_second_factor'
+    | 'needs_identifier'
+    | 'needs_first_factor'
+    | 'needs_new_password'
+    | null
+    | any;
+}>;
 
-type AccountPasswordResetRequestedProps = {
+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: 'property_manager' | 'partner';
+}>;
 
-type AccountSignupCodeFailedProps = {
+type AccountSignupCodeFailedProps = Partial<{
   firstName: string;
   lastName: string;
   userEmail: string;
   companyName: string;
-  type: string;
-  status: string;
-};
+  type: 'property_manager' | 'partner';
+  status: 'missing_requirements' | 'abandoned' | null | any;
+}>;
 
-type AccountSignupCodeRequestedProps = {
+type AccountSignupCodeRequestedProps = Partial<{
   firstName: string;
   lastName: string;
   userEmail: string;
   companyName: string;
-  type: string;
-};
+  type: 'property_manager' | 'partner';
+}>;
 
-type AccountSignupCompletedProps = {
+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?: string;
+}>;
 
-type ConnectionDeletedProps = {
+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;
-};
+  userType: 'owner' | 'property_manager';
+}>;
 
-type GlOwnerStatementPreviewOpenedProps = {
+type GlOwnerStatementPreviewOpenedProps = Partial<{
   ownerStatementStatus: string;
   ownerStatementId: string;
   ownerStatementUrls: string[];
-  userType: string;
-};
+  userType: 'owner' | 'property_manager';
+}>;
 
-type HyperlineCustomerCreatedProps = {
+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;
@@ -588,10 +608,10 @@ type HyperlineInvoiceReadyProps = {
   customerId: string;
   taxAmount: string;
   readyAt: string;
-};
+}>;
 
-type HyperlineInvoiceSettledProps = {
-  status: string;
+type HyperlineInvoiceSettledProps = Partial<{
+  status: 'settled';
   paymentMethodType: string;
   invoiceId: string;
   amount: number;
@@ -600,49 +620,61 @@ 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;
-};
+  webhookEventType: WebhookEventType;
+}>;
 
-type HyperlinePaymentMethodDeletedProps = {
+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;
-};
+  webhookEventType: WebhookEventType;
+}>;
 
-type HyperlinePaymentMethodErroredProps = {
+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;
-};
+  webhookEventType: WebhookEventType;
+}>;
 
-type HyperlineSubscriptionActivatedProps = {
+type HyperlineSubscriptionActivatedProps = Partial<{
   userId: string;
   tenantId: string;
-  tenantBillingStatus: string;
-  webhookEventType: string;
-};
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: WebhookEventType;
+}>;
 
-type HyperlineSubscriptionCancelledProps = {
+type HyperlineSubscriptionCancelledProps = Partial<{
   trialEndAt: string;
   plan: string;
   subscriptionId: string;
@@ -652,20 +684,20 @@ type HyperlineSubscriptionCancelledProps = {
   customerId: string;
   userId: string;
   tenantId: string;
-  webhookEventType: string;
-  tenantBillingStatus: string;
-};
+  webhookEventType: WebhookEventType;
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+}>;
 
-type HyperlineSubscriptionChargedProps = {
+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;
@@ -673,105 +705,98 @@ type HyperlineSubscriptionCreatedProps = {
   subscriptionStatus: string;
   paymentMethodType: string;
   customerId: string;
-};
+}>;
 
-type HyperlineSubscriptionErroredProps = {
+type HyperlineSubscriptionErroredProps = Partial<{
   userId: string;
   tenantId: string;
-  tenantBillingStatus: string;
-  webhookEventType: string;
-};
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: WebhookEventType;
+}>;
 
-type HyperlineSubscriptionPausedProps = {
+type HyperlineSubscriptionPausedProps = Partial<{
   userId: string;
   tenantId: string;
-  tenantBillingStatus: string;
-  webhookEventType: string;
-};
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: WebhookEventType;
+}>;
 
-type HyperlineSubscriptionVoidedProps = {
+type HyperlineSubscriptionVoidedProps = Partial<{
   userId: string;
   tenantId: string;
-  tenantBillingStatus: string;
-  webhookEventType: string;
-};
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: WebhookEventType;
+}>;
 
-type HyperlineTrialEndedProps = {
+type HyperlineTrialEndedProps = Partial<{
   trialStartDate: string;
   trialEndDate: string;
   plan: string;
   subscriptionId: string;
   subscriptionStartDate: string;
   subscriptionStatus: string;
-  paymentMethodType: string;
-};
+  paymentMethodType: 'card';
+}>;
 
-type HyperlineTrialStartedProps = {
+type HyperlineTrialStartedProps = Partial<{
   tenantId: string;
   userId: string;
-  tenantBillingStatus: string;
-  webhookEventType: string;
-};
+  tenantBillingStatus: 'pending' | 'active' | 'canceled';
+  webhookEventType: WebhookEventType;
+}>;
 
-type OwnerCreatedProps = {
+type OwnerCreatedProps = Partial<{
   userId: string;
   tenantId: string;
   ownerId: string;
-};
+}>;
 
-type OwnerDeletedProps = {
+type OwnerDeletedProps = Partial<{
   userId: string;
   tenantId: string;
   ownerId: string;
-};
+}>;
 
-type OwnerTaxInfoModalOpenedProps = {
-  userId: string;
-  tenantId: string;
-  ownerId: string;
-  taxId: string;
-};
+type OwnerTaxInfoModalOpenedProps = Partial<{
+  flag: string;
+}>;
 
-type OwnerTaxInfoModalSubmittedProps = {
-  userId: string;
-  tenantId: string;
-  ownerId: string;
-  taxId: string;
-  status: string;
-};
+type OwnerTaxInfoModalSubmittedProps = Partial<{
+  flag: string;
+}>;
 
-type OwnerUpdatedProps = {
+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;
 
@@ -781,88 +806,88 @@ 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 TestEventProps = Partial<{
+  success: boolean;
+}>;
 
-type UserForcedReloadedProps = {
+type UserForcedReloadedProps = Partial<{
   appName: string;
-};
+}>;
 
-type OwnerStatementOpenedProps = {
+type OwnerStatementOpenedProps = Partial<{
   userId: string;
   tenantId: string;
   userEmail: string;
   listingId: string;
   startAt: string;
-};
+}>;
 
 type ListingActivated = any;