@flowio/types 11.24.38 → 11.24.40

package/src/api.ts

@@ -2295,11 +2295,13 @@ declare namespace io.flow.v0.enums {
   type Environment = 'sandbox' | 'production';
   type EventType =
     | 'transaction_upserted'
-    | 'transaction_deleted'
+    | 'organization_transaction_upserted'
+    | 'organization_transaction_deleted'
     | 'statement_upserted'
     | 'statement_deleted'
     | 'channel_transaction_upserted'
     | 'channel_transaction_deleted'
+    | 'channel_transaction_deleted_v2'
     | 'channel_statement_upserted'
     | 'channel_statement_deleted'
     | 'attribute_upserted'
@@ -2584,6 +2586,10 @@ declare namespace io.flow.v0.enums {
     | 'insufficient_funds'
     | 'unsupported_currency';
   type MerchantOfRecord = 'flow' | 'organization';
+  type MerchantRejectedReason =
+    | 'merchant_ubo_is_pep'
+    | 'merchant_catalog_is_unsupportable'
+    | 'merchant_failed_kyb_review';
   type Method = 'post';
   type OnboardingApplicationStatus =
     | 'to_do'
@@ -2591,6 +2597,11 @@ declare namespace io.flow.v0.enums {
     | 'on_hold'
     | 'rejected'
     | 'accepted';
+  type OnboardingBlockedReason =
+    | 'street_address_is_blank_3pl'
+    | 'street_address_is_po_box_3pl'
+    | 'business_street_address_is_blank'
+    | 'business_street_address_is_po_box';
   type OnboardingTradeSector =
     | 'accessories'
     | 'animals_and_pet_supplies'
@@ -2997,6 +3008,7 @@ declare namespace io.flow.v0.enums {
     | 'other_adjustment'
     | 'tax_adjustment'
     | 'channel'
+    | 'channel_billed'
     | 'order_service'
     | 'virtual_card_capture'
     | 'virtual_card_refund';
@@ -3445,6 +3457,11 @@ declare namespace io.flow.v0.models {
     readonly display_name?: string;
   }
 
+  interface ApplicationReceived {
+    readonly discriminator: 'application_received';
+    readonly placeholder: boolean;
+  }
+
   interface AtCost {
     readonly discriminator: 'at_cost';
     readonly ignore?: string;
@@ -3795,6 +3812,10 @@ declare namespace io.flow.v0.models {
     readonly account_number: string;
   }
 
+  interface BankAccountReference {
+    readonly id: string;
+  }
+
   interface BehaviorAudit {
     readonly behavior: io.flow.v0.enums.FlowBehavior;
     readonly authentication_techniques: io.flow.v0.enums.AuthenticationTechnique[];
@@ -4505,6 +4526,7 @@ declare namespace io.flow.v0.models {
     readonly withholdings: io.flow.v0.models.WithholdingDeduction[];
     readonly discounts: io.flow.v0.models.BillingDiscount[];
     readonly net: number;
+    readonly identifiers: Record<string, string>;
     readonly created_at: string;
   }
 
@@ -4516,6 +4538,14 @@ declare namespace io.flow.v0.models {
     readonly channel_transaction: io.flow.v0.models.ChannelTransaction;
   }
 
+  interface ChannelTransactionDeletedV2 {
+    readonly discriminator: 'channel_transaction_deleted_v2';
+    readonly event_id: string;
+    readonly timestamp: string;
+    readonly channel_id: string;
+    readonly id: string;
+  }
+
   interface ChannelTransactionUpserted {
     readonly discriminator: 'channel_transaction_upserted';
     readonly event_id: string;
@@ -5175,6 +5205,10 @@ declare namespace io.flow.v0.models {
     readonly amount: number;
   }
 
+  interface DefaultBankAccountForm {
+    readonly bank_account_id: string;
+  }
+
   interface DeliveredDutySetting {
     readonly default: io.flow.v0.enums.DeliveredDuty;
     readonly available: io.flow.v0.enums.DeliveredDuty[];
@@ -6646,6 +6680,11 @@ declare namespace io.flow.v0.models {
     readonly import: io.flow.v0.models.Import;
   }
 
+  interface InComplianceReview {
+    readonly discriminator: 'in_compliance_review';
+    readonly placeholder: boolean;
+  }
+
   interface InboundCartonFee {
     readonly discriminator: 'inbound_carton_fee';
     readonly amount: io.flow.v0.models.Money;
@@ -7557,6 +7596,11 @@ declare namespace io.flow.v0.models {
     readonly membership: io.flow.v0.models.Membership;
   }
 
+  interface MerchantActivated {
+    readonly discriminator: 'merchant_activated';
+    readonly placeholder: boolean;
+  }
+
   interface MerchantApplicationDeleted {
     readonly discriminator: 'merchant_application_deleted';
     readonly event_id: string;
@@ -7665,6 +7709,12 @@ declare namespace io.flow.v0.models {
     readonly country?: string;
   }
 
+  interface MerchantRejected {
+    readonly discriminator: 'merchant_rejected';
+    readonly reason: io.flow.v0.enums.MerchantRejectedReason;
+    readonly description?: string;
+  }
+
   interface Money {
     readonly amount: number;
     readonly currency: string;
@@ -7762,6 +7812,11 @@ declare namespace io.flow.v0.models {
     readonly status: io.flow.v0.enums.OrganizationStatus;
   }
 
+  interface OnboardingStateTransition {
+    readonly state: io.flow.v0.unions.OnboardingState;
+    readonly started_at: string;
+  }
+
   interface OnlineAuthorization {
     readonly discriminator: 'online_authorization';
     readonly id: string;
@@ -8620,6 +8675,11 @@ declare namespace io.flow.v0.models {
     readonly id: string;
   }
 
+  interface OrganizationDefaultBankAccount {
+    readonly id: string;
+    readonly bank_account: io.flow.v0.models.BankAccountReference;
+  }
+
   interface OrganizationDefaultConfigurations {
     readonly id: string;
     readonly checkout_configuration: io.flow.v0.models.OrganizationConfigurationReference;
@@ -8677,6 +8737,12 @@ declare namespace io.flow.v0.models {
     readonly type?: io.flow.v0.enums.OrganizationType;
   }
 
+  interface OrganizationOnboardingState {
+    readonly organization: io.flow.v0.models.OrganizationReference;
+    readonly transitions: io.flow.v0.models.OnboardingStateTransition[];
+    readonly current_state: io.flow.v0.unions.OnboardingState;
+  }
+
   interface OrganizationPutForm {
     readonly name?: string;
     readonly environment?: io.flow.v0.enums.Environment;
@@ -8777,6 +8843,22 @@ declare namespace io.flow.v0.models {
     readonly organization: io.flow.v0.models.OrganizationReference;
   }
 
+  interface OrganizationTransactionDeleted {
+    readonly discriminator: 'organization_transaction_deleted';
+    readonly event_id: string;
+    readonly timestamp: string;
+    readonly organization: string;
+    readonly id: string;
+  }
+
+  interface OrganizationTransactionUpserted {
+    readonly discriminator: 'organization_transaction_upserted';
+    readonly event_id: string;
+    readonly timestamp: string;
+    readonly organization: string;
+    readonly transaction: io.flow.v0.models.Transaction;
+  }
+
   interface OrganizationUpserted {
     readonly discriminator: 'organization_upserted';
     readonly event_id: string;
@@ -8963,7 +9045,7 @@ declare namespace io.flow.v0.models {
     readonly first_name?: string;
     readonly last_name: string;
     readonly email: string;
-    readonly phone: string;
+    readonly phone?: string;
   }
 
   interface PaymentCryptopay {
@@ -10857,6 +10939,21 @@ declare namespace io.flow.v0.models {
     readonly id: string;
   }
 
+  interface SetupBlocked {
+    readonly discriminator: 'setup_blocked';
+    readonly reasons: io.flow.v0.enums.OnboardingBlockedReason[];
+  }
+
+  interface SetupCompleted {
+    readonly discriminator: 'setup_completed';
+    readonly placeholder: boolean;
+  }
+
+  interface SetupInProgress {
+    readonly discriminator: 'setup_in_progress';
+    readonly placeholder: boolean;
+  }
+
   interface ShipmentWindow {
     readonly from: number;
     readonly to: number;
@@ -12223,17 +12320,10 @@ declare namespace io.flow.v0.models {
     readonly withholdings: io.flow.v0.models.WithholdingDeduction[];
     readonly discounts: io.flow.v0.models.BillingDiscount[];
     readonly net: number;
+    readonly identifiers: Record<string, string>;
     readonly created_at: string;
   }
 
-  interface TransactionDeleted {
-    readonly discriminator: 'transaction_deleted';
-    readonly event_id: string;
-    readonly timestamp: string;
-    readonly organization: string;
-    readonly transaction: io.flow.v0.models.Transaction;
-  }
-
   interface TransactionUpserted {
     readonly discriminator: 'transaction_upserted';
     readonly event_id: string;
@@ -12578,11 +12668,13 @@ declare namespace io.flow.v0.unions {
     | io.flow.v0.models.EmailNotificationAbandonedOrder;
   type Event =
     | io.flow.v0.models.TransactionUpserted
-    | io.flow.v0.models.TransactionDeleted
+    | io.flow.v0.models.OrganizationTransactionUpserted
+    | io.flow.v0.models.OrganizationTransactionDeleted
     | io.flow.v0.models.StatementUpserted
     | io.flow.v0.models.StatementDeleted
     | io.flow.v0.models.ChannelTransactionUpserted
     | io.flow.v0.models.ChannelTransactionDeleted
+    | io.flow.v0.models.ChannelTransactionDeletedV2
     | io.flow.v0.models.ChannelStatementUpserted
     | io.flow.v0.models.ChannelStatementDeleted
     | io.flow.v0.models.AttributeUpserted
@@ -12842,6 +12934,14 @@ declare namespace io.flow.v0.unions {
     io.flow.v0.models.ShopifyMerchantApplicationPutForm;
   type MerchantApplicationsSummary =
     io.flow.v0.models.ShopifyMerchantApplicationsSummary;
+  type OnboardingState =
+    | io.flow.v0.models.ApplicationReceived
+    | io.flow.v0.models.InComplianceReview
+    | io.flow.v0.models.SetupInProgress
+    | io.flow.v0.models.MerchantRejected
+    | io.flow.v0.models.SetupBlocked
+    | io.flow.v0.models.SetupCompleted
+    | io.flow.v0.models.MerchantActivated;
   type OnlineAuthorizationDetails =
     | io.flow.v0.models.CryptopayAuthorizationDetails
     | io.flow.v0.models.PaypalAuthorizationDetails
@@ -13109,6 +13209,7 @@ export type AmountMarginForm = io.flow.v0.models.AmountMarginForm;
 export type AnalyticsExportType = io.flow.v0.models.AnalyticsExportType;
 export type ApplePayMerchantValidationPayload =
   io.flow.v0.models.ApplePayMerchantValidationPayload;
+export type ApplicationReceived = io.flow.v0.models.ApplicationReceived;
 export type AtCost = io.flow.v0.models.AtCost;
 export type Attachment = io.flow.v0.models.Attachment;
 export type AttachmentType = io.flow.v0.enums.AttachmentType;
@@ -13195,6 +13296,7 @@ export type B2BInvoiceUpserted = io.flow.v0.models.B2BInvoiceUpserted;
 export type BankAccountForm = io.flow.v0.models.BankAccountForm;
 export type BankAccountInfo = io.flow.v0.unions.BankAccountInfo;
 export type BankAccountInfoUsa = io.flow.v0.models.BankAccountInfoUsa;
+export type BankAccountReference = io.flow.v0.models.BankAccountReference;
 export type BehaviorAudit = io.flow.v0.models.BehaviorAudit;
 export type BillingAddress = io.flow.v0.models.BillingAddress;
 export type BillingChannelOrderSummary =
@@ -13332,6 +13434,8 @@ export type ChannelTokenReference = io.flow.v0.models.ChannelTokenReference;
 export type ChannelTransaction = io.flow.v0.models.ChannelTransaction;
 export type ChannelTransactionDeleted =
   io.flow.v0.models.ChannelTransactionDeleted;
+export type ChannelTransactionDeletedV2 =
+  io.flow.v0.models.ChannelTransactionDeletedV2;
 export type ChannelTransactionUpserted =
   io.flow.v0.models.ChannelTransactionUpserted;
 export type ChannelUpserted = io.flow.v0.models.ChannelUpserted;
@@ -13470,6 +13574,7 @@ export type DatetimeRange = io.flow.v0.models.DatetimeRange;
 export type DatetimeWithTimezone = io.flow.v0.models.DatetimeWithTimezone;
 export type DayOfWeek = io.flow.v0.enums.DayOfWeek;
 export type DdpRatecardFee = io.flow.v0.models.DdpRatecardFee;
+export type DefaultBankAccountForm = io.flow.v0.models.DefaultBankAccountForm;
 export type DeliveredDuty = io.flow.v0.enums.DeliveredDuty;
 export type DeliveredDutyDisplayType =
   io.flow.v0.enums.DeliveredDutyDisplayType;
@@ -13830,6 +13935,7 @@ export type ImportTemplateExample = io.flow.v0.models.ImportTemplateExample;
 export type ImportTemplateForm = io.flow.v0.models.ImportTemplateForm;
 export type ImportType = io.flow.v0.enums.ImportType;
 export type ImportVersion = io.flow.v0.models.ImportVersion;
+export type InComplianceReview = io.flow.v0.models.InComplianceReview;
 export type InboundCartonFee = io.flow.v0.models.InboundCartonFee;
 export type IncludedLevies = io.flow.v0.models.IncludedLevies;
 export type IncludedLevyKey = io.flow.v0.enums.IncludedLevyKey;
@@ -13999,6 +14105,7 @@ export type MembershipForm = io.flow.v0.models.MembershipForm;
 export type MembershipPutForm = io.flow.v0.models.MembershipPutForm;
 export type MembershipUpsertedV2 = io.flow.v0.models.MembershipUpsertedV2;
 export type MembershipVersion = io.flow.v0.models.MembershipVersion;
+export type MerchantActivated = io.flow.v0.models.MerchantActivated;
 export type MerchantApplication = io.flow.v0.unions.MerchantApplication;
 export type MerchantApplicationDeleted =
   io.flow.v0.models.MerchantApplicationDeleted;
@@ -14034,6 +14141,8 @@ export type MerchantOfRecordPaymentForm =
   io.flow.v0.models.MerchantOfRecordPaymentForm;
 export type MerchantOnboardingAddress =
   io.flow.v0.models.MerchantOnboardingAddress;
+export type MerchantRejected = io.flow.v0.models.MerchantRejected;
+export type MerchantRejectedReason = io.flow.v0.enums.MerchantRejectedReason;
 export type Method = io.flow.v0.enums.Method;
 export type Money = io.flow.v0.models.Money;
 export type MoneyWithBase = io.flow.v0.models.MoneyWithBase;
@@ -14052,6 +14161,7 @@ export type NotificationUpsertedV2 = io.flow.v0.models.NotificationUpsertedV2;
 export type NumberRange = io.flow.v0.models.NumberRange;
 export type OnboardingApplicationStatus =
   io.flow.v0.enums.OnboardingApplicationStatus;
+export type OnboardingBlockedReason = io.flow.v0.enums.OnboardingBlockedReason;
 export type OnboardingMerchantPickupWindow =
   io.flow.v0.models.OnboardingMerchantPickupWindow;
 export type OnboardingMerchantScheduledPickup =
@@ -14059,6 +14169,9 @@ export type OnboardingMerchantScheduledPickup =
 export type OnboardingMerchantTime = io.flow.v0.models.OnboardingMerchantTime;
 export type OnboardingOrganizationReference =
   io.flow.v0.models.OnboardingOrganizationReference;
+export type OnboardingState = io.flow.v0.unions.OnboardingState;
+export type OnboardingStateTransition =
+  io.flow.v0.models.OnboardingStateTransition;
 export type OnboardingTradeSector = io.flow.v0.enums.OnboardingTradeSector;
 export type OnlineAuthorization = io.flow.v0.models.OnlineAuthorization;
 export type OnlineAuthorizationDeletedV2 =
@@ -14238,6 +14351,8 @@ export type OrganizationAuthorizationForm =
 export type OrganizationBankAccount = io.flow.v0.models.OrganizationBankAccount;
 export type OrganizationConfigurationReference =
   io.flow.v0.models.OrganizationConfigurationReference;
+export type OrganizationDefaultBankAccount =
+  io.flow.v0.models.OrganizationDefaultBankAccount;
 export type OrganizationDefaultConfigurations =
   io.flow.v0.models.OrganizationDefaultConfigurations;
 export type OrganizationDefaultConfigurationsDeleted =
@@ -14250,6 +14365,8 @@ export type OrganizationDefaults = io.flow.v0.models.OrganizationDefaults;
 export type OrganizationDeleted = io.flow.v0.models.OrganizationDeleted;
 export type OrganizationDeletedV2 = io.flow.v0.models.OrganizationDeletedV2;
 export type OrganizationForm = io.flow.v0.models.OrganizationForm;
+export type OrganizationOnboardingState =
+  io.flow.v0.models.OrganizationOnboardingState;
 export type OrganizationPaymentMethodTag =
   io.flow.v0.enums.OrganizationPaymentMethodTag;
 export type OrganizationPutForm = io.flow.v0.models.OrganizationPutForm;
@@ -14270,6 +14387,10 @@ export type OrganizationTokenReference =
 export type OrganizationTokenV2 = io.flow.v0.models.OrganizationTokenV2;
 export type OrganizationTokenV2Reference =
   io.flow.v0.models.OrganizationTokenV2Reference;
+export type OrganizationTransactionDeleted =
+  io.flow.v0.models.OrganizationTransactionDeleted;
+export type OrganizationTransactionUpserted =
+  io.flow.v0.models.OrganizationTransactionUpserted;
 export type OrganizationType = io.flow.v0.enums.OrganizationType;
 export type OrganizationUpserted = io.flow.v0.models.OrganizationUpserted;
 export type OrganizationUpsertedV2 = io.flow.v0.models.OrganizationUpsertedV2;
@@ -14714,6 +14835,9 @@ export type SessionReference = io.flow.v0.models.SessionReference;
 export type SessionVisit = io.flow.v0.models.SessionVisit;
 export type SessionVisitor = io.flow.v0.models.SessionVisitor;
 export type Settlement = io.flow.v0.unions.Settlement;
+export type SetupBlocked = io.flow.v0.models.SetupBlocked;
+export type SetupCompleted = io.flow.v0.models.SetupCompleted;
+export type SetupInProgress = io.flow.v0.models.SetupInProgress;
 export type ShipmentIntegrationType = io.flow.v0.enums.ShipmentIntegrationType;
 export type ShipmentRecipient = io.flow.v0.enums.ShipmentRecipient;
 export type ShipmentWindow = io.flow.v0.models.ShipmentWindow;
@@ -15003,7 +15127,6 @@ export type TradeAgreementDuty = io.flow.v0.models.TradeAgreementDuty;
 export type TradeAgreementName = io.flow.v0.enums.TradeAgreementName;
 export type TradeAgreementStatus = io.flow.v0.enums.TradeAgreementStatus;
 export type Transaction = io.flow.v0.models.Transaction;
-export type TransactionDeleted = io.flow.v0.models.TransactionDeleted;
 export type TransactionSource = io.flow.v0.enums.TransactionSource;
 export type TransactionUpserted = io.flow.v0.models.TransactionUpserted;
 export type TransitEstimate = io.flow.v0.models.TransitEstimate;