@flowio/api-types 0.0.204 → 0.0.205

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.
@@ -129,9 +129,9 @@ declare namespace io.flow.label.v0.models {
129
129
  }
130
130
 
131
131
  interface ShippingLabelHopCostItemizedEstimate {
132
- readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelUnits;
133
- readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
134
- readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurcharge[];
132
+ readonly 'units': io.flow.trueup.v0.models.LabelUnits;
133
+ readonly 'base': io.flow.trueup.v0.models.LabelBase;
134
+ readonly 'surcharges': io.flow.trueup.v0.models.LabelSurcharge[];
135
135
  }
136
136
 
137
137
  interface ShippingLabelHopSummary {
@@ -143,6 +143,7 @@ declare namespace io.flow.label.v0.models {
143
143
  interface ShippingLabelLaneSummary {
144
144
  readonly 'id'?: string;
145
145
  readonly 'ratecard': io.flow.label.v0.models.ShippingLabelRatecardSummary;
146
+ readonly 'weight_break'?: number;
146
147
  }
147
148
 
148
149
  interface ShippingLabelPackage {
@@ -596,6 +596,7 @@ declare namespace io.flow.payment.v0.models {
596
596
  readonly 'processor': string;
597
597
  readonly 'operation_identifier'?: io.flow.payment.v0.models.PaymentProcessorIdentifier;
598
598
  readonly 'account'?: io.flow.payment.v0.models.PaymentProcessorAccount;
599
+ readonly 'transaction_details'?: io.flow.payment.v0.unions.PaymentProcessorTransactionDetails;
599
600
  }
600
601
 
601
602
  interface PaymentProcessorAccount {
@@ -620,6 +621,17 @@ declare namespace io.flow.payment.v0.models {
620
621
  readonly 'processor': string;
621
622
  }
622
623
 
624
+ interface PaymentProcessorTransactionDetailsCard {
625
+ readonly 'discriminator': 'card';
626
+ readonly 'transaction_identifier'?: string;
627
+ readonly 'method_type'?: string;
628
+ readonly 'result_status'?: string;
629
+ readonly 'reason_code'?: string;
630
+ readonly 'avs_result_code'?: string;
631
+ readonly 'cvv_result_code'?: string;
632
+ readonly 'threeds_result_code'?: string;
633
+ }
634
+
623
635
  interface PaymentReference {
624
636
  readonly 'id': string;
625
637
  }
@@ -956,6 +968,7 @@ declare namespace io.flow.payment.v0.unions {
956
968
  type Payment = (io.flow.payment.v0.models.PaymentPaypal | io.flow.payment.v0.models.PaymentCryptopay);
957
969
  type PaymentForm = (io.flow.payment.v0.models.MerchantOfRecordPaymentForm);
958
970
  type PaymentOrderReference = (io.flow.payment.v0.models.AuthorizationOrderReference | io.flow.payment.v0.models.PaymentPaymentRequestReference);
971
+ type PaymentProcessorTransactionDetails = (io.flow.payment.v0.models.PaymentProcessorTransactionDetailsCard);
959
972
  type PaymentSource = (io.flow.payment.v0.models.CardPaymentSource);
960
973
  type PaymentSourceForm = (io.flow.payment.v0.models.CardPaymentSourceForm);
961
974
  type ThreedsChallengeAction = (io.flow.payment.v0.models.ThreedsTwoChallengeRequest);
@@ -77,9 +77,21 @@ declare namespace io.flow.ratecard.v0.models {
77
77
  readonly 'ends_at'?: string;
78
78
  }
79
79
 
80
+ interface FuelSurchargeByWeight {
81
+ readonly 'discriminator': 'fuel_surcharge_by_weight';
82
+ readonly 'amount': number;
83
+ readonly 'weight_unit': io.flow.common.v0.enums.UnitOfMeasurement;
84
+ }
85
+
86
+ interface FuelSurchargePercent {
87
+ readonly 'discriminator': 'fuel_surcharge_percent';
88
+ readonly 'percent': number;
89
+ }
90
+
80
91
  interface FuelSurchargeRatecardFee {
81
92
  readonly 'discriminator': 'fuel_surcharge_ratecard_fee';
82
93
  readonly 'amount': io.flow.common.v0.models.Money;
94
+ readonly 'fuel_surcharge_rate'?: io.flow.ratecard.v0.unions.FuelSurchargeRate;
83
95
  }
84
96
 
85
97
  interface FuelSurchargeServiceFee {
@@ -111,6 +123,7 @@ declare namespace io.flow.ratecard.v0.models {
111
123
  readonly 'currency': string;
112
124
  readonly 'amount': number;
113
125
  readonly 'fees': io.flow.ratecard.v0.unions.RatecardFee[];
126
+ readonly 'weight_break'?: number;
114
127
  readonly 'total': number;
115
128
  readonly 'lane': io.flow.ratecard.v0.models.LaneSummary;
116
129
  }
@@ -396,6 +409,7 @@ declare namespace io.flow.ratecard.v0.models {
396
409
  }
397
410
 
398
411
  declare namespace io.flow.ratecard.v0.unions {
412
+ type FuelSurchargeRate = (io.flow.ratecard.v0.models.FuelSurchargePercent | io.flow.ratecard.v0.models.FuelSurchargeByWeight);
399
413
  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);
400
414
  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);
401
415
  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);
@@ -21,7 +21,7 @@ declare namespace io.flow.shopify.markets.v0.enums {
21
21
  type ShopifyOrderInventoryBehaviour = 'bypass' | 'decrement_ignoring_policy' | 'decrement_obeying_policy';
22
22
  type ShopifyOrderKindType = 'authorization' | 'capture' | 'sale' | 'void' | 'refund';
23
23
  type ShopifyOrderPaymentGatewayNames = 'flow_commerce' | 'gift_card' | 'manual' | 'shopify_payments';
24
- type ShopifyOrderProcessingMethodType = 'checkout' | 'direct' | 'manual' | 'offsite' | 'express';
24
+ type ShopifyOrderProcessingMethodType = 'checkout' | 'direct' | 'manual' | 'offsite' | 'express' | 'deferred_payment';
25
25
  type ShopifyOrderRestockType = 'no_restock' | 'cancel' | 'return';
26
26
  type ShopifyOrderStatusType = 'open' | 'closed' | 'cancelled' | 'any';
27
27
  type ShopifyOrderTransactionErrorCode = 'incorrect_number' | 'invalid_number' | 'invalid_expiry_date' | 'invalid_cvc' | 'expired_card' | 'incorrect_cvc' | 'incorrect_zip' | 'incorrect_address' | 'card_declined' | 'processing_error' | 'call_issuer' | 'pick_up_card';
@@ -573,6 +573,7 @@ declare namespace io.flow.stripe.v0.models {
573
573
  readonly 'network'?: string;
574
574
  readonly 'request_three_d_secure'?: io.flow.stripe.v0.enums.RequestThreeDSecureType;
575
575
  readonly 'stored_credential_transaction_type'?: io.flow.stripe.v0.enums.StoredCredentialTransactionType;
576
+ readonly 'mcc'?: string;
576
577
  }
577
578
 
578
579
  interface PaymentOutcome {
@@ -0,0 +1,52 @@
1
+ declare namespace io.flow.trueup.v0.enums {
2
+ type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
3
+ }
4
+
5
+ declare namespace io.flow.trueup.v0.models {
6
+ interface DeadWeight {
7
+ readonly 'weight': number;
8
+ }
9
+
10
+ interface DimensionalWeight {
11
+ readonly 'weight': number;
12
+ readonly 'length'?: number;
13
+ readonly 'width'?: number;
14
+ readonly 'height'?: number;
15
+ }
16
+
17
+ interface LabelBase {
18
+ readonly 'amount': number;
19
+ readonly 'weight': number;
20
+ }
21
+
22
+ interface LabelSurcharge {
23
+ readonly 'amount': number;
24
+ readonly 'type': io.flow.trueup.v0.enums.TrueupSurchargeType;
25
+ readonly 'detail': io.flow.trueup.v0.unions.LabelSurchargeDetail;
26
+ }
27
+
28
+ interface LabelSurchargeDetailFlat {
29
+ readonly 'discriminator': 'flat';
30
+ readonly 'placeholder'?: string;
31
+ }
32
+
33
+ interface LabelSurchargeDetailPerWeightUnit {
34
+ readonly 'discriminator': 'per_weight_unit';
35
+ readonly 'fee': number;
36
+ }
37
+
38
+ interface LabelSurchargeDetailPercentage {
39
+ readonly 'discriminator': 'percentage';
40
+ readonly 'percentage': number;
41
+ }
42
+
43
+ interface LabelUnits {
44
+ readonly 'currency': string;
45
+ readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
46
+ readonly 'length': io.flow.units.v0.enums.UnitOfLength;
47
+ }
48
+ }
49
+
50
+ declare namespace io.flow.trueup.v0.unions {
51
+ type LabelSurchargeDetail = (io.flow.trueup.v0.models.LabelSurchargeDetailFlat | io.flow.trueup.v0.models.LabelSurchargeDetailPercentage | io.flow.trueup.v0.models.LabelSurchargeDetailPerWeightUnit);
52
+ }
@@ -140,7 +140,7 @@ declare namespace io.flow.v0.enums {
140
140
  type PaymentType = 'card' | 'klarna' | 'googlepay' | 'paypal' | 'applepay' | 'ideal' | 'sofort' | 'afterpay' | 'bancontact';
141
141
  type PayoutAttachmentType = 'transactions';
142
142
  type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
143
- type PendingPayoutTransactionReasonCode = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'external_fulfillment_missing_tracking_info' | 'waiting_for_positive_account_balance';
143
+ type PendingPayoutTransactionReasonCode = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'waiting_for_tracking_info' | 'waiting_for_positive_account_balance';
144
144
  type PermittedHttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
145
145
  type PhysicalDeliverySpecialSerivce = 'cold_storage' | 'hazardous' | 'perishable';
146
146
  type PostalType = 'eircode' | 'pin' | 'postal' | 'zip';
@@ -1661,6 +1661,18 @@ declare namespace io.flow.v0.models {
1661
1661
  readonly 'id': string;
1662
1662
  }
1663
1663
 
1664
+ interface ChannelCurrencyPair {
1665
+ readonly 'id': string;
1666
+ readonly 'base': string;
1667
+ readonly 'target': string;
1668
+ readonly 'rate': io.flow.v0.models.ChannelCurrencyRate;
1669
+ }
1670
+
1671
+ interface ChannelCurrencyRate {
1672
+ readonly 'id': string;
1673
+ readonly 'value': number;
1674
+ }
1675
+
1664
1676
  interface ChannelCurrencyUpserted {
1665
1677
  readonly 'discriminator': 'channel_currency_upserted';
1666
1678
  readonly 'event_id': string;
@@ -1760,6 +1772,9 @@ declare namespace io.flow.v0.models {
1760
1772
  readonly 'id': string;
1761
1773
  readonly 'reason': io.flow.v0.models.PendingPayoutTransactionReason;
1762
1774
  readonly 'timeout'?: io.flow.v0.models.PendingPayoutTransactionTimeout;
1775
+ readonly 'created_at': string;
1776
+ readonly 'updated_at': string;
1777
+ readonly 'deleted_at'?: string;
1763
1778
  }
1764
1779
 
1765
1780
  interface ChannelPendingPayoutTransactionDeleted {
@@ -2553,6 +2568,10 @@ declare namespace io.flow.v0.models {
2553
2568
  readonly 'reason': string;
2554
2569
  }
2555
2570
 
2571
+ interface DeadWeight {
2572
+ readonly 'weight': number;
2573
+ }
2574
+
2556
2575
  interface DefaultBankAccountForm {
2557
2576
  readonly 'bank_account_id': string;
2558
2577
  }
@@ -2797,6 +2816,13 @@ declare namespace io.flow.v0.models {
2797
2816
  readonly 'dimension_estimate': io.flow.v0.models.DimensionEstimate;
2798
2817
  }
2799
2818
 
2819
+ interface DimensionalWeight {
2820
+ readonly 'weight': number;
2821
+ readonly 'length'?: number;
2822
+ readonly 'width'?: number;
2823
+ readonly 'height'?: number;
2824
+ }
2825
+
2800
2826
  interface Dimensions {
2801
2827
  readonly 'product'?: io.flow.v0.models.Dimension;
2802
2828
  readonly 'packaging'?: io.flow.v0.models.Dimension;
@@ -3644,9 +3670,21 @@ declare namespace io.flow.v0.models {
3644
3670
  readonly 'ends_at'?: string;
3645
3671
  }
3646
3672
 
3673
+ interface FuelSurchargeByWeight {
3674
+ readonly 'discriminator': 'fuel_surcharge_by_weight';
3675
+ readonly 'amount': number;
3676
+ readonly 'weight_unit': io.flow.v0.enums.UnitOfMeasurement;
3677
+ }
3678
+
3679
+ interface FuelSurchargePercent {
3680
+ readonly 'discriminator': 'fuel_surcharge_percent';
3681
+ readonly 'percent': number;
3682
+ }
3683
+
3647
3684
  interface FuelSurchargeRatecardFee {
3648
3685
  readonly 'discriminator': 'fuel_surcharge_ratecard_fee';
3649
3686
  readonly 'amount': io.flow.v0.models.Money;
3687
+ readonly 'fuel_surcharge_rate'?: io.flow.v0.unions.FuelSurchargeRate;
3650
3688
  }
3651
3689
 
3652
3690
  interface FuelSurchargeServiceFee {
@@ -3900,6 +3938,7 @@ declare namespace io.flow.v0.models {
3900
3938
  readonly 'currency': string;
3901
3939
  readonly 'amount': number;
3902
3940
  readonly 'fees': io.flow.v0.unions.RatecardFee[];
3941
+ readonly 'weight_break'?: number;
3903
3942
  readonly 'total': number;
3904
3943
  readonly 'lane': io.flow.v0.models.LaneSummary;
3905
3944
  }
@@ -4553,6 +4592,11 @@ declare namespace io.flow.v0.models {
4553
4592
  readonly 'status': string;
4554
4593
  }
4555
4594
 
4595
+ interface LabelBase {
4596
+ readonly 'amount': number;
4597
+ readonly 'weight': number;
4598
+ }
4599
+
4556
4600
  interface LabelDeletedV2 {
4557
4601
  readonly 'discriminator': 'label_deleted_v2';
4558
4602
  readonly 'event_id': string;
@@ -4587,6 +4631,27 @@ declare namespace io.flow.v0.models {
4587
4631
  readonly 'id': string;
4588
4632
  }
4589
4633
 
4634
+ interface LabelSurcharge {
4635
+ readonly 'amount': number;
4636
+ readonly 'type': io.flow.v0.enums.TrueupSurchargeType;
4637
+ readonly 'detail': io.flow.v0.unions.LabelSurchargeDetail;
4638
+ }
4639
+
4640
+ interface LabelSurchargeDetailFlat {
4641
+ readonly 'discriminator': 'flat';
4642
+ readonly 'placeholder'?: string;
4643
+ }
4644
+
4645
+ interface LabelSurchargeDetailPerWeightUnit {
4646
+ readonly 'discriminator': 'per_weight_unit';
4647
+ readonly 'fee': number;
4648
+ }
4649
+
4650
+ interface LabelSurchargeDetailPercentage {
4651
+ readonly 'discriminator': 'percentage';
4652
+ readonly 'percentage': number;
4653
+ }
4654
+
4590
4655
  interface LabelTrackingCarrierService {
4591
4656
  readonly 'carrier_id': string;
4592
4657
  readonly 'service_id'?: string;
@@ -4608,6 +4673,12 @@ declare namespace io.flow.v0.models {
4608
4673
  readonly 'created_at'?: string;
4609
4674
  }
4610
4675
 
4676
+ interface LabelUnits {
4677
+ readonly 'currency': string;
4678
+ readonly 'weight': io.flow.v0.enums.UnitOfWeight;
4679
+ readonly 'length': io.flow.v0.enums.UnitOfLength;
4680
+ }
4681
+
4611
4682
  interface LabelUpserted {
4612
4683
  readonly 'discriminator': 'label_upserted';
4613
4684
  readonly 'event_id': string;
@@ -6196,6 +6267,9 @@ declare namespace io.flow.v0.models {
6196
6267
  readonly 'id': string;
6197
6268
  readonly 'reason': io.flow.v0.models.PendingPayoutTransactionReason;
6198
6269
  readonly 'timeout'?: io.flow.v0.models.PendingPayoutTransactionTimeout;
6270
+ readonly 'created_at': string;
6271
+ readonly 'updated_at': string;
6272
+ readonly 'deleted_at'?: string;
6199
6273
  }
6200
6274
 
6201
6275
  interface OrganizationPendingPayoutTransactionDeleted {
@@ -6889,6 +6963,7 @@ declare namespace io.flow.v0.models {
6889
6963
  readonly 'processor': string;
6890
6964
  readonly 'operation_identifier'?: io.flow.v0.models.PaymentProcessorIdentifier;
6891
6965
  readonly 'account'?: io.flow.v0.models.PaymentProcessorAccount;
6966
+ readonly 'transaction_details'?: io.flow.v0.unions.PaymentProcessorTransactionDetails;
6892
6967
  }
6893
6968
 
6894
6969
  interface PaymentProcessorAccount {
@@ -6913,6 +6988,17 @@ declare namespace io.flow.v0.models {
6913
6988
  readonly 'processor': string;
6914
6989
  }
6915
6990
 
6991
+ interface PaymentProcessorTransactionDetailsCard {
6992
+ readonly 'discriminator': 'card';
6993
+ readonly 'transaction_identifier'?: string;
6994
+ readonly 'method_type'?: string;
6995
+ readonly 'result_status'?: string;
6996
+ readonly 'reason_code'?: string;
6997
+ readonly 'avs_result_code'?: string;
6998
+ readonly 'cvv_result_code'?: string;
6999
+ readonly 'threeds_result_code'?: string;
7000
+ }
7001
+
6916
7002
  interface PaymentReference {
6917
7003
  readonly 'id': string;
6918
7004
  }
@@ -8739,9 +8825,9 @@ declare namespace io.flow.v0.models {
8739
8825
  }
8740
8826
 
8741
8827
  interface ShippingLabelHopCostItemizedEstimate {
8742
- readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelUnits;
8743
- readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
8744
- readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurcharge[];
8828
+ readonly 'units': io.flow.v0.models.LabelUnits;
8829
+ readonly 'base': io.flow.v0.models.LabelBase;
8830
+ readonly 'surcharges': io.flow.v0.models.LabelSurcharge[];
8745
8831
  }
8746
8832
 
8747
8833
  interface ShippingLabelHopSummary {
@@ -8753,6 +8839,7 @@ declare namespace io.flow.v0.models {
8753
8839
  interface ShippingLabelLaneSummary {
8754
8840
  readonly 'id'?: string;
8755
8841
  readonly 'ratecard': io.flow.v0.models.ShippingLabelRatecardSummary;
8842
+ readonly 'weight_break'?: number;
8756
8843
  }
8757
8844
 
8758
8845
  interface ShippingLabelPackage {
@@ -9996,14 +10083,29 @@ declare namespace io.flow.v0.models {
9996
10083
  readonly 'country': string;
9997
10084
  }
9998
10085
 
10086
+ interface TransactionMetadataManual {
10087
+ readonly 'discriminator': 'manual';
10088
+ readonly 'original': io.flow.v0.models.TransactionMetadataOriginalTransaction;
10089
+ }
10090
+
10091
+ interface TransactionMetadataOriginalTransaction {
10092
+ readonly 'id': string;
10093
+ }
10094
+
9999
10095
  interface TransactionMetadataShippingLabel {
10000
10096
  readonly 'discriminator': 'shipping_label';
10001
10097
  readonly 'request_method'?: io.flow.v0.enums.LabelRequestMethod;
10098
+ readonly 'carrier': io.flow.v0.models.TransactionMetadataShippingLabelCarrier;
10099
+ }
10100
+
10101
+ interface TransactionMetadataShippingLabelCarrier {
10102
+ readonly 'id': string;
10103
+ readonly 'tracking_number': string;
10002
10104
  }
10003
10105
 
10004
10106
  interface TransactionMetadataTrueup {
10005
10107
  readonly 'discriminator': 'trueup';
10006
- readonly 'original': io.flow.v0.models.TransactionMetadataTrueupOriginalTransaction;
10108
+ readonly 'original': io.flow.v0.models.TransactionMetadataOriginalTransaction;
10007
10109
  readonly 'estimate': io.flow.v0.models.TransactionMetadataTrueupData;
10008
10110
  readonly 'actual': io.flow.v0.models.TransactionMetadataTrueupData;
10009
10111
  }
@@ -10014,10 +10116,8 @@ declare namespace io.flow.v0.models {
10014
10116
  readonly 'base': io.flow.v0.models.TrueupLabelBase;
10015
10117
  readonly 'surcharges': io.flow.v0.models.TrueupLabelSurcharge[];
10016
10118
  readonly 'total': number;
10017
- }
10018
-
10019
- interface TransactionMetadataTrueupOriginalTransaction {
10020
- readonly 'id': string;
10119
+ readonly 'dead'?: io.flow.v0.models.DeadWeight;
10120
+ readonly 'dimensional'?: io.flow.v0.models.DimensionalWeight;
10021
10121
  }
10022
10122
 
10023
10123
  interface TransactionNetworkDetailsCard {
@@ -10333,6 +10433,7 @@ declare namespace io.flow.v0.unions {
10333
10433
  type ExportType = (io.flow.v0.models.AccountTransactionsExportType | io.flow.v0.models.AccountOrdersExportType | io.flow.v0.models.AnalyticsExportType | io.flow.v0.models.CatalogItemExportType | io.flow.v0.models.ExperienceExportType | io.flow.v0.models.HarmonizationOverviewExportType | io.flow.v0.models.HarmonizationHs6ExportType | io.flow.v0.models.HarmonizationHs10ExportType | io.flow.v0.models.HarmonizationTariffCodesExportType | io.flow.v0.models.UnharmonizedItemExportType | io.flow.v0.models.OrderExportType | io.flow.v0.models.PriceBookItemExportType | io.flow.v0.models.SolidusProductExportType | io.flow.v0.models.SolidusVariantExportType | io.flow.v0.models.LocalizedItemPricesExportType | io.flow.v0.models.MarketingFeedsExportType | io.flow.v0.models.ExclusionRulesExportType);
10334
10434
  type FieldValidationRule = (io.flow.v0.models.FieldValidationRequired | io.flow.v0.models.FieldValidationRequiredIfPresent | io.flow.v0.models.FieldValidationMin | io.flow.v0.models.FieldValidationMax | io.flow.v0.models.FieldValidationPattern);
10335
10435
  type FraudOrderReference = (io.flow.v0.models.FraudFlowOrderReference | io.flow.v0.models.FraudPaymentRequestReference);
10436
+ type FuelSurchargeRate = (io.flow.v0.models.FuelSurchargePercent | io.flow.v0.models.FuelSurchargeByWeight);
10336
10437
  type GatewayAuthenticationData = (io.flow.v0.models.StripeAuthenticationData);
10337
10438
  type GatewayAuthenticationDataForm = (io.flow.v0.models.StripeAuthenticationDataForm);
10338
10439
  type InlineActionConfiguration = (io.flow.v0.models.BrowserInlineActionConfiguration);
@@ -10340,6 +10441,7 @@ declare namespace io.flow.v0.unions {
10340
10441
  type InventoryStrategy = (io.flow.v0.models.InventoryBackorder | io.flow.v0.models.InventoryStock | io.flow.v0.models.InventoryUnlimited | io.flow.v0.models.InventoryFollowEcommercePlatform);
10341
10442
  type KnowYourBusiness = (io.flow.v0.models.KnowYourBusinessUsa);
10342
10443
  type KnowYourBusinessForm = (io.flow.v0.models.KnowYourBusinessUsaForm);
10444
+ type LabelSurchargeDetail = (io.flow.v0.models.LabelSurchargeDetailFlat | io.flow.v0.models.LabelSurchargeDetailPercentage | io.flow.v0.models.LabelSurchargeDetailPerWeightUnit);
10343
10445
  type LocalizedPrice = (io.flow.v0.models.LocalizedItemPrice | io.flow.v0.models.LocalizedItemVat | io.flow.v0.models.LocalizedItemDuty | io.flow.v0.models.LocalizedTotal);
10344
10446
  type LogoImage = (io.flow.v0.models.LogoImageSvg | io.flow.v0.models.LogoImageSetStatic);
10345
10447
  type MerchantApplication = (io.flow.v0.models.ShopifyMerchantApplication);
@@ -10375,6 +10477,7 @@ declare namespace io.flow.v0.unions {
10375
10477
  });
10376
10478
 
10377
10479
  type PaymentOrderReference = (io.flow.v0.models.AuthorizationOrderReference | io.flow.v0.models.PaymentPaymentRequestReference);
10480
+ type PaymentProcessorTransactionDetails = (io.flow.v0.models.PaymentProcessorTransactionDetailsCard);
10378
10481
  type PaymentSource = (io.flow.v0.models.CardPaymentSource);
10379
10482
  type PaymentSourceForm = (io.flow.v0.models.CardPaymentSourceForm);
10380
10483
  type PayoutStatus = (io.flow.v0.models.PayoutStatusScheduled | io.flow.v0.models.PayoutStatusSent | io.flow.v0.models.PayoutStatusFailed);
@@ -10407,5 +10510,5 @@ declare namespace io.flow.v0.unions {
10407
10510
  type Token = (io.flow.v0.models.ChannelToken | io.flow.v0.models.OrganizationToken | io.flow.v0.models.OrganizationTokenV2 | io.flow.v0.models.PartnerToken);
10408
10511
  type TokenReference = (io.flow.v0.models.ChannelTokenReference | io.flow.v0.models.OrganizationTokenReference | io.flow.v0.models.OrganizationTokenV2Reference | io.flow.v0.models.PartnerTokenReference);
10409
10512
  type TransactionDetails = (io.flow.v0.models.TransactionDetailsCard);
10410
- type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup);
10513
+ type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataManual);
10411
10514
  }
package/index.d.ts CHANGED
@@ -6,7 +6,6 @@
6
6
  /// <reference path="generated/io.flow.billing.csv.v0.billing-csv.d.ts" />
7
7
  /// <reference path="generated/io.flow.billing.internal.v0.billing-internal.d.ts" />
8
8
  /// <reference path="generated/io.flow.billing.reporting.csv.v0.billing-reporting-csv.d.ts" />
9
- /// <reference path="generated/io.flow.billing.true.up.v0.billing-true-up.d.ts" />
10
9
  /// <reference path="generated/io.flow.billing.v0.billing.d.ts" />
11
10
  /// <reference path="generated/io.flow.bitpay.v0.bitpay.d.ts" />
12
11
  /// <reference path="generated/io.flow.brickftp.v0.brickftp.d.ts" />
@@ -76,5 +75,6 @@
76
75
  /// <reference path="generated/io.flow.svb.v0.svb.d.ts" />
77
76
  /// <reference path="generated/io.flow.token.v0.token.d.ts" />
78
77
  /// <reference path="generated/io.flow.tracking.v0.tracking.d.ts" />
78
+ /// <reference path="generated/io.flow.trueup.v0.trueup.d.ts" />
79
79
  /// <reference path="generated/io.flow.units.v0.units.d.ts" />
80
80
  /// <reference path="generated/io.flow.v0.api.d.ts" />
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/api-types",
3
- "version": "0.0.204",
3
+ "version": "0.0.205",
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": "bae206460687524c23b75d19a96a544fb102eb2d"
17
+ "gitHead": "edaa4ef26aa5601691b51a50d20d45ef9071e43e"
18
18
  }
@@ -1,164 +0,0 @@
1
- declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.enums {
2
- type TrueUpSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
3
- }
4
-
5
- declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
6
- interface CarrierChargeFile {
7
- readonly 'id': string;
8
- readonly 'url': string;
9
- readonly 'created_at': string;
10
- readonly 'result'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeFileResult;
11
- }
12
-
13
- interface CarrierChargeFileForm {
14
- readonly 'url': string;
15
- }
16
-
17
- interface CarrierChargeFileResult {
18
- readonly 'processed_at': string;
19
- readonly 'number_lines_successful': number;
20
- readonly 'number_lines_with_errors': number;
21
- readonly 'errors_url'?: string;
22
- }
23
-
24
- interface CarrierChargeFormLabel {
25
- readonly 'discriminator': 'label';
26
- readonly 'id': string;
27
- readonly 'label_invoice_request_id': string;
28
- readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeUnits;
29
- readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
30
- readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeForm;
31
- readonly 'total': number;
32
- readonly 'attributes'?: Record<string, string>;
33
- }
34
-
35
- interface CarrierChargeFormReturnToOrigin {
36
- readonly 'discriminator': 'return_to_origin';
37
- readonly 'id': string;
38
- readonly 'carrier_id': string;
39
- readonly 'carrier_tracking_number': string;
40
- readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeUnits;
41
- readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
42
- readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeForm;
43
- readonly 'total': number;
44
- readonly 'attributes'?: Record<string, string>;
45
- }
46
-
47
- interface CarrierChargeUnits {
48
- readonly 'currency': string;
49
- readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
50
- readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
51
- }
52
-
53
- interface LabelBase {
54
- readonly 'amount': number;
55
- readonly 'weight': number;
56
- }
57
-
58
- interface LabelDestination {
59
- readonly 'country': string;
60
- }
61
-
62
- interface LabelInvoiceRequest {
63
- readonly 'id': string;
64
- readonly 'label': io.flow.billing.RESERVED_WORD_true.up.v0.models.TrueUpLabelSummary;
65
- readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelUnits;
66
- readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
67
- readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurcharge[];
68
- readonly 'total': number;
69
- readonly 'destination': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelDestination;
70
- readonly 'metadata': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelMetadata;
71
- }
72
-
73
- interface LabelMetadata {
74
- readonly 'ratecard': io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataRatecard;
75
- readonly 'weights': io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataWeights;
76
- }
77
-
78
- interface LabelSurcharge {
79
- readonly 'amount': number;
80
- readonly 'type': io.flow.billing.RESERVED_WORD_true.up.v0.enums.TrueUpSurchargeType;
81
- readonly 'detail': io.flow.billing.RESERVED_WORD_true.up.v0.unions.LabelSurchargeDetail;
82
- }
83
-
84
- interface LabelSurchargeDetailFlat {
85
- readonly 'discriminator': 'flat';
86
- readonly 'placeholder'?: string;
87
- }
88
-
89
- interface LabelSurchargeDetailPerWeightUnit {
90
- readonly 'discriminator': 'per_weight_unit';
91
- readonly 'fee': number;
92
- }
93
-
94
- interface LabelSurchargeDetailPercentage {
95
- readonly 'discriminator': 'percentage';
96
- readonly 'percentage': number;
97
- }
98
-
99
- interface LabelSurchargeForm {
100
- readonly 'fuel'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
101
- readonly 'remote_area'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
102
- readonly 'oversize'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
103
- readonly 'duties_paid'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
104
- readonly 'emergency'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
105
- readonly 'peak'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
106
- readonly 'address_correction'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
107
- }
108
-
109
- interface LabelSurchargeSingleForm {
110
- readonly 'amount': number;
111
- readonly 'percentage'?: number;
112
- readonly 'fee_per_weight_unit'?: number;
113
- }
114
-
115
- interface LabelUnits {
116
- readonly 'currency': string;
117
- readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
118
- readonly 'length': io.flow.units.v0.enums.UnitOfLength;
119
- }
120
-
121
- interface MetadataProposition {
122
- readonly 'shipping_method': io.flow.billing.RESERVED_WORD_true.up.v0.models.ShippingMethodReference;
123
- readonly 'name': string;
124
- }
125
-
126
- interface MetadataRatecard {
127
- readonly 'id': string;
128
- readonly 'proposition': io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataProposition;
129
- }
130
-
131
- interface MetadataWeights {
132
- readonly 'dead'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.WeightsDead;
133
- readonly 'dimensional'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.WeightsDimensional;
134
- }
135
-
136
- interface ShippingMethodReference {
137
- readonly 'id': string;
138
- }
139
-
140
- interface TrueUpLabelSummary {
141
- readonly 'id': string;
142
- readonly 'carrier_service_id': string;
143
- readonly 'carrier_tracking_number': string;
144
- readonly 'flow_tracking_number': string;
145
- readonly 'source': io.flow.label.v0.enums.CostEstimateSource;
146
- readonly 'created_at': string;
147
- }
148
-
149
- interface WeightsDead {
150
- readonly 'weight': number;
151
- }
152
-
153
- interface WeightsDimensional {
154
- readonly 'weight': number;
155
- readonly 'length': number;
156
- readonly 'width': number;
157
- readonly 'height': number;
158
- }
159
- }
160
-
161
- declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.unions {
162
- type CarrierChargeForm = (io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeFormLabel | io.flow.billing.RESERVED_WORD_true.up.v0.models.CarrierChargeFormReturnToOrigin);
163
- type LabelSurchargeDetail = (io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeDetailFlat | io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeDetailPercentage | io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeDetailPerWeightUnit);
164
- }