@flowio/types 11.24.113 → 11.24.115

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
@@ -267,17 +267,52 @@ declare namespace io.flow.stripe.v0.enums {
267
267
  type CheckOutcome = 'pass' | 'fail' | 'unavailable' | 'unchecked';
268
268
  type CodeVerificationStatus = 'pending' | 'succeeded' | 'failed';
269
269
  type ConfirmationMethod = 'automatic' | 'manual';
270
- type ConnectReportReportingCategory =
271
- | 'charge'
272
- | 'refund'
270
+ type ConnectReportBalanceReportingCategory =
271
+ | 'anticipation_repayment'
272
+ | 'climate_order_purchase'
273
+ | 'climate_order_refund'
274
+ | 'contribution'
275
+ | 'currency_conversion'
276
+ | 'fee'
277
+ | 'other_adjustment'
278
+ | 'payment_network_reserve_hold'
279
+ | 'payment_network_reserve_release'
280
+ | 'payout'
281
+ | 'payout_minimum_balance_hold'
282
+ | 'payout_minimum_balance_release'
273
283
  | 'payout_reversal'
284
+ | 'risk_reserved_funds'
285
+ | 'stripe_balance_payment_debit'
286
+ | 'stripe_balance_payment_debit_reversal'
287
+ | 'topup'
288
+ | 'topup_reversal'
289
+ | 'unreconciled_customer_funds';
290
+ type ConnectReportConnectReportingCategory =
291
+ | 'advance'
292
+ | 'advance_funding'
293
+ | 'connect_collection_transfer'
294
+ | 'connect_reserved_funds'
295
+ | 'platform_earning'
296
+ | 'platform_earning_refund'
274
297
  | 'transfer'
275
298
  | 'transfer_reversal';
276
- type ConnectReportShopPlan = 'shopify_plus' | 'standard';
277
- type ConnectReportTransferType =
278
- | 'ManagedMarketsRefundDebit'
279
- | 'ManagedMarketsDutiesAndTaxesAdjustmentDebit'
280
- | 'ManagedMarketsDisputedAmountDebit';
299
+ type ConnectReportIssuingReportingCategory =
300
+ | 'issuing_authorization_hold'
301
+ | 'issuing_authorization_release'
302
+ | 'issuing_disbursement'
303
+ | 'issuing_dispute'
304
+ | 'issuing_dispute_fraud_liability_debit'
305
+ | 'issuing_dispute_provisional_credit'
306
+ | 'issuing_dispute_provisional_credit_reversal'
307
+ | 'issuing_transaction';
308
+ type ConnectReportPaymentReportingCategory =
309
+ | 'charge'
310
+ | 'charge_failure'
311
+ | 'dispute'
312
+ | 'dispute_reversal'
313
+ | 'partial_capture_reversal'
314
+ | 'refund'
315
+ | 'refund_failure';
281
316
  type DeclineCode =
282
317
  | 'approve_with_id'
283
318
  | 'call_issuer'
@@ -886,46 +921,6 @@ declare namespace io.flow.stripe.v0.models {
886
921
  readonly status: io.flow.stripe.v0.enums.CodeVerificationStatus;
887
922
  }
888
923
 
889
- interface ConnectReportRecord {
890
- readonly created_utc: string;
891
- readonly charge_id?: string;
892
- readonly payment_intent_id?: string;
893
- readonly gross: number;
894
- readonly fee: number;
895
- readonly net: number;
896
- readonly currency: string;
897
- readonly connected_account: string;
898
- readonly reporting_category: io.flow.stripe.v0.enums.ConnectReportReportingCategory;
899
- readonly dispute_reason?: io.flow.stripe.v0.enums.DisputeReason;
900
- readonly available_on_utc: string;
901
- readonly automatic_payout_effective_at_utc?: string;
902
- readonly source_id?: string;
903
- readonly customer_facing_amount?: number;
904
- readonly customer_facing_currency?: string;
905
- readonly payment_method_type?: string;
906
- readonly card_brand?: string;
907
- readonly statement_descriptor?: string;
908
- readonly payment_metadata?: io.flow.stripe.v0.models.ConnectReportRecordPaymentMetadata;
909
- readonly transfer_metadata?: any /*object*/;
910
- }
911
-
912
- interface ConnectReportRecordPaymentMetadata {
913
- readonly shop_id?: number;
914
- readonly shop_plan?: io.flow.stripe.v0.enums.ConnectReportShopPlan;
915
- readonly checkout_id?: string;
916
- readonly order_id?: number;
917
- readonly order_transaction_id?: number;
918
- readonly transfer_type?: io.flow.stripe.v0.enums.ConnectReportTransferType;
919
- readonly transfer_exchange_rate?: number;
920
- readonly charge_total?: number;
921
- readonly charge_currency?: string;
922
- readonly charge_exchange_rate?: number;
923
- readonly duties?: number;
924
- readonly import_taxes?: number;
925
- readonly mor_fee?: number;
926
- readonly fx_fee?: number;
927
- }
928
-
929
924
  interface Customer {
930
925
  readonly id: string;
931
926
  readonly object: string;
@@ -1932,6 +1927,25 @@ declare namespace io.flow.stripe.v0.unions {
1932
1927
  | io.flow.stripe.v0.models.Masterpass
1933
1928
  | io.flow.stripe.v0.models.ApplePay
1934
1929
  | io.flow.stripe.v0.models.VisaCheckout;
1930
+
1931
+ type ConnectReportReportingCategory =
1932
+ | {
1933
+ discriminator: 'connect_report_payment_reporting_category';
1934
+ value: io.flow.stripe.v0.enums.ConnectReportPaymentReportingCategory;
1935
+ }
1936
+ | {
1937
+ discriminator: 'connect_report_balance_reporting_category';
1938
+ value: io.flow.stripe.v0.enums.ConnectReportBalanceReportingCategory;
1939
+ }
1940
+ | {
1941
+ discriminator: 'connect_report_issuing_reporting_category';
1942
+ value: io.flow.stripe.v0.enums.ConnectReportIssuingReportingCategory;
1943
+ }
1944
+ | {
1945
+ discriminator: 'connect_report_connect_reporting_category';
1946
+ value: io.flow.stripe.v0.enums.ConnectReportConnectReportingCategory;
1947
+ };
1948
+
1935
1949
  type PaymentMethodData =
1936
1950
  | io.flow.stripe.v0.models.PaymentMethodDataCard
1937
1951
  | io.flow.stripe.v0.models.PaymentMethodDataIdeal
@@ -6504,6 +6518,8 @@ declare namespace io.flow.v0.enums {
6504
6518
  | 'virtual_card_refund_deleted'
6505
6519
  | 'authorization_retry_upserted'
6506
6520
  | 'authorization_retry_deleted'
6521
+ | 'transfer_upserted'
6522
+ | 'transfer_deleted'
6507
6523
  | 'payment_request_upserted'
6508
6524
  | 'payment_request_deleted'
6509
6525
  | 'price_book_upserted'
@@ -6565,9 +6581,7 @@ declare namespace io.flow.v0.enums {
6565
6581
  type FulfillmentMethodType = 'fulfillment_method';
6566
6582
  type FulfillmentMethodValue = 'digital' | 'physical';
6567
6583
  type FulfillmentRouting = 'fulfilled_from_center' | 'fulfillment_service';
6568
- type GeCatalogItemIngestionResponse =
6569
- | 'ge_catalog_item_ingestion_success'
6570
- | 'ge_catalog_item_ingestion_failure';
6584
+ type GeCatalogItemIngestionResponse = 'success' | 'failure';
6571
6585
  type GeEnvironment = 'production' | 'sandbox';
6572
6586
  type GeEventType = 'restriction_result' | 'ingestion_result';
6573
6587
  type GenericErrorCode = 'generic_error' | 'client_error' | 'server_error';
@@ -7184,8 +7198,17 @@ declare namespace io.flow.v0.enums {
7184
7198
  | 'virtual_card_refund'
7185
7199
  | 'failed_payout'
7186
7200
  | 'tax_refund'
7201
+ | 'duty_refund'
7187
7202
  | 'non_l4l_tax_duty_fx'
7188
7203
  | 'ge_revenue_share';
7204
+ type TransferStatus = 'succeeded' | 'canceled';
7205
+ type TransferType =
7206
+ | 'payout_to_merchant'
7207
+ | 'disputed_amount_to_merchant'
7208
+ | 'duties_and_taxes_adjustment_to_merchant'
7209
+ | 'disputed_amount_from_merchant'
7210
+ | 'duties_and_taxes_adjustment_from_merchant'
7211
+ | 'refund_from_merchant';
7189
7212
  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
7190
7213
  type TrueupSurchargeType =
7191
7214
  | 'fuel'
@@ -8277,6 +8300,7 @@ declare namespace io.flow.v0.models {
8277
8300
  }
8278
8301
 
8279
8302
  interface CaptureReference {
8303
+ readonly discriminator: 'capture_reference';
8280
8304
  readonly id: string;
8281
8305
  readonly key: string;
8282
8306
  }
@@ -9970,6 +9994,12 @@ declare namespace io.flow.v0.models {
9970
9994
  readonly discounts: io.flow.v0.models.DiscountForm[];
9971
9995
  }
9972
9996
 
9997
+ interface DisputeReference {
9998
+ readonly discriminator: 'dispute_reference';
9999
+ readonly id: string;
10000
+ readonly key: string;
10001
+ }
10002
+
9973
10003
  interface Duration {
9974
10004
  readonly unit: io.flow.v0.enums.UnitOfTime;
9975
10005
  readonly value: number;
@@ -10163,6 +10193,11 @@ declare namespace io.flow.v0.models {
10163
10193
  readonly datetime_range: io.flow.v0.models.DatetimeRange;
10164
10194
  }
10165
10195
 
10196
+ interface ExchangedMoney {
10197
+ readonly fx_rate: number;
10198
+ readonly money: io.flow.v0.models.Money;
10199
+ }
10200
+
10166
10201
  interface ExclusionRule {
10167
10202
  readonly id: string;
10168
10203
  readonly q: string;
@@ -10873,6 +10908,7 @@ declare namespace io.flow.v0.models {
10873
10908
  readonly country_of_origin: string;
10874
10909
  readonly ge_hs6_code: string;
10875
10910
  readonly product_id: string;
10911
+ readonly ge_organization_name: string;
10876
10912
  }
10877
10913
 
10878
10914
  interface GeInputPrice {
@@ -13431,6 +13467,13 @@ declare namespace io.flow.v0.models {
13431
13467
  readonly amount: io.flow.v0.models.Money;
13432
13468
  }
13433
13469
 
13470
+ interface OverweightPieceSurchargeServiceFee {
13471
+ readonly discriminator: 'overweight_piece_surcharge_service_fee';
13472
+ readonly weight_threshold?: number;
13473
+ readonly weight_unit?: io.flow.v0.enums.UnitOfMeasurement;
13474
+ readonly amount: io.flow.v0.models.Money;
13475
+ }
13476
+
13434
13477
  interface PackageDimensions {
13435
13478
  readonly dimensions: io.flow.v0.models.Dimension[];
13436
13479
  }
@@ -14949,6 +14992,8 @@ declare namespace io.flow.v0.models {
14949
14992
  readonly discriminator: 'ratecard_estimate_v4';
14950
14993
  readonly hops: io.flow.v0.models.HopV2[];
14951
14994
  readonly delivered_duty: io.flow.v0.enums.DeliveredDuty;
14995
+ readonly distance_unit_of_measurement?: io.flow.v0.enums.UnitOfMeasurement;
14996
+ readonly weight_unit_of_measurement?: io.flow.v0.enums.UnitOfMeasurement;
14952
14997
  readonly dimensional_weight?: io.flow.v0.models.Measurement;
14953
14998
  readonly gravitational_weight?: io.flow.v0.models.Measurement;
14954
14999
  readonly ratecard_id?: string;
@@ -14962,6 +15007,7 @@ declare namespace io.flow.v0.models {
14962
15007
  interface RatecardForm {
14963
15008
  readonly direction: io.flow.v0.enums.Direction;
14964
15009
  readonly effective_at: string;
15010
+ readonly published_at?: string;
14965
15011
  readonly origination_zones: io.flow.v0.models.Zone[];
14966
15012
  readonly service: string;
14967
15013
  readonly number?: string;
@@ -15257,6 +15303,7 @@ declare namespace io.flow.v0.models {
15257
15303
  }
15258
15304
 
15259
15305
  interface RefundReference {
15306
+ readonly discriminator: 'refund_reference';
15260
15307
  readonly id: string;
15261
15308
  readonly key: string;
15262
15309
  }
@@ -17106,6 +17153,33 @@ declare namespace io.flow.v0.models {
17106
17153
  readonly transaction: io.flow.v0.models.Transaction;
17107
17154
  }
17108
17155
 
17156
+ interface Transfer {
17157
+ readonly id: string;
17158
+ readonly type: io.flow.v0.enums.TransferType;
17159
+ readonly money: io.flow.v0.models.Money;
17160
+ readonly transferred_money: io.flow.v0.models.ExchangedMoney;
17161
+ readonly status: io.flow.v0.enums.TransferStatus;
17162
+ readonly created_at: string;
17163
+ readonly reference: io.flow.v0.unions.TransferReference;
17164
+ readonly transferred_at: string;
17165
+ }
17166
+
17167
+ interface TransferDeleted {
17168
+ readonly discriminator: 'transfer_deleted';
17169
+ readonly event_id: string;
17170
+ readonly timestamp: string;
17171
+ readonly organization: string;
17172
+ readonly id: string;
17173
+ }
17174
+
17175
+ interface TransferUpserted {
17176
+ readonly discriminator: 'transfer_upserted';
17177
+ readonly event_id: string;
17178
+ readonly timestamp: string;
17179
+ readonly organization: string;
17180
+ readonly transfer: io.flow.v0.models.Transfer;
17181
+ }
17182
+
17109
17183
  interface TransitEstimate {
17110
17184
  readonly origin: io.flow.v0.enums.DeliveryWindowLocation;
17111
17185
  readonly destination: io.flow.v0.enums.DeliveryWindowLocation;
@@ -17668,6 +17742,8 @@ declare namespace io.flow.v0.unions {
17668
17742
  | io.flow.v0.models.VirtualCardRefundDeleted
17669
17743
  | io.flow.v0.models.AuthorizationRetryUpserted
17670
17744
  | io.flow.v0.models.AuthorizationRetryDeleted
17745
+ | io.flow.v0.models.TransferUpserted
17746
+ | io.flow.v0.models.TransferDeleted
17671
17747
  | io.flow.v0.models.PaymentRequestUpserted
17672
17748
  | io.flow.v0.models.PaymentRequestDeleted
17673
17749
  | io.flow.v0.models.PriceBookUpserted
@@ -17951,6 +18027,7 @@ declare namespace io.flow.v0.unions {
17951
18027
  | io.flow.v0.models.PeakSurchargeByWeightServiceFee
17952
18028
  | io.flow.v0.models.DutiesTaxesPaidSurchargeServiceFee
17953
18029
  | io.flow.v0.models.OversizePieceSurchargeServiceFee
18030
+ | io.flow.v0.models.OverweightPieceSurchargeServiceFee
17954
18031
  | io.flow.v0.models.RemoteAreaByWeightServiceFee
17955
18032
  | io.flow.v0.models.AdditionalHandlingServiceFee
17956
18033
  | io.flow.v0.models.LargePackageServiceFee
@@ -18012,6 +18089,10 @@ declare namespace io.flow.v0.unions {
18012
18089
  | io.flow.v0.models.TransactionMetadataManual
18013
18090
  | io.flow.v0.models.TransactionMetadataFailedPayout
18014
18091
  | io.flow.v0.models.TransactionMetadataPaymentTransaction;
18092
+ type TransferReference =
18093
+ | io.flow.v0.models.CaptureReference
18094
+ | io.flow.v0.models.RefundReference
18095
+ | io.flow.v0.models.DisputeReference;
18015
18096
  }
18016
18097
 
18017
18098
  export type AbandonedOrderEmailSettings =
@@ -18594,6 +18675,7 @@ export type DiscountRuleSubsidyTarget =
18594
18675
  io.flow.v0.enums.DiscountRuleSubsidyTarget;
18595
18676
  export type DiscountTarget = io.flow.v0.enums.DiscountTarget;
18596
18677
  export type DiscountsForm = io.flow.v0.models.DiscountsForm;
18678
+ export type DisputeReference = io.flow.v0.models.DisputeReference;
18597
18679
  export type Document = io.flow.v0.unions.Document;
18598
18680
  export type Duration = io.flow.v0.models.Duration;
18599
18681
  export type DutiesTaxesPaidSurchargeRatecardFee =
@@ -18644,6 +18726,7 @@ export type Event = io.flow.v0.unions.Event;
18644
18726
  export type EventType = io.flow.v0.enums.EventType;
18645
18727
  export type Exception = io.flow.v0.models.Exception;
18646
18728
  export type ExceptionType = io.flow.v0.enums.ExceptionType;
18729
+ export type ExchangedMoney = io.flow.v0.models.ExchangedMoney;
18647
18730
  export type ExclusionRule = io.flow.v0.models.ExclusionRule;
18648
18731
  export type ExclusionRuleForm = io.flow.v0.models.ExclusionRuleForm;
18649
18732
  export type ExclusionRuleState = io.flow.v0.enums.ExclusionRuleState;
@@ -19354,6 +19437,8 @@ export type OversizePieceSurchargeRatecardFee =
19354
19437
  io.flow.v0.models.OversizePieceSurchargeRatecardFee;
19355
19438
  export type OversizePieceSurchargeServiceFee =
19356
19439
  io.flow.v0.models.OversizePieceSurchargeServiceFee;
19440
+ export type OverweightPieceSurchargeServiceFee =
19441
+ io.flow.v0.models.OverweightPieceSurchargeServiceFee;
19357
19442
  export type PackageDimensions = io.flow.v0.models.PackageDimensions;
19358
19443
  export type PackageDimensionsForm = io.flow.v0.models.PackageDimensionsForm;
19359
19444
  export type PackageDimensionsSource = io.flow.v0.enums.PackageDimensionsSource;
@@ -20178,6 +20263,12 @@ export type TransactionNetworkDetailsCard =
20178
20263
  export type TransactionReference = io.flow.v0.models.TransactionReference;
20179
20264
  export type TransactionSource = io.flow.v0.enums.TransactionSource;
20180
20265
  export type TransactionUpserted = io.flow.v0.models.TransactionUpserted;
20266
+ export type Transfer = io.flow.v0.models.Transfer;
20267
+ export type TransferDeleted = io.flow.v0.models.TransferDeleted;
20268
+ export type TransferReference = io.flow.v0.unions.TransferReference;
20269
+ export type TransferStatus = io.flow.v0.enums.TransferStatus;
20270
+ export type TransferType = io.flow.v0.enums.TransferType;
20271
+ export type TransferUpserted = io.flow.v0.models.TransferUpserted;
20181
20272
  export type TransitEstimate = io.flow.v0.models.TransitEstimate;
20182
20273
  export type TransitWindow = io.flow.v0.models.TransitWindow;
20183
20274
  export type TrueupLabelBase = io.flow.v0.models.TrueupLabelBase;