@flowio/api-prop-types 10.16.54 → 10.16.56

package/lib/api.d.ts

@@ -300,6 +300,7 @@ declare namespace io.flow.stripe.v0.models {
     readonly 'id': string;
     readonly 'amount': number;
     readonly 'amount_refunded': number;
+    readonly 'authorization_code'?: string;
     readonly 'captured': boolean;
     readonly 'created': number;
     readonly 'currency': string;
@@ -350,6 +351,7 @@ declare namespace io.flow.stripe.v0.models {
     readonly 'id': string;
     readonly 'amount': number;
     readonly 'amount_refunded': number;
+    readonly 'authorization_code'?: string;
     readonly 'captured': boolean;
     readonly 'created': number;
     readonly 'currency': string;
@@ -921,9 +923,11 @@ declare namespace io.flow.stripe.v0.models {
   }
 
   interface ThreeDSecureCharge {
+    readonly 'authenticated'?: boolean;
     readonly 'authentication_flow'?: io.flow.stripe.v0.enums.ThreeDsAuthenticationFlow;
     readonly 'result'?: io.flow.stripe.v0.enums.ThreeDsResult;
     readonly 'result_reason'?: io.flow.stripe.v0.enums.ThreeDsResultReason;
+    readonly 'succeeded'?: boolean;
     readonly 'version'?: string;
   }
 
@@ -1990,8 +1994,7 @@ declare namespace io.flow.error.v0.models {
 }
 
 declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.enums {
-  type TrueUpSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak';
-  type WeightSelection = 'dead' | 'dimensional';
+  type TrueUpSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
 }
 
 declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
@@ -2015,11 +2018,44 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
     readonly 'metadata': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelMetadata;
   }
 
+  interface LabelInvoiceResponseFile {
+    readonly 'id': string;
+    readonly 'url': string;
+    readonly 'created_at': string;
+    readonly 'result'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelInvoiceResponseFileResult;
+  }
+
+  interface LabelInvoiceResponseFileForm {
+    readonly 'url': string;
+  }
+
+  interface LabelInvoiceResponseFileResult {
+    readonly 'processed_at': string;
+    readonly 'number_lines_successful': number;
+    readonly 'number_lines_with_errors': number;
+    readonly 'errors_url'?: string;
+  }
+
+  interface LabelInvoiceResponseForm {
+    readonly 'id': string;
+    readonly 'label_invoice_request_id': string;
+    readonly 'units': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelResponseUnits;
+    readonly 'base': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelBase;
+    readonly 'surcharges': io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeForm;
+    readonly 'total': number;
+  }
+
   interface LabelMetadata {
     readonly 'ratecard': io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataRatecard;
     readonly 'weights': io.flow.billing.RESERVED_WORD_true.up.v0.models.MetadataWeights;
   }
 
+  interface LabelResponseUnits {
+    readonly 'currency': string;
+    readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
+    readonly 'length'?: io.flow.units.v0.enums.UnitOfLength;
+  }
+
   interface LabelSurcharge {
     readonly 'amount': number;
     readonly 'type': io.flow.billing.RESERVED_WORD_true.up.v0.enums.TrueUpSurchargeType;
@@ -2041,6 +2077,22 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
     readonly 'percentage': number;
   }
 
+  interface LabelSurchargeForm {
+    readonly 'fuel'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
+    readonly 'remote_area'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
+    readonly 'oversize'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
+    readonly 'duties_paid'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
+    readonly 'emergency'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
+    readonly 'peak'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
+    readonly 'address_correction'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.LabelSurchargeSingleForm;
+  }
+
+  interface LabelSurchargeSingleForm {
+    readonly 'amount': number;
+    readonly 'percentage'?: number;
+    readonly 'fee_per_weight_unit'?: number;
+  }
+
   interface LabelUnits {
     readonly 'currency': string;
     readonly 'weight': io.flow.units.v0.enums.UnitOfWeight;
@@ -2058,7 +2110,6 @@ declare namespace io.flow.billing.RESERVED_WORD_true.up.v0.models {
   }
 
   interface MetadataWeights {
-    readonly 'selected': io.flow.billing.RESERVED_WORD_true.up.v0.enums.WeightSelection;
     readonly 'dead'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.WeightsDead;
     readonly 'dimensional'?: io.flow.billing.RESERVED_WORD_true.up.v0.models.WeightsDimensional;
   }
@@ -2203,7 +2254,7 @@ declare namespace io.flow.v0.enums {
   type OrderChangeSource = 'consumer' | 'retailer' | 'fulfillment' | 'flow' | 'carrier';
   type OrderErrorCode = 'generic_error' | 'order_item_not_available' | 'order_identifier_error' | 'authorization_invalid' | 'domestic_shipping_unavailable' | 'shipping_unavailable' | 'value_threshold_exceeded' | 'invalid_currency' | 'invalid_country' | 'invalid_region' | 'invalid_language' | 'item_out_of_stock' | 'gift_card_not_accepted' | 'total_changed';
   type OrderMerchantOfRecord = 'flow' | 'organization' | 'mixed';
-  type OrderPaymentType = 'card' | 'online' | 'credit' | 'subsidized' | 'installment_plan' | 'cash_on_delivery';
+  type OrderPaymentType = 'card' | 'online' | 'credit' | 'external' | 'subsidized' | 'installment_plan' | 'cash_on_delivery';
   type OrderPriceDetailComponentKey = 'adjustment' | 'vat_deminimis' | 'duty_deminimis' | 'duties_item_price' | 'duties_freight' | 'duties_insurance' | 'vat_item_price' | 'vat_freight' | 'vat_insurance' | 'vat_duties_item_price' | 'vat_duties_freight' | 'vat_duties_insurance' | 'item_price' | 'item_discount' | 'rounding' | 'insurance' | 'shipping' | 'shipping_discount' | 'order_discount' | 'subtotal_percent_sales_margin' | 'subtotal_vat_percent_sales_margin' | 'subtotal_duty_percent_sales_margin' | 'vat_subsidy' | 'duty_subsidy' | 'remote_area_surcharge' | 'fuel_surcharge' | 'emergency_situation_surcharge' | 'peak_surcharge' | 'duties_taxes_paid_surcharge';
   type OrderPriceDetailKey = 'adjustment' | 'subtotal' | 'vat' | 'duty' | 'shipping' | 'insurance' | 'discount' | 'surcharges';
   type OrderQuoteAddressType = 'shipping';
@@ -2226,7 +2277,7 @@ declare namespace io.flow.v0.enums {
   type PaymentMethodRuleContentKey = 'description';
   type PaymentMethodType = 'card' | 'online' | 'offline';
   type PaymentRequestReviewCheckStatus = 'passed' | 'failed';
-  type PaymentRequestReviewCheckType = 'restricted_party_screening' | 'fraud_suspicious_behavior' | 'fraud_suspicious_past_activity' | 'fraud_risky_velocity' | 'fraud_previous_chargebacks' | 'order_restricted_goods' | 'order_unsupported_destination' | 'order_missing_information' | 'order_domestic';
+  type PaymentRequestReviewCheckType = 'restricted_party_screening' | 'fraud_suspicious_behavior' | 'fraud_suspicious_past_activity' | 'fraud_risky_velocity' | 'fraud_previous_chargebacks' | 'order_restricted_goods' | 'order_unsupported_destination' | 'order_missing_information' | 'order_domestic' | 'order_mismatched_currencies';
   type PaymentRequestReviewStatus = 'pending' | 'approved' | 'rejected';
   type PaymentSourceConfirmationActionType = 'cvv' | 'billing_address' | 'number';
   type PaymentStatus = 'requires_payment_method' | 'requires_action' | 'processing' | 'cancelled' | 'expired' | 'authorized' | 'reversed' | 'captured' | 'refunded' | 'in_dispute' | 'charged_back';
@@ -2292,7 +2343,9 @@ declare namespace io.flow.v0.enums {
   type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
   type TradeAgreementStatus = 'supported' | 'not_supported';
   type TransactionPayoutPendingReason = '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';
-  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
+  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'trueup' | 'shipping_label_revenue_share' | 'platform_fee' | 'tax' | 'duty' | 'withholding' | 'other_adjustment' | 'tax_adjustment' | 'channel' | 'channel_billed' | 'order_service' | 'virtual_card_capture' | 'virtual_card_refund';
+  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl';
+  type TrueupSurchargeType = 'fuel' | 'remote_area' | 'oversize' | 'duties_paid' | 'emergency' | 'peak' | 'address_correction';
   type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
   type UnitOfMeasurement = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'cubic_inch' | 'cubic_meter' | 'gram' | 'kilogram' | 'meter' | 'ounce' | 'pound';
   type UnitOfTime = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute';
@@ -6605,6 +6658,7 @@ declare namespace io.flow.v0.models {
     readonly 'discriminator': 'know_your_business_usa';
     readonly 'id': string;
     readonly 'organization_id': string;
+    readonly 'shop'?: io.flow.v0.models.Shop;
     readonly 'primary_entity': io.flow.v0.unions.Entity;
     readonly 'parent_company'?: io.flow.v0.models.Company;
     readonly 'ultimate_parent_company'?: io.flow.v0.models.Company;
@@ -8216,6 +8270,7 @@ declare namespace io.flow.v0.models {
     readonly 'current_state': io.flow.v0.unions.OnboardingState;
     readonly 'started_at'?: string;
     readonly 'time_blocked'?: number;
+    readonly 'time_in_setup'?: number;
     readonly 'blocked_since'?: string;
     readonly 'completed_at'?: string;
     readonly 'onboarding_started_at'?: string;
@@ -12033,6 +12088,20 @@ declare namespace io.flow.v0.models {
     readonly 'request_method'?: io.flow.v0.enums.LabelRequestMethod;
   }
 
+  interface TransactionMetadataTrueup {
+    readonly 'discriminator': 'trueup';
+    readonly 'estimate': io.flow.v0.models.TransactionMetadataTrueupData;
+    readonly 'actual': io.flow.v0.models.TransactionMetadataTrueupData;
+  }
+
+  interface TransactionMetadataTrueupData {
+    readonly 'source': io.flow.v0.enums.TrueupSource;
+    readonly 'units': io.flow.v0.models.TrueupLabelUnits;
+    readonly 'base': io.flow.v0.models.TrueupLabelBase;
+    readonly 'surcharges': io.flow.v0.models.TrueupLabelSurcharge[];
+    readonly 'total': number;
+  }
+
   interface TransactionNetworkDetailsCard {
     readonly 'network_transaction_id'?: string;
     readonly 'network'?: io.flow.v0.enums.CardType;
@@ -12065,6 +12134,23 @@ declare namespace io.flow.v0.models {
     readonly 'to': number;
   }
 
+  interface TrueupLabelBase {
+    readonly 'amount': number;
+    readonly 'weight': number;
+  }
+
+  interface TrueupLabelSurcharge {
+    readonly 'amount': number;
+    readonly 'type': io.flow.v0.enums.TrueupSurchargeType;
+    readonly 'percentage'?: number;
+    readonly 'per_weight_unit'?: number;
+  }
+
+  interface TrueupLabelUnits {
+    readonly 'weight': io.flow.v0.enums.UnitOfWeight;
+    readonly 'length'?: io.flow.v0.enums.UnitOfLength;
+  }
+
   interface UltimateBeneficiaryOwner {
     readonly 'name': string;
     readonly 'dob': string;
@@ -12403,7 +12489,7 @@ declare namespace io.flow.v0.unions {
   type Token = (io.flow.v0.models.ChannelToken | io.flow.v0.models.OrganizationToken | io.flow.v0.models.OrganizationTokenV2 | io.flow.v0.models.PartnerToken);
   type TokenReference = (io.flow.v0.models.ChannelTokenReference | io.flow.v0.models.OrganizationTokenReference | io.flow.v0.models.OrganizationTokenV2Reference | io.flow.v0.models.PartnerTokenReference);
   type TransactionDetails = (io.flow.v0.models.TransactionDetailsCard);
-  type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel);
+  type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataTrueup);
 }
 
 export const abandonedOrderPromotionStatus: PropTypes.Requireable<io.flow.v0.enums.AbandonedOrderPromotionStatus>;
@@ -12607,6 +12693,8 @@ export const tradeAgreementName: PropTypes.Requireable<io.flow.v0.enums.TradeAgr
 export const tradeAgreementStatus: PropTypes.Requireable<io.flow.v0.enums.TradeAgreementStatus>;
 export const transactionPayoutPendingReason: PropTypes.Requireable<io.flow.v0.enums.TransactionPayoutPendingReason>;
 export const transactionSource: PropTypes.Requireable<io.flow.v0.enums.TransactionSource>;
+export const trueupSource: PropTypes.Requireable<io.flow.v0.enums.TrueupSource>;
+export const trueupSurchargeType: PropTypes.Requireable<io.flow.v0.enums.TrueupSurchargeType>;
 export const unitOfLength: PropTypes.Requireable<io.flow.v0.enums.UnitOfLength>;
 export const unitOfMeasurement: PropTypes.Requireable<io.flow.v0.enums.UnitOfMeasurement>;
 export const unitOfTime: PropTypes.Requireable<io.flow.v0.enums.UnitOfTime>;
@@ -13971,11 +14059,16 @@ export const tradeAgreementDuty: PropTypes.Requireable<io.flow.v0.models.TradeAg
 export const transaction: PropTypes.Requireable<io.flow.v0.models.Transaction>;
 export const transactionDetailsCard: PropTypes.Requireable<io.flow.v0.models.TransactionDetailsCard>;
 export const transactionMetadataShippingLabel: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataShippingLabel>;
+export const transactionMetadataTrueup: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataTrueup>;
+export const transactionMetadataTrueupData: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataTrueupData>;
 export const transactionNetworkDetailsCard: PropTypes.Requireable<io.flow.v0.models.TransactionNetworkDetailsCard>;
 export const transactionReference: PropTypes.Requireable<io.flow.v0.models.TransactionReference>;
 export const transactionUpserted: PropTypes.Requireable<io.flow.v0.models.TransactionUpserted>;
 export const transitEstimate: PropTypes.Requireable<io.flow.v0.models.TransitEstimate>;
 export const transitWindow: PropTypes.Requireable<io.flow.v0.models.TransitWindow>;
+export const trueupLabelBase: PropTypes.Requireable<io.flow.v0.models.TrueupLabelBase>;
+export const trueupLabelSurcharge: PropTypes.Requireable<io.flow.v0.models.TrueupLabelSurcharge>;
+export const trueupLabelUnits: PropTypes.Requireable<io.flow.v0.models.TrueupLabelUnits>;
 export const ultimateBeneficiaryOwner: PropTypes.Requireable<io.flow.v0.models.UltimateBeneficiaryOwner>;
 export const unharmonizedItemExportType: PropTypes.Requireable<io.flow.v0.models.UnharmonizedItemExportType>;
 export const upload: PropTypes.Requireable<io.flow.v0.models.Upload>;