@flowio/types 11.24.39 → 11.24.40

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/api.ts CHANGED
@@ -2295,11 +2295,13 @@ declare namespace io.flow.v0.enums {
2295
2295
  type Environment = 'sandbox' | 'production';
2296
2296
  type EventType =
2297
2297
  | 'transaction_upserted'
2298
- | 'transaction_deleted'
2298
+ | 'organization_transaction_upserted'
2299
+ | 'organization_transaction_deleted'
2299
2300
  | 'statement_upserted'
2300
2301
  | 'statement_deleted'
2301
2302
  | 'channel_transaction_upserted'
2302
2303
  | 'channel_transaction_deleted'
2304
+ | 'channel_transaction_deleted_v2'
2303
2305
  | 'channel_statement_upserted'
2304
2306
  | 'channel_statement_deleted'
2305
2307
  | 'attribute_upserted'
@@ -2584,6 +2586,10 @@ declare namespace io.flow.v0.enums {
2584
2586
  | 'insufficient_funds'
2585
2587
  | 'unsupported_currency';
2586
2588
  type MerchantOfRecord = 'flow' | 'organization';
2589
+ type MerchantRejectedReason =
2590
+ | 'merchant_ubo_is_pep'
2591
+ | 'merchant_catalog_is_unsupportable'
2592
+ | 'merchant_failed_kyb_review';
2587
2593
  type Method = 'post';
2588
2594
  type OnboardingApplicationStatus =
2589
2595
  | 'to_do'
@@ -2591,6 +2597,11 @@ declare namespace io.flow.v0.enums {
2591
2597
  | 'on_hold'
2592
2598
  | 'rejected'
2593
2599
  | 'accepted';
2600
+ type OnboardingBlockedReason =
2601
+ | 'street_address_is_blank_3pl'
2602
+ | 'street_address_is_po_box_3pl'
2603
+ | 'business_street_address_is_blank'
2604
+ | 'business_street_address_is_po_box';
2594
2605
  type OnboardingTradeSector =
2595
2606
  | 'accessories'
2596
2607
  | 'animals_and_pet_supplies'
@@ -2997,6 +3008,7 @@ declare namespace io.flow.v0.enums {
2997
3008
  | 'other_adjustment'
2998
3009
  | 'tax_adjustment'
2999
3010
  | 'channel'
3011
+ | 'channel_billed'
3000
3012
  | 'order_service'
3001
3013
  | 'virtual_card_capture'
3002
3014
  | 'virtual_card_refund';
@@ -3445,6 +3457,11 @@ declare namespace io.flow.v0.models {
3445
3457
  readonly display_name?: string;
3446
3458
  }
3447
3459
 
3460
+ interface ApplicationReceived {
3461
+ readonly discriminator: 'application_received';
3462
+ readonly placeholder: boolean;
3463
+ }
3464
+
3448
3465
  interface AtCost {
3449
3466
  readonly discriminator: 'at_cost';
3450
3467
  readonly ignore?: string;
@@ -4521,6 +4538,14 @@ declare namespace io.flow.v0.models {
4521
4538
  readonly channel_transaction: io.flow.v0.models.ChannelTransaction;
4522
4539
  }
4523
4540
 
4541
+ interface ChannelTransactionDeletedV2 {
4542
+ readonly discriminator: 'channel_transaction_deleted_v2';
4543
+ readonly event_id: string;
4544
+ readonly timestamp: string;
4545
+ readonly channel_id: string;
4546
+ readonly id: string;
4547
+ }
4548
+
4524
4549
  interface ChannelTransactionUpserted {
4525
4550
  readonly discriminator: 'channel_transaction_upserted';
4526
4551
  readonly event_id: string;
@@ -6655,6 +6680,11 @@ declare namespace io.flow.v0.models {
6655
6680
  readonly import: io.flow.v0.models.Import;
6656
6681
  }
6657
6682
 
6683
+ interface InComplianceReview {
6684
+ readonly discriminator: 'in_compliance_review';
6685
+ readonly placeholder: boolean;
6686
+ }
6687
+
6658
6688
  interface InboundCartonFee {
6659
6689
  readonly discriminator: 'inbound_carton_fee';
6660
6690
  readonly amount: io.flow.v0.models.Money;
@@ -7566,6 +7596,11 @@ declare namespace io.flow.v0.models {
7566
7596
  readonly membership: io.flow.v0.models.Membership;
7567
7597
  }
7568
7598
 
7599
+ interface MerchantActivated {
7600
+ readonly discriminator: 'merchant_activated';
7601
+ readonly placeholder: boolean;
7602
+ }
7603
+
7569
7604
  interface MerchantApplicationDeleted {
7570
7605
  readonly discriminator: 'merchant_application_deleted';
7571
7606
  readonly event_id: string;
@@ -7674,6 +7709,12 @@ declare namespace io.flow.v0.models {
7674
7709
  readonly country?: string;
7675
7710
  }
7676
7711
 
7712
+ interface MerchantRejected {
7713
+ readonly discriminator: 'merchant_rejected';
7714
+ readonly reason: io.flow.v0.enums.MerchantRejectedReason;
7715
+ readonly description?: string;
7716
+ }
7717
+
7677
7718
  interface Money {
7678
7719
  readonly amount: number;
7679
7720
  readonly currency: string;
@@ -7771,6 +7812,11 @@ declare namespace io.flow.v0.models {
7771
7812
  readonly status: io.flow.v0.enums.OrganizationStatus;
7772
7813
  }
7773
7814
 
7815
+ interface OnboardingStateTransition {
7816
+ readonly state: io.flow.v0.unions.OnboardingState;
7817
+ readonly started_at: string;
7818
+ }
7819
+
7774
7820
  interface OnlineAuthorization {
7775
7821
  readonly discriminator: 'online_authorization';
7776
7822
  readonly id: string;
@@ -8691,6 +8737,12 @@ declare namespace io.flow.v0.models {
8691
8737
  readonly type?: io.flow.v0.enums.OrganizationType;
8692
8738
  }
8693
8739
 
8740
+ interface OrganizationOnboardingState {
8741
+ readonly organization: io.flow.v0.models.OrganizationReference;
8742
+ readonly transitions: io.flow.v0.models.OnboardingStateTransition[];
8743
+ readonly current_state: io.flow.v0.unions.OnboardingState;
8744
+ }
8745
+
8694
8746
  interface OrganizationPutForm {
8695
8747
  readonly name?: string;
8696
8748
  readonly environment?: io.flow.v0.enums.Environment;
@@ -8791,6 +8843,22 @@ declare namespace io.flow.v0.models {
8791
8843
  readonly organization: io.flow.v0.models.OrganizationReference;
8792
8844
  }
8793
8845
 
8846
+ interface OrganizationTransactionDeleted {
8847
+ readonly discriminator: 'organization_transaction_deleted';
8848
+ readonly event_id: string;
8849
+ readonly timestamp: string;
8850
+ readonly organization: string;
8851
+ readonly id: string;
8852
+ }
8853
+
8854
+ interface OrganizationTransactionUpserted {
8855
+ readonly discriminator: 'organization_transaction_upserted';
8856
+ readonly event_id: string;
8857
+ readonly timestamp: string;
8858
+ readonly organization: string;
8859
+ readonly transaction: io.flow.v0.models.Transaction;
8860
+ }
8861
+
8794
8862
  interface OrganizationUpserted {
8795
8863
  readonly discriminator: 'organization_upserted';
8796
8864
  readonly event_id: string;
@@ -8977,7 +9045,7 @@ declare namespace io.flow.v0.models {
8977
9045
  readonly first_name?: string;
8978
9046
  readonly last_name: string;
8979
9047
  readonly email: string;
8980
- readonly phone: string;
9048
+ readonly phone?: string;
8981
9049
  }
8982
9050
 
8983
9051
  interface PaymentCryptopay {
@@ -10871,6 +10939,21 @@ declare namespace io.flow.v0.models {
10871
10939
  readonly id: string;
10872
10940
  }
10873
10941
 
10942
+ interface SetupBlocked {
10943
+ readonly discriminator: 'setup_blocked';
10944
+ readonly reasons: io.flow.v0.enums.OnboardingBlockedReason[];
10945
+ }
10946
+
10947
+ interface SetupCompleted {
10948
+ readonly discriminator: 'setup_completed';
10949
+ readonly placeholder: boolean;
10950
+ }
10951
+
10952
+ interface SetupInProgress {
10953
+ readonly discriminator: 'setup_in_progress';
10954
+ readonly placeholder: boolean;
10955
+ }
10956
+
10874
10957
  interface ShipmentWindow {
10875
10958
  readonly from: number;
10876
10959
  readonly to: number;
@@ -12241,14 +12324,6 @@ declare namespace io.flow.v0.models {
12241
12324
  readonly created_at: string;
12242
12325
  }
12243
12326
 
12244
- interface TransactionDeleted {
12245
- readonly discriminator: 'transaction_deleted';
12246
- readonly event_id: string;
12247
- readonly timestamp: string;
12248
- readonly organization: string;
12249
- readonly transaction: io.flow.v0.models.Transaction;
12250
- }
12251
-
12252
12327
  interface TransactionUpserted {
12253
12328
  readonly discriminator: 'transaction_upserted';
12254
12329
  readonly event_id: string;
@@ -12593,11 +12668,13 @@ declare namespace io.flow.v0.unions {
12593
12668
  | io.flow.v0.models.EmailNotificationAbandonedOrder;
12594
12669
  type Event =
12595
12670
  | io.flow.v0.models.TransactionUpserted
12596
- | io.flow.v0.models.TransactionDeleted
12671
+ | io.flow.v0.models.OrganizationTransactionUpserted
12672
+ | io.flow.v0.models.OrganizationTransactionDeleted
12597
12673
  | io.flow.v0.models.StatementUpserted
12598
12674
  | io.flow.v0.models.StatementDeleted
12599
12675
  | io.flow.v0.models.ChannelTransactionUpserted
12600
12676
  | io.flow.v0.models.ChannelTransactionDeleted
12677
+ | io.flow.v0.models.ChannelTransactionDeletedV2
12601
12678
  | io.flow.v0.models.ChannelStatementUpserted
12602
12679
  | io.flow.v0.models.ChannelStatementDeleted
12603
12680
  | io.flow.v0.models.AttributeUpserted
@@ -12857,6 +12934,14 @@ declare namespace io.flow.v0.unions {
12857
12934
  io.flow.v0.models.ShopifyMerchantApplicationPutForm;
12858
12935
  type MerchantApplicationsSummary =
12859
12936
  io.flow.v0.models.ShopifyMerchantApplicationsSummary;
12937
+ type OnboardingState =
12938
+ | io.flow.v0.models.ApplicationReceived
12939
+ | io.flow.v0.models.InComplianceReview
12940
+ | io.flow.v0.models.SetupInProgress
12941
+ | io.flow.v0.models.MerchantRejected
12942
+ | io.flow.v0.models.SetupBlocked
12943
+ | io.flow.v0.models.SetupCompleted
12944
+ | io.flow.v0.models.MerchantActivated;
12860
12945
  type OnlineAuthorizationDetails =
12861
12946
  | io.flow.v0.models.CryptopayAuthorizationDetails
12862
12947
  | io.flow.v0.models.PaypalAuthorizationDetails
@@ -13124,6 +13209,7 @@ export type AmountMarginForm = io.flow.v0.models.AmountMarginForm;
13124
13209
  export type AnalyticsExportType = io.flow.v0.models.AnalyticsExportType;
13125
13210
  export type ApplePayMerchantValidationPayload =
13126
13211
  io.flow.v0.models.ApplePayMerchantValidationPayload;
13212
+ export type ApplicationReceived = io.flow.v0.models.ApplicationReceived;
13127
13213
  export type AtCost = io.flow.v0.models.AtCost;
13128
13214
  export type Attachment = io.flow.v0.models.Attachment;
13129
13215
  export type AttachmentType = io.flow.v0.enums.AttachmentType;
@@ -13348,6 +13434,8 @@ export type ChannelTokenReference = io.flow.v0.models.ChannelTokenReference;
13348
13434
  export type ChannelTransaction = io.flow.v0.models.ChannelTransaction;
13349
13435
  export type ChannelTransactionDeleted =
13350
13436
  io.flow.v0.models.ChannelTransactionDeleted;
13437
+ export type ChannelTransactionDeletedV2 =
13438
+ io.flow.v0.models.ChannelTransactionDeletedV2;
13351
13439
  export type ChannelTransactionUpserted =
13352
13440
  io.flow.v0.models.ChannelTransactionUpserted;
13353
13441
  export type ChannelUpserted = io.flow.v0.models.ChannelUpserted;
@@ -13847,6 +13935,7 @@ export type ImportTemplateExample = io.flow.v0.models.ImportTemplateExample;
13847
13935
  export type ImportTemplateForm = io.flow.v0.models.ImportTemplateForm;
13848
13936
  export type ImportType = io.flow.v0.enums.ImportType;
13849
13937
  export type ImportVersion = io.flow.v0.models.ImportVersion;
13938
+ export type InComplianceReview = io.flow.v0.models.InComplianceReview;
13850
13939
  export type InboundCartonFee = io.flow.v0.models.InboundCartonFee;
13851
13940
  export type IncludedLevies = io.flow.v0.models.IncludedLevies;
13852
13941
  export type IncludedLevyKey = io.flow.v0.enums.IncludedLevyKey;
@@ -14016,6 +14105,7 @@ export type MembershipForm = io.flow.v0.models.MembershipForm;
14016
14105
  export type MembershipPutForm = io.flow.v0.models.MembershipPutForm;
14017
14106
  export type MembershipUpsertedV2 = io.flow.v0.models.MembershipUpsertedV2;
14018
14107
  export type MembershipVersion = io.flow.v0.models.MembershipVersion;
14108
+ export type MerchantActivated = io.flow.v0.models.MerchantActivated;
14019
14109
  export type MerchantApplication = io.flow.v0.unions.MerchantApplication;
14020
14110
  export type MerchantApplicationDeleted =
14021
14111
  io.flow.v0.models.MerchantApplicationDeleted;
@@ -14051,6 +14141,8 @@ export type MerchantOfRecordPaymentForm =
14051
14141
  io.flow.v0.models.MerchantOfRecordPaymentForm;
14052
14142
  export type MerchantOnboardingAddress =
14053
14143
  io.flow.v0.models.MerchantOnboardingAddress;
14144
+ export type MerchantRejected = io.flow.v0.models.MerchantRejected;
14145
+ export type MerchantRejectedReason = io.flow.v0.enums.MerchantRejectedReason;
14054
14146
  export type Method = io.flow.v0.enums.Method;
14055
14147
  export type Money = io.flow.v0.models.Money;
14056
14148
  export type MoneyWithBase = io.flow.v0.models.MoneyWithBase;
@@ -14069,6 +14161,7 @@ export type NotificationUpsertedV2 = io.flow.v0.models.NotificationUpsertedV2;
14069
14161
  export type NumberRange = io.flow.v0.models.NumberRange;
14070
14162
  export type OnboardingApplicationStatus =
14071
14163
  io.flow.v0.enums.OnboardingApplicationStatus;
14164
+ export type OnboardingBlockedReason = io.flow.v0.enums.OnboardingBlockedReason;
14072
14165
  export type OnboardingMerchantPickupWindow =
14073
14166
  io.flow.v0.models.OnboardingMerchantPickupWindow;
14074
14167
  export type OnboardingMerchantScheduledPickup =
@@ -14076,6 +14169,9 @@ export type OnboardingMerchantScheduledPickup =
14076
14169
  export type OnboardingMerchantTime = io.flow.v0.models.OnboardingMerchantTime;
14077
14170
  export type OnboardingOrganizationReference =
14078
14171
  io.flow.v0.models.OnboardingOrganizationReference;
14172
+ export type OnboardingState = io.flow.v0.unions.OnboardingState;
14173
+ export type OnboardingStateTransition =
14174
+ io.flow.v0.models.OnboardingStateTransition;
14079
14175
  export type OnboardingTradeSector = io.flow.v0.enums.OnboardingTradeSector;
14080
14176
  export type OnlineAuthorization = io.flow.v0.models.OnlineAuthorization;
14081
14177
  export type OnlineAuthorizationDeletedV2 =
@@ -14269,6 +14365,8 @@ export type OrganizationDefaults = io.flow.v0.models.OrganizationDefaults;
14269
14365
  export type OrganizationDeleted = io.flow.v0.models.OrganizationDeleted;
14270
14366
  export type OrganizationDeletedV2 = io.flow.v0.models.OrganizationDeletedV2;
14271
14367
  export type OrganizationForm = io.flow.v0.models.OrganizationForm;
14368
+ export type OrganizationOnboardingState =
14369
+ io.flow.v0.models.OrganizationOnboardingState;
14272
14370
  export type OrganizationPaymentMethodTag =
14273
14371
  io.flow.v0.enums.OrganizationPaymentMethodTag;
14274
14372
  export type OrganizationPutForm = io.flow.v0.models.OrganizationPutForm;
@@ -14289,6 +14387,10 @@ export type OrganizationTokenReference =
14289
14387
  export type OrganizationTokenV2 = io.flow.v0.models.OrganizationTokenV2;
14290
14388
  export type OrganizationTokenV2Reference =
14291
14389
  io.flow.v0.models.OrganizationTokenV2Reference;
14390
+ export type OrganizationTransactionDeleted =
14391
+ io.flow.v0.models.OrganizationTransactionDeleted;
14392
+ export type OrganizationTransactionUpserted =
14393
+ io.flow.v0.models.OrganizationTransactionUpserted;
14292
14394
  export type OrganizationType = io.flow.v0.enums.OrganizationType;
14293
14395
  export type OrganizationUpserted = io.flow.v0.models.OrganizationUpserted;
14294
14396
  export type OrganizationUpsertedV2 = io.flow.v0.models.OrganizationUpsertedV2;
@@ -14733,6 +14835,9 @@ export type SessionReference = io.flow.v0.models.SessionReference;
14733
14835
  export type SessionVisit = io.flow.v0.models.SessionVisit;
14734
14836
  export type SessionVisitor = io.flow.v0.models.SessionVisitor;
14735
14837
  export type Settlement = io.flow.v0.unions.Settlement;
14838
+ export type SetupBlocked = io.flow.v0.models.SetupBlocked;
14839
+ export type SetupCompleted = io.flow.v0.models.SetupCompleted;
14840
+ export type SetupInProgress = io.flow.v0.models.SetupInProgress;
14736
14841
  export type ShipmentIntegrationType = io.flow.v0.enums.ShipmentIntegrationType;
14737
14842
  export type ShipmentRecipient = io.flow.v0.enums.ShipmentRecipient;
14738
14843
  export type ShipmentWindow = io.flow.v0.models.ShipmentWindow;
@@ -15022,7 +15127,6 @@ export type TradeAgreementDuty = io.flow.v0.models.TradeAgreementDuty;
15022
15127
  export type TradeAgreementName = io.flow.v0.enums.TradeAgreementName;
15023
15128
  export type TradeAgreementStatus = io.flow.v0.enums.TradeAgreementStatus;
15024
15129
  export type Transaction = io.flow.v0.models.Transaction;
15025
- export type TransactionDeleted = io.flow.v0.models.TransactionDeleted;
15026
15130
  export type TransactionSource = io.flow.v0.enums.TransactionSource;
15027
15131
  export type TransactionUpserted = io.flow.v0.models.TransactionUpserted;
15028
15132
  export type TransitEstimate = io.flow.v0.models.TransitEstimate;