@flowio/api-prop-types 10.16.62 → 10.16.64

package/lib/api.d.ts

@@ -2099,6 +2099,7 @@ declare namespace io.flow.v0.enums {
   type CaptureStatus = 'initiated' | 'pending' | 'succeeded' | 'failed' | 'canceled';
   type CardErrorCode = 'invalid_address' | 'invalid_currency' | 'invalid_name' | 'invalid_number' | 'invalid_expiration' | 'invalid_token_type' | 'avs' | 'cvv' | 'fraud' | 'unknown';
   type CardType = 'american_express' | 'cartes_bancaires' | 'china_union_pay' | 'dankort' | 'diners_club' | 'discover' | 'jcb' | 'maestro' | 'mastercard' | 'visa';
+  type CarrierChargeReason = 'return_to_origin' | 'rejection' | 'other';
   type CenterCapability = 'international' | 'domestic' | 'crossdock' | 'commercial_invoice';
   type ChangeType = 'insert' | 'update' | 'delete';
   type ChannelCurrencyCapability = 'payment_authorizations' | 'settlement_currency';
@@ -2227,6 +2228,7 @@ declare namespace io.flow.v0.enums {
   type PriceDetailKey = 'item_price' | 'margins' | 'vat' | 'duty' | 'rounding' | 'adjustment';
   type PriceFacetBoundary = 'min' | 'max';
   type PricingLevySetting = 'included' | 'displayed' | 'ignored';
+  type ProductRestrictionRule = 'Adult Products' | 'Alcohol' | 'Anti Money Laundering' | 'Collagen' | 'Consumer Safety' | 'Cosmetics' | 'DG - Batteries' | 'DG - Hazmat' | 'Drugs' | 'Dual Use' | 'Fine Art' | 'Fish & Wildlife - CITES' | 'Fish & Wildlife - Plant' | 'Fish & Wildlife - USFWS' | 'Food' | 'Gambling' | 'Health' | 'Human hair' | 'Insufficient Details' | 'Intangible' | 'Jewelry' | 'Jewelry & Watches Over 5000' | 'Knives' | 'Liquids' | 'Oversized' | 'Supplements' | 'Weapon' | 'Wood';
   type PromotionTriggerType = 'automatic' | 'order_subtotal';
   type ProvinceType = 'area' | 'city' | 'county' | 'department' | 'dependency' | 'district' | 'do_si' | 'emirate' | 'entity' | 'island' | 'municipality' | 'oblast' | 'outlying_area' | 'parish' | 'prefecture' | 'province' | 'state' | 'territory' | 'other';
   type QuoteErrorCode = 'generic_error' | 'items_not_available' | 'shipping_unavailable';
@@ -2240,6 +2242,7 @@ declare namespace io.flow.v0.enums {
   type ReturnTrackingStatus = 'awaiting_customs_clearance' | 'cancel_requested' | 'canceled' | 'collection_attempt_failed' | 'customs_clearance_completed' | 'delivered_to_retailer' | 'in_transit_to_local_hub' | 'in_transit_to_retailer' | 'parcel_added_to_pallet' | 'parcel_delayed' | 'parcel_extracted_from_pallet' | 'parcel_lost' | 'parcel_processed_by_retailer' | 'parcel_under_investigation' | 'processed_by_local_hub' | 'received_at_local_hub' | 'received_by_the_carrier' | 'return_registered_online';
   type ReversalErrorCode = 'amount_exceeds_balance' | 'authorization_declined' | 'authorization_expired' | 'invalid_authorization' | 'invalid_key' | 'invalid_amount' | 'invalid_currency' | 'no_remaining_balance' | 'partial_reversal_not_supported' | 'unknown';
   type ReversalStatus = 'pending' | 'processed' | 'failed';
+  type ReviewStatus = 'high_risk_in_review' | 'low_risk_in_review' | 'reviewed';
   type Role = 'admin' | 'member';
   type RoundingMethod = 'up' | 'down' | 'nearest';
   type RoundingType = 'pattern' | 'multiple';
@@ -2275,7 +2278,7 @@ declare namespace io.flow.v0.enums {
   type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired';
   type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
   type TradeAgreementStatus = 'supported' | 'not_supported';
-  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 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';
   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';
@@ -8645,6 +8648,8 @@ declare namespace io.flow.v0.models {
     readonly 'status': io.flow.v0.models.PaymentAuthorizationStatus;
     readonly 'amount': number;
     readonly 'currency': string;
+    readonly 'base_amount'?: number;
+    readonly 'base_currency'?: string;
   }
 
   interface PaymentAuthorizationStatus {
@@ -8656,6 +8661,8 @@ declare namespace io.flow.v0.models {
     readonly 'id': string;
     readonly 'amount': number;
     readonly 'currency': string;
+    readonly 'base_amount'?: number;
+    readonly 'base_currency'?: string;
     readonly 'created_at': string;
     readonly 'updated_at': string;
     readonly 'status': io.flow.v0.models.PaymentCaptureStatus;
@@ -9088,6 +9095,8 @@ declare namespace io.flow.v0.models {
     readonly 'id': string;
     readonly 'amount': number;
     readonly 'currency': string;
+    readonly 'base_amount'?: number;
+    readonly 'base_currency'?: string;
     readonly 'created_at': string;
     readonly 'updated_at': string;
     readonly 'status': io.flow.v0.models.PaymentRefundStatus;
@@ -9113,6 +9122,8 @@ declare namespace io.flow.v0.models {
     readonly 'next_action'?: io.flow.v0.unions.Action;
     readonly 'amount': number;
     readonly 'currency': string;
+    readonly 'base_amount'?: number;
+    readonly 'base_currency'?: string;
     readonly 'order_information': io.flow.v0.unions.OrderInformation;
     readonly 'device_details': io.flow.v0.unions.DeviceDetails;
     readonly 'locale'?: string;
@@ -9127,6 +9138,12 @@ declare namespace io.flow.v0.models {
 
   interface PaymentRequestBilling {
     readonly 'fees': io.flow.v0.models.PaymentRequestBillingFees;
+    readonly 'currency_rate'?: io.flow.v0.models.PaymentRequestBillingCurrencyRate;
+  }
+
+  interface PaymentRequestBillingCurrencyRate {
+    readonly 'base_amount': number;
+    readonly 'base_currency': string;
   }
 
   interface PaymentRequestBillingFees {
@@ -9193,6 +9210,8 @@ declare namespace io.flow.v0.models {
     readonly 'id': string;
     readonly 'amount': number;
     readonly 'currency': string;
+    readonly 'base_amount'?: number;
+    readonly 'base_currency'?: string;
     readonly 'created_at': string;
     readonly 'updated_at': string;
     readonly 'status': io.flow.v0.models.PaymentReversalStatus;
@@ -9637,6 +9656,9 @@ declare namespace io.flow.v0.models {
     readonly 'product_id': string;
     readonly 'item_numbers': string[];
     readonly 'prohibited_regions': string[];
+    readonly 'review_status'?: io.flow.v0.enums.ReviewStatus;
+    readonly 'rules'?: io.flow.v0.enums.ProductRestrictionRule[];
+    readonly 'updated_by_user_id'?: string;
   }
 
   interface ProductRestrictionResultDeleted {
@@ -12149,6 +12171,13 @@ declare namespace io.flow.v0.models {
     readonly 'network_details'?: io.flow.v0.models.TransactionNetworkDetailsCard;
   }
 
+  interface TransactionMetadataCarrierCharge {
+    readonly 'discriminator': 'carrier_charge';
+    readonly 'reason': io.flow.v0.enums.CarrierChargeReason;
+    readonly 'carrier_id': string;
+    readonly 'carrier_tracking_number': string;
+  }
+
   interface TransactionMetadataChannel {
     readonly 'discriminator': 'channel';
     readonly 'method': string;
@@ -12594,7 +12623,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 | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataManual);
+  type TransactionMetadata = (io.flow.v0.models.TransactionMetadataShippingLabel | io.flow.v0.models.TransactionMetadataChannel | io.flow.v0.models.TransactionMetadataTrueup | io.flow.v0.models.TransactionMetadataCarrierCharge | io.flow.v0.models.TransactionMetadataManual);
 }
 
 export const abandonedOrderPromotionStatus: PropTypes.Requireable<io.flow.v0.enums.AbandonedOrderPromotionStatus>;
@@ -12621,6 +12650,7 @@ export const captureDeclineCode: PropTypes.Requireable<io.flow.v0.enums.CaptureD
 export const captureStatus: PropTypes.Requireable<io.flow.v0.enums.CaptureStatus>;
 export const cardErrorCode: PropTypes.Requireable<io.flow.v0.enums.CardErrorCode>;
 export const cardType: PropTypes.Requireable<io.flow.v0.enums.CardType>;
+export const carrierChargeReason: PropTypes.Requireable<io.flow.v0.enums.CarrierChargeReason>;
 export const centerCapability: PropTypes.Requireable<io.flow.v0.enums.CenterCapability>;
 export const changeType: PropTypes.Requireable<io.flow.v0.enums.ChangeType>;
 export const channelCurrencyCapability: PropTypes.Requireable<io.flow.v0.enums.ChannelCurrencyCapability>;
@@ -12749,6 +12779,7 @@ export const priceDetailComponentKey: PropTypes.Requireable<io.flow.v0.enums.Pri
 export const priceDetailKey: PropTypes.Requireable<io.flow.v0.enums.PriceDetailKey>;
 export const priceFacetBoundary: PropTypes.Requireable<io.flow.v0.enums.PriceFacetBoundary>;
 export const pricingLevySetting: PropTypes.Requireable<io.flow.v0.enums.PricingLevySetting>;
+export const productRestrictionRule: PropTypes.Requireable<io.flow.v0.enums.ProductRestrictionRule>;
 export const promotionTriggerType: PropTypes.Requireable<io.flow.v0.enums.PromotionTriggerType>;
 export const provinceType: PropTypes.Requireable<io.flow.v0.enums.ProvinceType>;
 export const quoteErrorCode: PropTypes.Requireable<io.flow.v0.enums.QuoteErrorCode>;
@@ -12762,6 +12793,7 @@ export const returnStatus: PropTypes.Requireable<io.flow.v0.enums.ReturnStatus>;
 export const returnTrackingStatus: PropTypes.Requireable<io.flow.v0.enums.ReturnTrackingStatus>;
 export const reversalErrorCode: PropTypes.Requireable<io.flow.v0.enums.ReversalErrorCode>;
 export const reversalStatus: PropTypes.Requireable<io.flow.v0.enums.ReversalStatus>;
+export const reviewStatus: PropTypes.Requireable<io.flow.v0.enums.ReviewStatus>;
 export const role: PropTypes.Requireable<io.flow.v0.enums.Role>;
 export const roundingMethod: PropTypes.Requireable<io.flow.v0.enums.RoundingMethod>;
 export const roundingType: PropTypes.Requireable<io.flow.v0.enums.RoundingType>;
@@ -13779,6 +13811,7 @@ export const paymentRefundForm: PropTypes.Requireable<io.flow.v0.models.PaymentR
 export const paymentRefundStatus: PropTypes.Requireable<io.flow.v0.models.PaymentRefundStatus>;
 export const paymentRequest: PropTypes.Requireable<io.flow.v0.models.PaymentRequest>;
 export const paymentRequestBilling: PropTypes.Requireable<io.flow.v0.models.PaymentRequestBilling>;
+export const paymentRequestBillingCurrencyRate: PropTypes.Requireable<io.flow.v0.models.PaymentRequestBillingCurrencyRate>;
 export const paymentRequestBillingFees: PropTypes.Requireable<io.flow.v0.models.PaymentRequestBillingFees>;
 export const paymentRequestBundle: PropTypes.Requireable<io.flow.v0.models.PaymentRequestBundle>;
 export const paymentRequestBundleForm: PropTypes.Requireable<io.flow.v0.models.PaymentRequestBundleForm>;
@@ -14183,6 +14216,7 @@ export const tradeAgreementCertifier: PropTypes.Requireable<io.flow.v0.models.Tr
 export const tradeAgreementDuty: PropTypes.Requireable<io.flow.v0.models.TradeAgreementDuty>;
 export const transaction: PropTypes.Requireable<io.flow.v0.models.Transaction>;
 export const transactionDetailsCard: PropTypes.Requireable<io.flow.v0.models.TransactionDetailsCard>;
+export const transactionMetadataCarrierCharge: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataCarrierCharge>;
 export const transactionMetadataChannel: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataChannel>;
 export const transactionMetadataChannelCardMetadata: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataChannelCardMetadata>;
 export const transactionMetadataChannelCardMetadataIssuerSummary: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataChannelCardMetadataIssuerSummary>;