@flowio/api-prop-types 10.16.63 → 10.16.64

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowio/api-prop-types",
-  "version": "10.16.63",
+  "version": "10.16.64",
   "description": "PropType validators that work with Flow API",
   "keywords": [
     "flow",
@@ -29,5 +29,5 @@
   "peerDependencies": {
     "prop-types": "^15.7.0"
   },
-  "gitHead": "1855db886db2701e6ba2ae9ede907ce6abbcaa38"
+  "gitHead": "69a80797baeb34690859818e5db7ef87aa6082a5"
 }

package/src/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,7 +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' | 'unknown';
+  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';
@@ -2277,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';
@@ -8647,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 {
@@ -8658,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;
@@ -9090,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;
@@ -9115,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;
@@ -9129,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 {
@@ -9195,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;
@@ -9639,9 +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;
+    readonly 'review_status'?: io.flow.v0.enums.ReviewStatus;
+    readonly 'rules'?: io.flow.v0.enums.ProductRestrictionRule[];
+    readonly 'updated_by_user_id'?: string;
   }
 
   interface ProductRestrictionResultDeleted {
@@ -12154,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;
@@ -12599,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>;
@@ -12626,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>;
@@ -13786,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>;
@@ -14190,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>;

package/src/api.js

@@ -2952,6 +2952,8 @@ T['io.flow.v0.models.transaction_metadata_channel_card_metadata_issuer_summary']
   country: PropTypes.string.isRequired,
 });
 
+T['io.flow.v0.enums.carrier_charge_reason'] = PropTypes.oneOf(['return_to_origin', 'rejection', 'other']);
+
 T['io.flow.v0.enums.tracking_status'] = PropTypes.oneOf([
   'label_created',
   'pending',
@@ -3725,7 +3727,6 @@ T['io.flow.v0.enums.product_restriction_rule'] = PropTypes.oneOf([
   'Supplements',
   'Weapon',
   'Wood',
-  'unknown',
 ]);
 
 T['io.flow.v0.enums.review_status'] = PropTypes.oneOf(['high_risk_in_review', 'low_risk_in_review', 'reviewed']);
@@ -3735,9 +3736,9 @@ T['io.flow.v0.models.product_restriction_result'] = PropTypes.exact({
   product_id: PropTypes.string.isRequired,
   item_numbers: PropTypes.arrayOf(PropTypes.string).isRequired,
   prohibited_regions: PropTypes.arrayOf(PropTypes.string).isRequired,
-  review_status: T['io.flow.v0.enums.review_status'].isRequired,
-  rules: PropTypes.arrayOf(T['io.flow.v0.enums.product_restriction_rule']).isRequired,
-  updated_by_user_id: PropTypes.string.isRequired,
+  review_status: T['io.flow.v0.enums.review_status'],
+  rules: PropTypes.arrayOf(T['io.flow.v0.enums.product_restriction_rule']),
+  updated_by_user_id: PropTypes.string,
 });
 
 T['io.flow.v0.models.product_restriction_result_upserted'] = PropTypes.exact({
@@ -3929,6 +3930,11 @@ T['io.flow.v0.models.payment_method_data_init_klarna'] = PropTypes.exact({
   placeholder: PropTypes.string,
 });
 
+T['io.flow.v0.models.payment_request_billing_currency_rate'] = PropTypes.exact({
+  base_amount: PropTypes.number.isRequired,
+  base_currency: PropTypes.string.isRequired,
+});
+
 T['io.flow.v0.models.payment_request_billing_fees'] = PropTypes.exact({
   mor_fee_rate: PropTypes.number,
   fx_fee_rate: PropTypes.number,
@@ -3936,6 +3942,7 @@ T['io.flow.v0.models.payment_request_billing_fees'] = PropTypes.exact({
 
 T['io.flow.v0.models.payment_request_billing'] = PropTypes.exact({
   fees: T['io.flow.v0.models.payment_request_billing_fees'].isRequired,
+  currency_rate: T['io.flow.v0.models.payment_request_billing_currency_rate'],
 });
 
 T['io.flow.v0.models.payment_request_review_check'] = PropTypes.exact({
@@ -4261,6 +4268,8 @@ T['io.flow.v0.models.payment_reversal'] = PropTypes.exact({
   id: PropTypes.string.isRequired,
   amount: PropTypes.number.isRequired,
   currency: PropTypes.string.isRequired,
+  base_amount: PropTypes.number,
+  base_currency: PropTypes.string,
   created_at: PropTypes.string.isRequired,
   updated_at: PropTypes.string.isRequired,
   status: T['io.flow.v0.models.payment_reversal_status'].isRequired,
@@ -5860,6 +5869,8 @@ T['io.flow.v0.models.payment_refund'] = PropTypes.exact({
   id: PropTypes.string.isRequired,
   amount: PropTypes.number.isRequired,
   currency: PropTypes.string.isRequired,
+  base_amount: PropTypes.number,
+  base_currency: PropTypes.string,
   created_at: PropTypes.string.isRequired,
   updated_at: PropTypes.string.isRequired,
   status: T['io.flow.v0.models.payment_refund_status'].isRequired,
@@ -6950,6 +6961,13 @@ T['io.flow.v0.models.transaction_metadata_manual'] = PropTypes.exact({
   url: PropTypes.string,
 });
 
+T['io.flow.v0.models.transaction_metadata_carrier_charge'] = PropTypes.exact({
+  discriminator: PropTypes.oneOf(['carrier_charge']).isRequired,
+  reason: T['io.flow.v0.enums.carrier_charge_reason'].isRequired,
+  carrier_id: PropTypes.string.isRequired,
+  carrier_tracking_number: PropTypes.string.isRequired,
+});
+
 T['io.flow.v0.models.transaction_metadata_trueup'] = PropTypes.exact({
   discriminator: PropTypes.oneOf(['trueup']).isRequired,
   original: T['io.flow.v0.models.transaction_metadata_original_transaction'].isRequired,
@@ -6989,6 +7007,7 @@ T['io.flow.v0.enums.transaction_source'] = PropTypes.oneOf([
   'shipping_label',
   'shipping_label_service',
   'trueup',
+  'carrier_charge',
   'shipping_label_revenue_share',
   'platform_fee',
   'tax',
@@ -7672,6 +7691,7 @@ T['io.flow.v0.unions.transaction_metadata'] = PropTypes.oneOfType([
   T['io.flow.v0.models.transaction_metadata_shipping_label'],
   T['io.flow.v0.models.transaction_metadata_channel'],
   T['io.flow.v0.models.transaction_metadata_trueup'],
+  T['io.flow.v0.models.transaction_metadata_carrier_charge'],
   T['io.flow.v0.models.transaction_metadata_manual'],
 ]);
 
@@ -7812,6 +7832,8 @@ T['io.flow.v0.models.payment_capture'] = PropTypes.exact({
   id: PropTypes.string.isRequired,
   amount: PropTypes.number.isRequired,
   currency: PropTypes.string.isRequired,
+  base_amount: PropTypes.number,
+  base_currency: PropTypes.string,
   created_at: PropTypes.string.isRequired,
   updated_at: PropTypes.string.isRequired,
   status: T['io.flow.v0.models.payment_capture_status'].isRequired,
@@ -10852,6 +10874,8 @@ T['io.flow.v0.models.payment_authorization'] = PropTypes.exact({
   status: T['io.flow.v0.models.payment_authorization_status'].isRequired,
   amount: PropTypes.number.isRequired,
   currency: PropTypes.string.isRequired,
+  base_amount: PropTypes.number,
+  base_currency: PropTypes.string,
 });
 
 T['io.flow.v0.models.payment_information'] = PropTypes.exact({
@@ -11414,6 +11438,8 @@ T['io.flow.v0.models.payment_request'] = PropTypes.exact({
   next_action: T['io.flow.v0.unions.action'],
   amount: PropTypes.number.isRequired,
   currency: PropTypes.string.isRequired,
+  base_amount: PropTypes.number,
+  base_currency: PropTypes.string,
   order_information: T['io.flow.v0.unions.order_information'].isRequired,
   device_details: T['io.flow.v0.unions.device_details'].isRequired,
   locale: PropTypes.string,
@@ -14831,6 +14857,7 @@ export const cardType = T['io.flow.v0.enums.card_type'];
 export const cardUpsertedV2 = T['io.flow.v0.models.card_upserted_v2'];
 export const cardVersion = T['io.flow.v0.models.card_version'];
 export const carrier = T['io.flow.v0.models.carrier'];
+export const carrierChargeReason = T['io.flow.v0.enums.carrier_charge_reason'];
 export const carrierReference = T['io.flow.v0.models.carrier_reference'];
 export const carrierService = T['io.flow.v0.models.carrier_service'];
 export const cartReference = T['io.flow.v0.models.cart_reference'];
@@ -15808,6 +15835,7 @@ export const paymentRefundForm = T['io.flow.v0.models.payment_refund_form'];
 export const paymentRefundStatus = T['io.flow.v0.models.payment_refund_status'];
 export const paymentRequest = T['io.flow.v0.models.payment_request'];
 export const paymentRequestBilling = T['io.flow.v0.models.payment_request_billing'];
+export const paymentRequestBillingCurrencyRate = T['io.flow.v0.models.payment_request_billing_currency_rate'];
 export const paymentRequestBillingFees = T['io.flow.v0.models.payment_request_billing_fees'];
 export const paymentRequestBundle = T['io.flow.v0.models.payment_request_bundle'];
 export const paymentRequestBundleForm = T['io.flow.v0.models.payment_request_bundle_form'];
@@ -16314,6 +16342,7 @@ export const transaction = T['io.flow.v0.models.transaction'];
 export const transactionDetails = T['io.flow.v0.unions.transaction_details'];
 export const transactionDetailsCard = T['io.flow.v0.models.transaction_details_card'];
 export const transactionMetadata = T['io.flow.v0.unions.transaction_metadata'];
+export const transactionMetadataCarrierCharge = T['io.flow.v0.models.transaction_metadata_carrier_charge'];
 export const transactionMetadataChannel = T['io.flow.v0.models.transaction_metadata_channel'];
 export const transactionMetadataChannelCardMetadata = T['io.flow.v0.models.transaction_metadata_channel_card_metadata'];
 export const transactionMetadataChannelCardMetadataIssuerSummary = T['io.flow.v0.models.transaction_metadata_channel_card_metadata_issuer_summary'];