@flowio/api-prop-types 10.16.74 → 10.16.76

package/lib/api.d.ts

@@ -1141,6 +1141,7 @@ declare namespace io.flow.shopify.external.v0.enums {
   type ShopifyCustomerState = 'disabled' | 'invited' | 'enabled';
   type ShopifyDiscountPaginationDirection = 'next' | 'prev';
   type ShopifyGiftCardStatus = 'any' | 'enabled' | 'disabled';
+  type ShopifyPlanName = 'basic' | 'business' | 'cancelled' | 'dormant' | 'enterprise' | 'fraudulent' | 'frozen' | 'npo_full' | 'npo_lite' | 'open_learning' | 'paid_trial' | 'professional' | 'retail' | 'shopify_alumni' | 'shopify_plus' | 'staff' | 'staff_business' | 'starter' | 'starter_2022' | 'unlimited';
   type ShopifyProcessingMethodType = 'checkout' | 'direct' | 'manual' | 'offsite' | 'express';
   type ShopifyTransactionErrorCode = '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';
   type ShopifyTransactionStatus = 'pending' | 'failure' | 'success' | 'error';
@@ -1289,7 +1290,7 @@ declare namespace io.flow.shopify.external.v0.models {
     readonly 'id': number;
     readonly 'product_id': number;
     readonly 'variant_ids': number[];
-    readonly 'src': string;
+    readonly 'src'?: string;
     readonly 'position': number;
     readonly 'created_at': string;
     readonly 'updated_at': string;
@@ -1901,6 +1902,12 @@ declare namespace io.flow.shopify.external.v0.models {
     readonly 'carrier_identifier'?: string;
   }
 
+  interface ShopifyShopUpdate {
+    readonly 'id': number;
+    readonly 'plan_display_name': string;
+    readonly 'plan_name': io.flow.shopify.external.v0.enums.ShopifyPlanName;
+  }
+
   interface ShopifyTaxLine {
     readonly 'price': string;
     readonly 'rate': number;
@@ -2332,7 +2339,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' | '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';
+  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'carrier_charge' | 'carrier_charge_revenue_share' | 'carrier_fee' | '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' | 'security' | 'eei_filing' | 'fixed_ddp' | 'fixed_currency_conversion';
   type UnitOfLength = 'millimeter' | 'centimeter' | 'inch' | 'foot' | 'meter';
@@ -4720,6 +4727,7 @@ declare namespace io.flow.v0.models {
 
   interface DeactivationPutForm {
     readonly 'reason': string;
+    readonly 'deactivate_at'?: string;
   }
 
   interface DeadWeight {
@@ -7305,6 +7313,7 @@ declare namespace io.flow.v0.models {
   interface MerchantDeactivated {
     readonly 'discriminator': 'merchant_deactivated';
     readonly 'reason': string;
+    readonly 'deactivate_at'?: string;
   }
 
   interface MerchantDisabled {
@@ -8648,6 +8657,7 @@ declare namespace io.flow.v0.models {
     readonly 'currency': string;
     readonly 'base_amount'?: number;
     readonly 'base_currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentAuthorizationStatus {
@@ -8661,6 +8671,7 @@ declare namespace io.flow.v0.models {
     readonly 'currency': string;
     readonly 'base_amount'?: number;
     readonly 'base_currency'?: string;
+    readonly 'reference'?: string;
     readonly 'created_at': string;
     readonly 'updated_at': string;
     readonly 'status': io.flow.v0.models.PaymentCaptureStatus;
@@ -8669,6 +8680,7 @@ declare namespace io.flow.v0.models {
   interface PaymentCaptureForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
     readonly 'attributes'?: Record<string, string>;
   }
 
@@ -8817,6 +8829,7 @@ declare namespace io.flow.v0.models {
     readonly 'device_fingerprint_details': io.flow.v0.unions.DeviceFingerprintDetails;
     readonly 'cvv'?: string;
     readonly 'stored_details_card'?: io.flow.v0.unions.PaymentMethodStoredDetailsCard;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataAuthorizeGooglepay {
@@ -8852,42 +8865,43 @@ declare namespace io.flow.v0.models {
 
   interface PaymentMethodDataInitAfterpay {
     readonly 'type': 'init_afterpay';
-    readonly 'placeholder'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataInitApplepay {
     readonly 'type': 'init_applepay';
-    readonly 'placeholder'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataInitBancontact {
     readonly 'type': 'init_bancontact';
-    readonly 'placeholder'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataInitGooglepay {
     readonly 'type': 'init_googlepay';
-    readonly 'placeholder'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataInitIdeal {
     readonly 'type': 'init_ideal';
     readonly 'issuer'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataInitKlarna {
     readonly 'type': 'init_klarna';
-    readonly 'placeholder'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataInitPaypal {
     readonly 'type': 'init_paypal';
-    readonly 'placeholder'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataInitSofort {
     readonly 'type': 'init_sofort';
-    readonly 'placeholder'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentMethodDataOptionLogoSvg {
@@ -9007,7 +9021,7 @@ declare namespace io.flow.v0.models {
   }
 
   interface PaymentOrderDetailsLineItem {
-    readonly 'id': string;
+    readonly 'id'?: string;
     readonly 'description': string;
     readonly 'quantity': number;
     readonly 'amount': number;
@@ -9095,6 +9109,7 @@ declare namespace io.flow.v0.models {
     readonly 'currency': string;
     readonly 'base_amount'?: number;
     readonly 'base_currency'?: string;
+    readonly 'reference'?: string;
     readonly 'created_at': string;
     readonly 'updated_at': string;
     readonly 'status': io.flow.v0.models.PaymentRefundStatus;
@@ -9103,6 +9118,7 @@ declare namespace io.flow.v0.models {
   interface PaymentRefundForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentRefundStatus {
@@ -9210,6 +9226,7 @@ declare namespace io.flow.v0.models {
     readonly 'currency': string;
     readonly 'base_amount'?: number;
     readonly 'base_currency'?: string;
+    readonly 'reference'?: string;
     readonly 'created_at': string;
     readonly 'updated_at': string;
     readonly 'status': io.flow.v0.models.PaymentReversalStatus;
@@ -9218,6 +9235,7 @@ declare namespace io.flow.v0.models {
   interface PaymentReversalForm {
     readonly 'amount'?: number;
     readonly 'currency'?: string;
+    readonly 'reference'?: string;
   }
 
   interface PaymentReversalStatus {
@@ -9666,7 +9684,7 @@ declare namespace io.flow.v0.models {
     readonly 'event_id': string;
     readonly 'timestamp': string;
     readonly 'organization': string;
-    readonly 'product_restriction_result': io.flow.v0.models.ProductRestrictionResult;
+    readonly 'id': string;
   }
 
   interface ProductRestrictionResultUpserted {
@@ -12205,11 +12223,18 @@ declare namespace io.flow.v0.models {
     readonly 'carrier_id': string;
     readonly 'carrier_tracking_number': string;
     readonly 'revenue_share_percentage': number;
-    readonly 'outbound'?: io.flow.v0.models.TransactionMetadataCarrierChargeOutbound;
+    readonly 'outbound'?: io.flow.v0.models.TransactionMetadataOutboundTransaction;
   }
 
-  interface TransactionMetadataCarrierChargeOutbound {
-    readonly 'transaction_id': string;
+  interface TransactionMetadataCarrierFee {
+    readonly 'discriminator': 'carrier_fee';
+    readonly 'outbound': io.flow.v0.models.TransactionMetadataOutboundTransaction;
+    readonly 'estimate': io.flow.v0.models.TransactionMetadataCarrierFeeData;
+    readonly 'actual': io.flow.v0.models.TransactionMetadataCarrierFeeData;
+  }
+
+  interface TransactionMetadataCarrierFeeData {
+    readonly 'surcharges': io.flow.v0.models.TrueupLabelSurcharge[];
   }
 
   interface TransactionMetadataChannel {
@@ -12239,6 +12264,15 @@ declare namespace io.flow.v0.models {
     readonly 'id': string;
   }
 
+  interface TransactionMetadataOutboundTransaction {
+    readonly 'transaction_id': string;
+  }
+
+  interface TransactionMetadataPaymentTransaction {
+    readonly 'discriminator': 'payment_transaction';
+    readonly 'key'?: string;
+  }
+
   interface TransactionMetadataShippingLabel {
     readonly 'discriminator': 'shipping_label';
     readonly 'request_method'?: io.flow.v0.enums.LabelRequestMethod;
@@ -12418,11 +12452,6 @@ declare namespace io.flow.v0.models {
     readonly 'virtual_card_capture': io.flow.v0.models.VirtualCardCapture;
   }
 
-  interface VirtualCardForm {
-    readonly 'limit': io.flow.v0.models.Money;
-    readonly 'attributes'?: Record<string, string>;
-  }
-
   interface VirtualCardReference {
     readonly 'id': string;
   }
@@ -12657,7 +12686,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.TransactionMetadataCarrierCharge | 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.TransactionMetadataCarrierFee | io.flow.v0.models.TransactionMetadataManual | io.flow.v0.models.TransactionMetadataPaymentTransaction);
 }
 
 export const abandonedOrderPromotionStatus: PropTypes.Requireable<io.flow.v0.enums.AbandonedOrderPromotionStatus>;
@@ -14242,12 +14271,15 @@ 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 transactionMetadataCarrierCharge: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataCarrierCharge>;
-export const transactionMetadataCarrierChargeOutbound: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataCarrierChargeOutbound>;
+export const transactionMetadataCarrierFee: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataCarrierFee>;
+export const transactionMetadataCarrierFeeData: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataCarrierFeeData>;
 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>;
 export const transactionMetadataManual: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataManual>;
 export const transactionMetadataOriginalTransaction: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataOriginalTransaction>;
+export const transactionMetadataOutboundTransaction: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataOutboundTransaction>;
+export const transactionMetadataPaymentTransaction: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataPaymentTransaction>;
 export const transactionMetadataShippingLabel: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataShippingLabel>;
 export const transactionMetadataShippingLabelCarrier: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataShippingLabelCarrier>;
 export const transactionMetadataTrueup: PropTypes.Requireable<io.flow.v0.models.TransactionMetadataTrueup>;
@@ -14274,7 +14306,6 @@ export const virtualCardCapture: PropTypes.Requireable<io.flow.v0.models.Virtual
 export const virtualCardCaptureDeleted: PropTypes.Requireable<io.flow.v0.models.VirtualCardCaptureDeleted>;
 export const virtualCardCaptureUpserted: PropTypes.Requireable<io.flow.v0.models.VirtualCardCaptureUpserted>;
 export const virtualCardCaptureVersion: PropTypes.Requireable<io.flow.v0.models.VirtualCardCaptureVersion>;
-export const virtualCardForm: PropTypes.Requireable<io.flow.v0.models.VirtualCardForm>;
 export const virtualCardReference: PropTypes.Requireable<io.flow.v0.models.VirtualCardReference>;
 export const virtualCardRefund: PropTypes.Requireable<io.flow.v0.models.VirtualCardRefund>;
 export const virtualCardRefundDeleted: PropTypes.Requireable<io.flow.v0.models.VirtualCardRefundDeleted>;