@flowio/api-types 0.0.219 → 0.0.221

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.
@@ -1,4 +1,15 @@
1
1
  declare namespace io.flow.ratecard.v0.models {
2
+ interface AdditionalHandlingServiceFee {
3
+ readonly 'discriminator': 'additional_handling_service_fee';
4
+ readonly 'length_girth_threshold'?: number;
5
+ readonly 'length_threshold'?: number;
6
+ readonly 'width_threshold'?: number;
7
+ readonly 'dimensional_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
8
+ readonly 'weight_threshold'?: number;
9
+ readonly 'weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
10
+ readonly 'amount': io.flow.common.v0.models.Money;
11
+ }
12
+
2
13
  interface CrossdockRatecardFee {
3
14
  readonly 'discriminator': 'crossdock_ratecard_fee';
4
15
  readonly 'amount': io.flow.common.v0.models.Money;
@@ -43,6 +54,17 @@ declare namespace io.flow.ratecard.v0.models {
43
54
  readonly 'ends_at'?: string;
44
55
  }
45
56
 
57
+ interface EeiFilingRatecardFee {
58
+ readonly 'discriminator': 'eei_filing_ratecard_fee';
59
+ readonly 'amount': io.flow.common.v0.models.Money;
60
+ }
61
+
62
+ interface EeiFilingServiceFee {
63
+ readonly 'discriminator': 'eei_filing_service_fee';
64
+ readonly 'amount': io.flow.common.v0.models.Money;
65
+ readonly 'value_threshold': io.flow.common.v0.models.Money;
66
+ }
67
+
46
68
  interface EmergencySituationSurchargeRatecardFee {
47
69
  readonly 'discriminator': 'emergency_situation_surcharge_ratecard_fee';
48
70
  readonly 'amount': io.flow.common.v0.models.Money;
@@ -68,6 +90,31 @@ declare namespace io.flow.ratecard.v0.models {
68
90
  readonly 'unit': io.flow.common.v0.enums.UnitOfMeasurement;
69
91
  }
70
92
 
93
+ interface FixedCurrencyConversionRatecardFee {
94
+ readonly 'discriminator': 'fixed_currency_conversion_ratecard_fee';
95
+ readonly 'amount': io.flow.common.v0.models.Money;
96
+ }
97
+
98
+ interface FixedCurrencyConversionServiceFee {
99
+ readonly 'discriminator': 'fixed_currency_conversion_service_fee';
100
+ readonly 'conditions': io.flow.ratecard.v0.models.FixedFeeCondition[];
101
+ }
102
+
103
+ interface FixedDdpRatecardFee {
104
+ readonly 'discriminator': 'fixed_ddp_ratecard_fee';
105
+ readonly 'amount': io.flow.common.v0.models.Money;
106
+ }
107
+
108
+ interface FixedDdpServiceFee {
109
+ readonly 'discriminator': 'fixed_ddp_service_fee';
110
+ readonly 'conditions': io.flow.ratecard.v0.models.FixedFeeCondition[];
111
+ }
112
+
113
+ interface FixedFeeCondition {
114
+ readonly 'countries': string[];
115
+ readonly 'amount': io.flow.common.v0.models.Money;
116
+ }
117
+
71
118
  interface FuelSurchargeAmountByWeightServiceFee {
72
119
  readonly 'discriminator': 'fuel_surcharge_amount_by_weight_service_fee';
73
120
  readonly 'amount': io.flow.common.v0.models.Money;
@@ -138,6 +185,15 @@ declare namespace io.flow.ratecard.v0.models {
138
185
  readonly 'ratecard': io.flow.ratecard.v0.models.RatecardSummary;
139
186
  }
140
187
 
188
+ interface LargePackageServiceFee {
189
+ readonly 'discriminator': 'large_package_service_fee';
190
+ readonly 'length_girth_threshold'?: number;
191
+ readonly 'dimensional_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
192
+ readonly 'weight_threshold'?: number;
193
+ readonly 'weight_unit'?: io.flow.common.v0.enums.UnitOfMeasurement;
194
+ readonly 'amount': io.flow.common.v0.models.Money;
195
+ }
196
+
141
197
  interface OversizePieceSurchargeRatecardFee {
142
198
  readonly 'discriminator': 'oversize_piece_surcharge_ratecard_fee';
143
199
  readonly 'dimensional_threshold'?: number;
@@ -389,6 +445,12 @@ declare namespace io.flow.ratecard.v0.models {
389
445
  readonly 'ratecard': io.flow.ratecard.v0.models.Ratecard;
390
446
  }
391
447
 
448
+ interface RemoteAreaByWeightServiceFee {
449
+ readonly 'discriminator': 'remote_area_by_weight_service_fee';
450
+ readonly 'amount': io.flow.common.v0.models.Money;
451
+ readonly 'weight_unit': io.flow.common.v0.enums.UnitOfMeasurement;
452
+ }
453
+
392
454
  interface RemoteAreaRatecardFee {
393
455
  readonly 'discriminator': 'remote_area_ratecard_fee';
394
456
  readonly 'amount': io.flow.common.v0.models.Money;
@@ -404,6 +466,17 @@ declare namespace io.flow.ratecard.v0.models {
404
466
  readonly 'amount': number;
405
467
  }
406
468
 
469
+ interface SecurityRatecardFee {
470
+ readonly 'discriminator': 'security_ratecard_fee';
471
+ readonly 'amount': io.flow.common.v0.models.Money;
472
+ }
473
+
474
+ interface SecurityServiceFee {
475
+ readonly 'discriminator': 'security_service_fee';
476
+ readonly 'amount': io.flow.common.v0.models.Money;
477
+ readonly 'countries': string[];
478
+ }
479
+
407
480
  interface ShipmentWindow {
408
481
  readonly 'from': number;
409
482
  readonly 'to': number;
@@ -413,6 +486,6 @@ declare namespace io.flow.ratecard.v0.models {
413
486
  declare namespace io.flow.ratecard.v0.unions {
414
487
  type FuelSurchargeRate = (io.flow.ratecard.v0.models.FuelSurchargePercent | io.flow.ratecard.v0.models.FuelSurchargeByWeight);
415
488
  type RatecardEstimate = (io.flow.ratecard.v0.models.RatecardEstimateV1 | io.flow.ratecard.v0.models.RatecardEstimateV2 | io.flow.ratecard.v0.models.RatecardEstimateV3 | io.flow.ratecard.v0.models.RatecardEstimateV4);
416
- type RatecardFee = (io.flow.ratecard.v0.models.DdpRatecardFee | io.flow.ratecard.v0.models.FuelSurchargeRatecardFee | io.flow.ratecard.v0.models.OversizePieceSurchargeRatecardFee | io.flow.ratecard.v0.models.ReturnPackageRatecardFee | io.flow.ratecard.v0.models.CrossdockRatecardFee | io.flow.ratecard.v0.models.RemoteAreaRatecardFee | io.flow.ratecard.v0.models.EmergencySituationSurchargeRatecardFee | io.flow.ratecard.v0.models.PeakSurchargeRatecardFee | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeRatecardFee);
417
- type ServiceFee = (io.flow.ratecard.v0.models.FuelSurchargeServiceFee | io.flow.ratecard.v0.models.FuelSurchargeAmountByWeightServiceFee | io.flow.ratecard.v0.models.RemoteAreaServiceFee | io.flow.ratecard.v0.models.EmergencySituationSurchargeServiceFee | io.flow.ratecard.v0.models.PeakSurchargeServiceFee | io.flow.ratecard.v0.models.PeakSurchargeByWeightServiceFee | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeServiceFee | io.flow.ratecard.v0.models.OversizePieceSurchargeServiceFee);
489
+ type RatecardFee = (io.flow.ratecard.v0.models.DdpRatecardFee | io.flow.ratecard.v0.models.FuelSurchargeRatecardFee | io.flow.ratecard.v0.models.OversizePieceSurchargeRatecardFee | io.flow.ratecard.v0.models.ReturnPackageRatecardFee | io.flow.ratecard.v0.models.CrossdockRatecardFee | io.flow.ratecard.v0.models.RemoteAreaRatecardFee | io.flow.ratecard.v0.models.EmergencySituationSurchargeRatecardFee | io.flow.ratecard.v0.models.PeakSurchargeRatecardFee | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeRatecardFee | io.flow.ratecard.v0.models.SecurityRatecardFee | io.flow.ratecard.v0.models.EeiFilingRatecardFee | io.flow.ratecard.v0.models.FixedDdpRatecardFee | io.flow.ratecard.v0.models.FixedCurrencyConversionRatecardFee);
490
+ type ServiceFee = (io.flow.ratecard.v0.models.FuelSurchargeServiceFee | io.flow.ratecard.v0.models.FuelSurchargeAmountByWeightServiceFee | io.flow.ratecard.v0.models.RemoteAreaServiceFee | io.flow.ratecard.v0.models.EmergencySituationSurchargeServiceFee | io.flow.ratecard.v0.models.PeakSurchargeServiceFee | io.flow.ratecard.v0.models.PeakSurchargeByWeightServiceFee | io.flow.ratecard.v0.models.DutiesTaxesPaidSurchargeServiceFee | io.flow.ratecard.v0.models.OversizePieceSurchargeServiceFee | io.flow.ratecard.v0.models.RemoteAreaByWeightServiceFee | io.flow.ratecard.v0.models.AdditionalHandlingServiceFee | io.flow.ratecard.v0.models.LargePackageServiceFee | io.flow.ratecard.v0.models.SecurityServiceFee | io.flow.ratecard.v0.models.FixedDdpServiceFee | io.flow.ratecard.v0.models.FixedCurrencyConversionServiceFee | io.flow.ratecard.v0.models.EeiFilingServiceFee);
418
491
  }
@@ -22,7 +22,7 @@ declare namespace io.flow.stripe.v0.enums {
22
22
  type OrderItemType = 'sku' | 'tax' | 'shipping' | 'discount';
23
23
  type PaymentIntentStatus = 'canceled' | 'processing' | 'requires_action' | 'requires_capture' | 'requires_confirmation' | 'requires_payment_method' | 'succeeded';
24
24
  type PaymentMethodCategoryKlarna = 'pay_later' | 'pay_now' | 'pay_with_financing' | 'pay_in_installments';
25
- type PaymentMethodType = 'card' | 'card_present';
25
+ type PaymentMethodType = 'card' | 'card_present' | 'klarna';
26
26
  type PaymentOutcomeType = 'authorized' | 'manual_review' | 'issuer_declined' | 'blocked' | 'invalid';
27
27
  type PaymentStatus = 'succeeded' | 'pending' | 'failed';
28
28
  type PreferredLocaleKlarna = 'de-AT' | 'en-AT' | 'nl-BE' | 'fr-BE' | 'en-BE' | 'de-DE' | 'en-DE' | 'da-DK' | 'en-DK' | 'es-ES' | 'en-ES' | 'fi-FI' | 'sv-FI' | 'en-FI' | 'en-GB' | 'en-IE' | 'it-IT' | 'en-IT' | 'nl-NL' | 'en-NL' | 'nb-NO' | 'en-NO' | 'sv-SE' | 'en-SE' | 'en-US' | 'es-US' | 'fr-FR' | 'en-FR' | 'cs-CZ' | 'en-CZ' | 'el-GR' | 'en-GR' | 'en-AU' | 'en-NZ' | 'en-CA' | 'fr-CA' | 'pl-PL' | 'en-PL' | 'pt-PT' | 'en-PT' | 'de-CH' | 'fr-CH' | 'it-CH' | 'en-CH';
@@ -280,6 +280,12 @@ declare namespace io.flow.stripe.v0.models {
280
280
  readonly 'marketplace_seller_info'?: io.flow.stripe.v0.models.KlarnaMarketplaceSellerInfo[];
281
281
  }
282
282
 
283
+ interface KlarnaDobForm {
284
+ readonly 'day': number;
285
+ readonly 'month': number;
286
+ readonly 'year': number;
287
+ }
288
+
283
289
  interface KlarnaMarketplaceSellerInfo {
284
290
  readonly 'sub_merchant_id'?: string;
285
291
  readonly 'product_category'?: string;
@@ -289,6 +295,12 @@ declare namespace io.flow.stripe.v0.models {
289
295
  readonly 'additional_owners'?: io.flow.stripe.v0.models.Owner[];
290
296
  }
291
297
 
298
+ interface MarketplaceSellerInfo {
299
+ readonly 'name': string;
300
+ readonly 'id'?: string;
301
+ readonly 'product_category'?: string;
302
+ }
303
+
292
304
  interface Masterpass {
293
305
  readonly 'type': 'masterpass';
294
306
  readonly 'masterpass': io.flow.stripe.v0.models.MasterpassInformation;
@@ -377,6 +389,10 @@ declare namespace io.flow.stripe.v0.models {
377
389
  readonly 'verified_phone'?: string;
378
390
  }
379
391
 
392
+ interface PaymentDetails {
393
+ readonly 'marketplace_seller_info'?: io.flow.stripe.v0.models.MarketplaceSellerInfo;
394
+ }
395
+
380
396
  interface PaymentIntent {
381
397
  readonly 'id': string;
382
398
  readonly 'object': string;
@@ -501,6 +517,7 @@ declare namespace io.flow.stripe.v0.models {
501
517
  readonly 'billing_details'?: io.flow.stripe.v0.models.PaymentMethodBillingDetails;
502
518
  readonly 'card'?: io.flow.stripe.v0.models.PaymentMethodCardDetails;
503
519
  readonly 'card_present'?: any/*object*/;
520
+ readonly 'klarna'?: any/*object*/;
504
521
  readonly 'created': number;
505
522
  readonly 'customer'?: string;
506
523
  readonly 'livemode': boolean;
@@ -541,6 +558,13 @@ declare namespace io.flow.stripe.v0.models {
541
558
  readonly 'card': io.flow.stripe.v0.models.PaymentMethodCardForm;
542
559
  }
543
560
 
561
+ interface PaymentMethodDataKlarna {
562
+ readonly 'type': 'klarna';
563
+ readonly 'billing_details'?: io.flow.stripe.v0.models.PaymentMethodBillingDetails;
564
+ readonly 'metadata'?: any/*object*/;
565
+ readonly 'klarna': io.flow.stripe.v0.models.PaymentMethodKlarnaForm;
566
+ }
567
+
544
568
  interface PaymentMethodDetailsCard {
545
569
  readonly 'type': 'card';
546
570
  readonly 'card': io.flow.stripe.v0.models.PaymentMethodDetailsCardInformation;
@@ -589,8 +613,20 @@ declare namespace io.flow.stripe.v0.models {
589
613
  readonly 'card': io.flow.stripe.v0.models.PaymentMethodCardForm;
590
614
  }
591
615
 
616
+ interface PaymentMethodFormKlarna {
617
+ readonly 'type': 'klarna';
618
+ readonly 'billing_details'?: io.flow.stripe.v0.models.PaymentMethodBillingDetails;
619
+ readonly 'metadata'?: any/*object*/;
620
+ readonly 'klarna': io.flow.stripe.v0.models.PaymentMethodKlarnaForm;
621
+ }
622
+
623
+ interface PaymentMethodKlarnaForm {
624
+ readonly 'dob'?: io.flow.stripe.v0.models.KlarnaDobForm;
625
+ }
626
+
592
627
  interface PaymentMethodOptions {
593
628
  readonly 'card'?: io.flow.stripe.v0.models.PaymentMethodOptionsCard;
629
+ readonly 'klarna'?: io.flow.stripe.v0.models.PaymentMethodOptionsKlarna;
594
630
  }
595
631
 
596
632
  interface PaymentMethodOptionsCard {
@@ -610,6 +646,21 @@ declare namespace io.flow.stripe.v0.models {
610
646
 
611
647
  interface PaymentMethodOptionsForm {
612
648
  readonly 'card'?: io.flow.stripe.v0.models.PaymentMethodOptionsCardForm;
649
+ readonly 'klarna'?: io.flow.stripe.v0.models.PaymentMethodOptionsKlarnaForm;
650
+ }
651
+
652
+ interface PaymentMethodOptionsKlarna {
653
+ readonly 'capture_method'?: io.flow.stripe.v0.enums.CaptureMethod;
654
+ readonly 'preferred_locale'?: io.flow.stripe.v0.enums.PreferredLocaleKlarna;
655
+ readonly 'setup_future_usage'?: io.flow.stripe.v0.enums.SetupFutureUsage;
656
+ readonly 'payment_details'?: io.flow.stripe.v0.models.PaymentDetails;
657
+ }
658
+
659
+ interface PaymentMethodOptionsKlarnaForm {
660
+ readonly 'capture_method'?: io.flow.stripe.v0.enums.CaptureMethod;
661
+ readonly 'preferred_locale'?: io.flow.stripe.v0.enums.PreferredLocaleKlarna;
662
+ readonly 'setup_future_usage'?: io.flow.stripe.v0.enums.SetupFutureUsage;
663
+ readonly 'payment_details'?: io.flow.stripe.v0.models.PaymentDetails;
613
664
  }
614
665
 
615
666
  interface PaymentOutcome {
@@ -907,7 +958,7 @@ declare namespace io.flow.stripe.v0.models {
907
958
 
908
959
  declare namespace io.flow.stripe.v0.unions {
909
960
  type CardWallet = (io.flow.stripe.v0.models.Masterpass | io.flow.stripe.v0.models.ApplePay | io.flow.stripe.v0.models.VisaCheckout);
910
- type PaymentMethodData = (io.flow.stripe.v0.models.PaymentMethodDataCard);
961
+ type PaymentMethodData = (io.flow.stripe.v0.models.PaymentMethodDataCard | io.flow.stripe.v0.models.PaymentMethodDataKlarna);
911
962
  type PaymentMethodDetails = (io.flow.stripe.v0.models.PaymentMethodDetailsCard | io.flow.stripe.v0.models.PaymentMethodDetailsKlarna);
912
- type PaymentMethodForm = (io.flow.stripe.v0.models.PaymentMethodFormCard);
963
+ type PaymentMethodForm = (io.flow.stripe.v0.models.PaymentMethodFormCard | io.flow.stripe.v0.models.PaymentMethodFormKlarna);
913
964
  }
@@ -1,6 +1,6 @@
1
1
  declare namespace io.flow.trueup.v0.enums {
2
2
  type CarrierChargeReason = 'return_to_origin' | 'rejection' | 'other';
3
- type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
3
+ type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security_ratecard_fee' | 'eei_filing_ratecard_fee' | 'fixed_ddp_ratecard_fee' | 'fixed_currency_conversion_ratecard_fee';
4
4
  }
5
5
 
6
6
  declare namespace io.flow.trueup.v0.models {
@@ -66,7 +66,7 @@ declare namespace io.flow.v0.enums {
66
66
  type FeeDeductionType = 'duty_guarantee' | 'mor' | 'fraud' | 'fx' | 'processing' | 'rate_lock' | 'transfer' | 'negative_balance_guarantee';
67
67
  type FlowBehavior = 'view_consumer_data';
68
68
  type FlowEntity = 'flow-usa' | 'flow-irl' | 'flow-can';
69
- type FlowRole = 'organization_admin' | 'organization_merchant' | 'organization_customer_service' | 'organization_fulfillment' | 'organization_marketing' | 'organization_finance' | 'flow_operations' | 'channel_admin' | 'channel_organization_admin';
69
+ type FlowRole = 'organization_admin' | 'organization_merchant' | 'organization_customer_service' | 'organization_fulfillment' | 'organization_marketing' | 'organization_finance' | 'organization_classification' | 'flow_operations' | 'channel_admin' | 'channel_organization_admin';
70
70
  type FraudEmailRuleDecision = 'approved' | 'declined';
71
71
  type FraudLiability = 'flow' | 'organization';
72
72
  type FraudStatus = 'pending' | 'approved' | 'declined' | 'review';
@@ -100,12 +100,13 @@ declare namespace io.flow.v0.enums {
100
100
  type LogisticsFormatPreference = 'shopify_console' | 'existing_3pl_integration' | 'byo_integration';
101
101
  type MarginType = 'fixed' | 'percent';
102
102
  type MeasurementSystem = 'imperial' | 'metric';
103
+ type MerchantDisabledReason = 'merchant_deactivated' | 'merchant_rejected';
103
104
  type MerchantGiftCardErrorCode = 'invalid' | 'expired' | 'empty' | 'insufficient_funds' | 'unsupported_currency';
104
105
  type MerchantOfRecord = 'flow' | 'organization';
105
106
  type MerchantRejectedReason = 'merchant_ubo_is_pep' | 'merchant_catalog_is_unsupportable' | 'merchant_failed_kyb_review';
106
107
  type Method = 'post';
107
108
  type OnboardingApplicationStatus = 'to_do' | 'in_progress' | 'on_hold' | 'rejected' | 'accepted';
108
- type OnboardingBlockedReason = 'street_address_is_blank_3pl' | 'street_address_is_po_box_3pl' | 'business_street_address_is_blank' | 'business_street_address_is_po_box' | 'exception_merchant';
109
+ type OnboardingBlockedReason = 'street_address_is_blank_3pl' | 'street_address_is_po_box_3pl' | 'business_street_address_is_blank' | 'business_street_address_is_po_box' | 'exception_merchant' | 'application_missing';
109
110
  type OnboardingTradeSector = 'accessories' | 'animals_and_pet_supplies' | 'apparel' | 'apparel_and_accessories' | 'arts_and_entertainment' | 'baby_and_toddler' | 'business_and_industrial' | 'cameras_and_optics' | 'electronics' | 'food_beverages_and_tobacco' | 'furniture' | 'gift_cards' | 'hardware' | 'health_and_beauty' | 'home_and_garden' | 'jewelry' | 'luggage_and_bags' | 'mature' | 'media' | 'office_supplies' | 'paper_and_art' | 'religious_and_ceremonial' | 'software' | 'sporting_goods' | 'sports_and_fitness' | 'toys_and_games' | 'toys_hobbies_gifts' | 'vehicles_and_parts' | 'other';
110
111
  type OptinResponseType = 'not_shown' | 'opted_in' | 'opted_out';
111
112
  type OrderChangeSource = 'consumer' | 'retailer' | 'fulfillment' | 'flow' | 'carrier';
@@ -202,9 +203,9 @@ declare namespace io.flow.v0.enums {
202
203
  type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired';
203
204
  type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
204
205
  type TradeAgreementStatus = 'supported' | 'not_supported';
205
- type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'trueup' | 'carrier_charge' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
206
+ type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
206
207
  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
207
- type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
208
+ type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction' | 'security_ratecard_fee' | 'eei_filing_ratecard_fee' | 'fixed_ddp_ratecard_fee' | 'fixed_currency_conversion_ratecard_fee';
208
209
  type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
209
210
  type UnitOfMeasurement = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'cubic_inch' | 'cubic_meter' | 'gram' | 'kilogram' | 'meter' | 'ounce' | 'pound';
210
211
  type UnitOfTime = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
@@ -255,6 +256,10 @@ declare namespace io.flow.v0.models {
255
256
  readonly 'status': io.flow.v0.enums.AbandonedOrderSettingStatus;
256
257
  }
257
258
 
259
+ interface AccountIdReference {
260
+ readonly 'id': string;
261
+ }
262
+
258
263
  interface AccountOrdersExportType {
259
264
  readonly 'discriminator': 'account_orders_export_type';
260
265
  readonly 'statement_id'?: string;
@@ -402,6 +407,17 @@ declare namespace io.flow.v0.models {
402
407
  readonly 'placeholder'?: boolean;
403
408
  }
404
409
 
410
+ interface AdditionalHandlingServiceFee {
411
+ readonly 'discriminator': 'additional_handling_service_fee';
412
+ readonly 'length_girth_threshold'?: number;
413
+ readonly 'length_threshold'?: number;
414
+ readonly 'width_threshold'?: number;
415
+ readonly 'dimensional_unit'?: io.flow.v0.enums.UnitOfMeasurement;
416
+ readonly 'weight_threshold'?: number;
417
+ readonly 'weight_unit'?: io.flow.v0.enums.UnitOfMeasurement;
418
+ readonly 'amount': io.flow.v0.models.Money;
419
+ }
420
+
405
421
  interface AdditionalServicesRequested {
406
422
  readonly 'name': string;
407
423
  readonly 'description'?: string;
@@ -1860,6 +1876,7 @@ declare namespace io.flow.v0.models {
1860
1876
  interface ChannelTransaction {
1861
1877
  readonly 'statement'?: io.flow.v0.models.BillingChannelStatementReference;
1862
1878
  readonly 'id': string;
1879
+ readonly 'account': io.flow.v0.models.AccountIdReference;
1863
1880
  readonly 'metadata'?: io.flow.v0.unions.TransactionMetadata;
1864
1881
  readonly 'order'?: io.flow.v0.models.BillingChannelOrderSummary;
1865
1882
  readonly 'payment_request'?: io.flow.v0.models.BillingChannelPaymentRequestReference;
@@ -3020,6 +3037,17 @@ declare namespace io.flow.v0.models {
3020
3037
  readonly 'ecommerce_platform': io.flow.v0.models.EcommercePlatform;
3021
3038
  }
3022
3039
 
3040
+ interface EeiFilingRatecardFee {
3041
+ readonly 'discriminator': 'eei_filing_ratecard_fee';
3042
+ readonly 'amount': io.flow.v0.models.Money;
3043
+ }
3044
+
3045
+ interface EeiFilingServiceFee {
3046
+ readonly 'discriminator': 'eei_filing_service_fee';
3047
+ readonly 'amount': io.flow.v0.models.Money;
3048
+ readonly 'value_threshold': io.flow.v0.models.Money;
3049
+ }
3050
+
3023
3051
  interface EmailAbandonedOrderPromotion {
3024
3052
  readonly 'discount_form': io.flow.v0.models.DiscountForm;
3025
3053
  readonly 'attributes': Record<string, string>;
@@ -3542,6 +3570,31 @@ declare namespace io.flow.v0.models {
3542
3570
  readonly 'placeholder'?: string;
3543
3571
  }
3544
3572
 
3573
+ interface FixedCurrencyConversionRatecardFee {
3574
+ readonly 'discriminator': 'fixed_currency_conversion_ratecard_fee';
3575
+ readonly 'amount': io.flow.v0.models.Money;
3576
+ }
3577
+
3578
+ interface FixedCurrencyConversionServiceFee {
3579
+ readonly 'discriminator': 'fixed_currency_conversion_service_fee';
3580
+ readonly 'conditions': io.flow.v0.models.FixedFeeCondition[];
3581
+ }
3582
+
3583
+ interface FixedDdpRatecardFee {
3584
+ readonly 'discriminator': 'fixed_ddp_ratecard_fee';
3585
+ readonly 'amount': io.flow.v0.models.Money;
3586
+ }
3587
+
3588
+ interface FixedDdpServiceFee {
3589
+ readonly 'discriminator': 'fixed_ddp_service_fee';
3590
+ readonly 'conditions': io.flow.v0.models.FixedFeeCondition[];
3591
+ }
3592
+
3593
+ interface FixedFeeCondition {
3594
+ readonly 'countries': string[];
3595
+ readonly 'amount': io.flow.v0.models.Money;
3596
+ }
3597
+
3545
3598
  interface FlatRate {
3546
3599
  readonly 'discriminator': 'flat_rate';
3547
3600
  readonly 'price': io.flow.v0.models.Price;
@@ -3562,6 +3615,26 @@ declare namespace io.flow.v0.models {
3562
3615
  readonly 'status': io.flow.v0.enums.SubcatalogItemStatus;
3563
3616
  }
3564
3617
 
3618
+ interface FlowTransaction {
3619
+ readonly 'statement'?: io.flow.v0.models.BillingChannelStatementReference;
3620
+ readonly 'id': string;
3621
+ readonly 'account': io.flow.v0.models.AccountIdReference;
3622
+ readonly 'metadata'?: io.flow.v0.unions.TransactionMetadata;
3623
+ readonly 'order'?: io.flow.v0.models.BillingChannelOrderSummary;
3624
+ readonly 'payment_request'?: io.flow.v0.models.BillingChannelPaymentRequestReference;
3625
+ readonly 'currency': string;
3626
+ readonly 'source': io.flow.v0.enums.TransactionSource;
3627
+ readonly 'parent'?: io.flow.v0.models.ParentTransactionSummary;
3628
+ readonly 'gross': number;
3629
+ readonly 'fees': io.flow.v0.models.FeeDeduction[];
3630
+ readonly 'withholdings': io.flow.v0.models.WithholdingDeduction[];
3631
+ readonly 'discounts': io.flow.v0.models.BillingDiscount[];
3632
+ readonly 'net': number;
3633
+ readonly 'identifiers': Record<string, string>;
3634
+ readonly 'created_at': string;
3635
+ readonly 'updated_at': string;
3636
+ }
3637
+
3565
3638
  interface FraudEmailRule {
3566
3639
  readonly 'id'?: string;
3567
3640
  readonly 'email': string;
@@ -4745,6 +4818,15 @@ declare namespace io.flow.v0.models {
4745
4818
  readonly 'iso_639_2': string;
4746
4819
  }
4747
4820
 
4821
+ interface LargePackageServiceFee {
4822
+ readonly 'discriminator': 'large_package_service_fee';
4823
+ readonly 'length_girth_threshold'?: number;
4824
+ readonly 'dimensional_unit'?: io.flow.v0.enums.UnitOfMeasurement;
4825
+ readonly 'weight_threshold'?: number;
4826
+ readonly 'weight_unit'?: io.flow.v0.enums.UnitOfMeasurement;
4827
+ readonly 'amount': io.flow.v0.models.Money;
4828
+ }
4829
+
4748
4830
  interface Line {
4749
4831
  readonly 'id'?: string;
4750
4832
  readonly 'item_number': string;
@@ -5096,6 +5178,11 @@ declare namespace io.flow.v0.models {
5096
5178
  readonly 'reason': string;
5097
5179
  }
5098
5180
 
5181
+ interface MerchantDisabled {
5182
+ readonly 'discriminator': 'merchant_disabled';
5183
+ readonly 'reason': io.flow.v0.enums.MerchantDisabledReason;
5184
+ }
5185
+
5099
5186
  interface MerchantGiftCardBalance {
5100
5187
  readonly 'amount': number;
5101
5188
  readonly 'currency': string;
@@ -7205,6 +7292,7 @@ declare namespace io.flow.v0.models {
7205
7292
 
7206
7293
  interface PayoutTransaction {
7207
7294
  readonly 'id': string;
7295
+ readonly 'account': io.flow.v0.models.AccountIdReference;
7208
7296
  readonly 'metadata'?: io.flow.v0.unions.TransactionMetadata;
7209
7297
  readonly 'order'?: io.flow.v0.models.BillingChannelOrderSummary;
7210
7298
  readonly 'payment_request'?: io.flow.v0.models.BillingChannelPaymentRequestReference;
@@ -8213,6 +8301,12 @@ declare namespace io.flow.v0.models {
8213
8301
  readonly 'status': io.flow.v0.enums.AvailabilityStatus;
8214
8302
  }
8215
8303
 
8304
+ interface RemoteAreaByWeightServiceFee {
8305
+ readonly 'discriminator': 'remote_area_by_weight_service_fee';
8306
+ readonly 'amount': io.flow.v0.models.Money;
8307
+ readonly 'weight_unit': io.flow.v0.enums.UnitOfMeasurement;
8308
+ }
8309
+
8216
8310
  interface RemoteAreaRatecardFee {
8217
8311
  readonly 'discriminator': 'remote_area_ratecard_fee';
8218
8312
  readonly 'amount': io.flow.v0.models.Money;
@@ -8559,6 +8653,17 @@ declare namespace io.flow.v0.models {
8559
8653
  readonly 'minute_of_hour': string;
8560
8654
  }
8561
8655
 
8656
+ interface SecurityRatecardFee {
8657
+ readonly 'discriminator': 'security_ratecard_fee';
8658
+ readonly 'amount': io.flow.v0.models.Money;
8659
+ }
8660
+
8661
+ interface SecurityServiceFee {
8662
+ readonly 'discriminator': 'security_service_fee';
8663
+ readonly 'amount': io.flow.v0.models.Money;
8664
+ readonly 'countries': string[];
8665
+ }
8666
+
8562
8667
  interface SelectIssuerOptionActionDetails {
8563
8668
  readonly 'discriminator': 'select_issuer_option_action_details';
8564
8669
  readonly 'issuer_options': io.flow.v0.models.IssuerReference[];
@@ -10077,6 +10182,7 @@ declare namespace io.flow.v0.models {
10077
10182
  interface Transaction {
10078
10183
  readonly 'statement'?: io.flow.v0.models.BillingChannelStatementReference;
10079
10184
  readonly 'id': string;
10185
+ readonly 'account': io.flow.v0.models.AccountIdReference;
10080
10186
  readonly 'metadata'?: io.flow.v0.unions.TransactionMetadata;
10081
10187
  readonly 'order'?: io.flow.v0.models.BillingChannelOrderSummary;
10082
10188
  readonly 'payment_request'?: io.flow.v0.models.BillingChannelPaymentRequestReference;
@@ -10106,6 +10212,7 @@ declare namespace io.flow.v0.models {
10106
10212
  readonly 'label_created_at': string;
10107
10213
  readonly 'carrier_id': string;
10108
10214
  readonly 'carrier_tracking_number': string;
10215
+ readonly 'revenue_share_percentage': number;
10109
10216
  readonly 'outbound'?: io.flow.v0.models.TransactionMetadataCarrierChargeOutbound;
10110
10217
  }
10111
10218
 
@@ -10497,7 +10604,7 @@ declare namespace io.flow.v0.unions {
10497
10604
  type MerchantApplicationForm = (io.flow.v0.models.ShopifyMerchantApplicationForm);
10498
10605
  type MerchantApplicationPutForm = (io.flow.v0.models.ShopifyMerchantApplicationPutForm);
10499
10606
  type MerchantApplicationsSummary = (io.flow.v0.models.ShopifyMerchantApplicationsSummary);
10500
- type OnboardingState = (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 | io.flow.v0.models.MerchantDeactivated);
10607
+ type OnboardingState = (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 | io.flow.v0.models.MerchantDeactivated | io.flow.v0.models.MerchantDisabled);
10501
10608
  type OnlineAuthorizationDetails = (io.flow.v0.models.CryptopayAuthorizationDetails | io.flow.v0.models.PaypalAuthorizationDetails | io.flow.v0.models.RedirectAuthorizationDetails | io.flow.v0.models.InlineAuthorizationDetails);
10502
10609
  type OrderInformation = (io.flow.v0.models.OrderInformationFlow | io.flow.v0.models.OrderInformationDetails);
10503
10610
  type OrderNumberGenerator = (io.flow.v0.models.OrderNumberGeneratorUuid | io.flow.v0.models.OrderNumberGeneratorHexadecimal | io.flow.v0.models.OrderNumberGeneratorPrefixSuffix);
@@ -10536,13 +10643,13 @@ declare namespace io.flow.v0.unions {
10536
10643
  type QueryFilter = (io.flow.v0.models.QueryFilterStructured | io.flow.v0.models.QueryFilterUnstructured);
10537
10644
  type QueryFilterForm = (io.flow.v0.models.QueryFilterStructuredForm | io.flow.v0.models.QueryFilterUnstructuredForm);
10538
10645
  type RatecardEstimate = (io.flow.v0.models.RatecardEstimateV1 | io.flow.v0.models.RatecardEstimateV2 | io.flow.v0.models.RatecardEstimateV3 | io.flow.v0.models.RatecardEstimateV4);
10539
- type RatecardFee = (io.flow.v0.models.DdpRatecardFee | io.flow.v0.models.FuelSurchargeRatecardFee | io.flow.v0.models.OversizePieceSurchargeRatecardFee | io.flow.v0.models.ReturnPackageRatecardFee | io.flow.v0.models.CrossdockRatecardFee | io.flow.v0.models.RemoteAreaRatecardFee | io.flow.v0.models.EmergencySituationSurchargeRatecardFee | io.flow.v0.models.PeakSurchargeRatecardFee | io.flow.v0.models.DutiesTaxesPaidSurchargeRatecardFee);
10646
+ type RatecardFee = (io.flow.v0.models.DdpRatecardFee | io.flow.v0.models.FuelSurchargeRatecardFee | io.flow.v0.models.OversizePieceSurchargeRatecardFee | io.flow.v0.models.ReturnPackageRatecardFee | io.flow.v0.models.CrossdockRatecardFee | io.flow.v0.models.RemoteAreaRatecardFee | io.flow.v0.models.EmergencySituationSurchargeRatecardFee | io.flow.v0.models.PeakSurchargeRatecardFee | io.flow.v0.models.DutiesTaxesPaidSurchargeRatecardFee | io.flow.v0.models.SecurityRatecardFee | io.flow.v0.models.EeiFilingRatecardFee | io.flow.v0.models.FixedDdpRatecardFee | io.flow.v0.models.FixedCurrencyConversionRatecardFee);
10540
10647
  type RepeatSchedule = (io.flow.v0.models.RepeatHourly | io.flow.v0.models.RepeatDaily | io.flow.v0.models.RepeatWeekly | io.flow.v0.models.RepeatMonthly);
10541
10648
  type ReservationError = (io.flow.v0.models.NoInventoryReservationError | io.flow.v0.models.ExternalApiTimeoutReservationError | io.flow.v0.models.GenericReservationError);
10542
10649
  type ReturnSource = (io.flow.v0.models.ReturnSourceFlow | io.flow.v0.models.ReturnSourceExternalVendor);
10543
10650
  type SdkAdyenV3AuthenticationToken = (io.flow.v0.models.AdyenV3FingerprintToken | io.flow.v0.models.AdyenV3ChallengeToken);
10544
10651
  type ServiceDescription = (io.flow.v0.models.ServiceSummary | io.flow.v0.models.ServiceUnknown);
10545
- type ServiceFee = (io.flow.v0.models.FuelSurchargeServiceFee | io.flow.v0.models.FuelSurchargeAmountByWeightServiceFee | io.flow.v0.models.RemoteAreaServiceFee | io.flow.v0.models.EmergencySituationSurchargeServiceFee | io.flow.v0.models.PeakSurchargeServiceFee | io.flow.v0.models.PeakSurchargeByWeightServiceFee | io.flow.v0.models.DutiesTaxesPaidSurchargeServiceFee | io.flow.v0.models.OversizePieceSurchargeServiceFee);
10652
+ type ServiceFee = (io.flow.v0.models.FuelSurchargeServiceFee | io.flow.v0.models.FuelSurchargeAmountByWeightServiceFee | io.flow.v0.models.RemoteAreaServiceFee | io.flow.v0.models.EmergencySituationSurchargeServiceFee | io.flow.v0.models.PeakSurchargeServiceFee | io.flow.v0.models.PeakSurchargeByWeightServiceFee | io.flow.v0.models.DutiesTaxesPaidSurchargeServiceFee | io.flow.v0.models.OversizePieceSurchargeServiceFee | io.flow.v0.models.RemoteAreaByWeightServiceFee | io.flow.v0.models.AdditionalHandlingServiceFee | io.flow.v0.models.LargePackageServiceFee | io.flow.v0.models.SecurityServiceFee | io.flow.v0.models.FixedDdpServiceFee | io.flow.v0.models.FixedCurrencyConversionServiceFee | io.flow.v0.models.EeiFilingServiceFee);
10546
10653
  type Session = (io.flow.v0.models.OrganizationSession);
10547
10654
  type SessionAuthorization = (io.flow.v0.models.OrganizationSessionAuthorization);
10548
10655
  type Settlement = (io.flow.v0.models.SettlementNoPayout | io.flow.v0.models.SettlementPayout);
package/index.d.ts CHANGED
@@ -2,6 +2,7 @@
2
2
  /// <reference path="generated/io.flow.adyen.v0.adyen.d.ts" />
3
3
  /// <reference path="generated/io.flow.apple.pay.v0.apple-pay.d.ts" />
4
4
  /// <reference path="generated/io.flow.ben.test.internal.v0.ben-test-internal.d.ts" />
5
+ /// <reference path="generated/io.flow.billing.accounting.v0.billing-accounting.d.ts" />
5
6
  /// <reference path="generated/io.flow.billing.bank.account.v0.billing-bank-account.d.ts" />
6
7
  /// <reference path="generated/io.flow.billing.csv.v0.billing-csv.d.ts" />
7
8
  /// <reference path="generated/io.flow.billing.internal.v0.billing-internal.d.ts" />
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/api-types",
3
- "version": "0.0.219",
3
+ "version": "0.0.221",
4
4
  "description": "Global TypeScript typings for Flow Commerce API",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,5 +14,5 @@
14
14
  "scripts": {
15
15
  "generate": "apibuilder update && node scripts/generate-index.js"
16
16
  },
17
- "gitHead": "2bd18d938f840ec2fa147fa4651350a1bb75b33a"
17
+ "gitHead": "6717f627ae249a5229cfb9b8321accaf3b7e03d1"
18
18
  }