@flowio/api-internal-prop-types 9.24.123 → 9.24.125

package/lib/api-internal.d.ts

@@ -13450,7 +13450,7 @@ declare namespace io.flow.internal.v0.enums {
   type BillingMetricKey = 'adjustment_transactions_count' | 'adjustment_transactions_total' | 'capture_transactions_count' | 'capture_transactions_reconcile_payments_count' | 'capture_transactions_ignored_fraud_count' | 'capture_transactions_ignored_fully_refunded_count' | 'capture_transactions_ignored_other_count' | 'capture_transactions_ignored_previously_processed_count' | 'capture_transactions_succeeded_then_failed_count' | 'capture_transactions_succeeded_then_failed_total' | 'capture_transactions_succeeded_then_failed_same_day_count' | 'capture_transactions_succeeded_then_failed_same_day_total' | 'capture_queued_count' | 'capture_transactions_total' | 'carrier_charge_transactions_count' | 'carrier_charge_transactions_total' | 'channel_transactions_processing_count' | 'channel_transactions_processing_total' | 'channel_transactions_adjustment_count' | 'channel_transactions_adjustment_total' | 'channel_transactions_reversal_count' | 'channel_transactions_reversal_total' | 'channel_billed_transactions_count' | 'channel_billed_transactions_total' | 'credit_payment_transactions_count' | 'credit_payment_transactions_total' | 'duty_to_labels_ratio' | 'duty_transactions_count' | 'duty_transactions_total' | 'fully_subsidized_order_transactions_count' | 'fully_subsidized_order_transactions_total' | 'billable_label_transactions_count' | 'billable_label_transactions_count_for_unique_orders' | 'billable_label_transactions_count_with_revenue_share' | 'billable_label_transactions_count_without_revenue_share' | 'billable_label_transactions_total' | 'revenue_share_label_transactions_count' | 'revenue_share_label_transactions_count_for_unique_orders' | 'revenue_share_label_transactions_total' | 'manual_transactions_count' | 'manual_transactions_total' | 'order_transactions_count' | 'order_transactions_total' | 'refund_transactions_count' | 'refund_transactions_reconcile_payments_count' | 'refund_transactions_ignored_fraud_count' | 'refund_transactions_ignored_fully_refunded_count' | 'refund_transactions_ignored_other_count' | 'refund_transactions_ignored_previously_processed_count' | 'refund_queued_count' | 'refund_transactions_total' | 'refund_transactions_succeeded_then_failed_count' | 'refund_transactions_succeeded_then_failed_total' | 'refund_transactions_succeeded_then_failed_same_day_count' | 'refund_transactions_succeeded_then_failed_same_day_total' | 'reversal_order_cancellations_transactions_count' | 'reversal_order_cancellations_transactions_total' | 'reversal_external_fulfillment_transactions_count' | 'reversal_external_fulfillment_transactions_total' | 'reversal_other_transactions_count' | 'reversal_other_transactions_total' | 'reversal_all_transactions_count' | 'reversal_all_transactions_total' | 'tax_to_labels_ratio' | 'tax_transactions_count' | 'tax_transactions_total' | 'transfer_transactions_count' | 'transfer_transactions_total' | 'trueup_transactions_count' | 'trueup_transactions_total' | 'fulfillments_count' | 'fulfilled_via_replacement_order_count' | 'percentage_orders_with_fulfillment_proof_2_weeks' | 'percentage_orders_with_fulfillment_proof_4_weeks' | 'percentage_orders_with_fulfillment_proof_6_weeks' | 'percentage_orders_with_fulfillment_proof_all' | 'pending_payouts_max_age_in_millis' | 'shipping_notifications_count' | 'queued_capture_unprocessed_count' | 'queued_refund_unprocessed_count' | 'queued_label_invoice_request_unprocessed_count' | 'queued_other_unprocessed_count' | 'task_snooze_count' | 'task_snooze_ending_in_48_hours_count' | 'payouts_scheduled_count' | 'payouts_scheduled_total' | 'payouts_sent_count' | 'payouts_sent_total' | 'payouts_failed_count' | 'payouts_failed_total' | 'average_payout_amount' | 'capture_transaction_with_zero_fees_and_no_channel_transaction_count' | 'percentage_billable_label_transactions_with_carrier_charge_10_days' | 'percentage_billable_label_transactions_with_carrier_charge_20_days' | 'percentage_billable_label_transactions_with_carrier_charge_30_days' | 'percentage_billable_label_transactions_with_carrier_charge_60_days' | 'percentage_billable_label_transactions_with_carrier_charge_90_days' | 'percentage_bank_account_inserts' | 'percentage_bank_account_updates' | 'percentage_bank_account_unique_updates' | 'percentage_bank_account_deletes' | 'negative_balance_number_accounts' | 'negative_balance_number_accounts_with_order_in_past_30_days' | 'negative_balance_number_accounts_without_order_in_past_30_days' | 'negative_balance_number_offboarded_accounts' | 'negative_balance_number_active_accounts_with_balance_over_1000' | 'negative_balance_total' | 'negative_balance_total_with_order_in_past_30_days' | 'negative_balance_total_without_order_in_past_30_days' | 'negative_balance_total_offboarded_accounts' | 'negative_balance_single_account_max' | 'negative_balance_single_active_account_max' | 'negative_balance_fee_total' | 'accounts_with_payment_holds_count' | 'accounts_with_payment_holds_pending_payment_promise_count' | 'accounts_with_payment_holds_pending_payment_promise_total' | 'edited_order_tax_amount_exceeding_transaction' | 'edited_order_duty_amount_exceeding_transaction' | 'negative_balance_scheduled_count' | 'negative_balance_scheduled_total' | 'negative_balance_sent_count' | 'negative_balance_sent_total' | 'negative_balance_failed_count' | 'negative_balance_failed_total' | 'negative_debit_success_rate' | 'current_attempt_merchant_count' | 'current_attempt_amount_total' | 'current_attempt_failed_merchant_count' | 'current_attempt_failed_amount_total' | 'current_attempt_success_ratio' | 'first_attempt_merchant_count' | 'first_attempt_amount_total' | 'first_attempt_failed_merchant_count' | 'first_attempt_failed_amount_total' | 'first_attempt_success_ratio' | 'second_attempt_merchant_count' | 'second_attempt_amount_total' | 'second_attempt_failed_merchant_count' | 'second_attempt_failed_amount_total' | 'second_attempt_success_ratio' | 'third_attempt_merchant_count' | 'third_attempt_amount_total' | 'third_attempt_failed_merchant_count' | 'third_attempt_failed_amount_total' | 'third_attempt_success_ratio' | 'fourth_plus_attempt_merchant_count' | 'fourth_plus_attempt_amount_total' | 'fourth_plus_attempt_failed_merchant_count' | 'fourth_plus_attempt_failed_amount_total' | 'fourth_plus_attempt_success_ratio' | 'ge_revenue_share_standard_transactions_count' | 'ge_revenue_share_standard_transactions_total' | 'ge_revenue_share_standard_transactions_percentage' | 'ge_revenue_share_shopify_plus_transactions_count' | 'ge_revenue_share_shopify_plus_transactions_total' | 'ge_revenue_share_shopify_plus_transactions_percentage' | 'non_l4l_tax_duty_fx_transactions_count' | 'non_l4l_tax_duty_fx_transactions_total' | 'non_l4l_tax_duty_fx_transactions_percentage' | 'sp_adjustment_transactions_count' | 'sp_adjustment_transactions_total' | 'sp_billable_label_transactions_count' | 'sp_billable_label_transactions_count_for_unique_orders' | 'sp_billable_label_transactions_total' | 'capture_transactions_standard_count' | 'capture_transactions_standard_total' | 'capture_transactions_shopify_plus_count' | 'capture_transactions_shopify_plus_total' | 'sp_capture_transactions_count' | 'sp_capture_transactions_total' | 'sp_carrier_charge_transactions_count' | 'sp_carrier_charge_transactions_total' | 'sp_channel_transactions_count' | 'sp_channel_transactions_total' | 'sp_duty_transactions_count' | 'sp_duty_transactions_total' | 'sp_manual_transactions_count' | 'sp_manual_transactions_total' | 'sp_refund_transactions_count' | 'sp_refund_transactions_total' | 'sp_reversal_transactions_count' | 'sp_reversal_transactions_total' | 'sp_revenue_share_label_transactions_count' | 'sp_revenue_share_label_transactions_count_for_unique_orders' | 'sp_revenue_share_label_transactions_total' | 'sp_tax_transactions_count' | 'sp_tax_transactions_total' | 'sp_transfer_transactions_count' | 'sp_transfer_transactions_total' | 'sp_trueup_transactions_count' | 'sp_trueup_transactions_total';
   type BillingStatementAttachmentKey = 'invoice' | 'statement' | 'consumer_invoice' | 'credit_memo' | 'channel_billed' | 'transactions' | 'virtual_card' | 'tax_remittance' | 'manual' | 'orders' | 'label' | 'order_service' | 'tax' | 'duty' | 'trueup' | 'carrier_charge' | 'all';
   type BillingTransactionStatus = 'pending_proof' | 'posted';
-  type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'reversal' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment' | 'dispute' | 'channel' | 'label' | 'order' | 'channel_billed' | 'tax' | 'duty' | 'trueup' | 'carrier_charge' | 'non_l4l_tax_duty_fx' | 'tax_refund' | 'duty_refund' | 'ge_revenue_share' | 'merchant_payout' | 'merchant_refund';
+  type BillingTransactionType = 'manual' | 'subscription' | 'invoice' | 'transfer' | 'adjustment' | 'reversal' | 'capture' | 'refund' | 'virtual_card_capture' | 'virtual_card_refund' | 'tax_remittance' | 'fully_subsidized_order' | 'credit_payment' | 'dispute' | 'channel' | 'label' | 'order' | 'channel_billed' | 'tax' | 'duty' | 'trueup' | 'carrier_charge' | 'non_l4l_tax_duty_fx' | 'tax_refund' | 'duty_refund' | 'ge_revenue_share' | 'platform_fee' | 'merchant_payout' | 'merchant_refund';
   type CalculatorEngine = 'dtce_with_deminimis' | 'dtce_with_inclusive_pricing' | 'dtce_and_us_tax';
   type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
   type CarrierChargeType = 'label' | 'tax' | 'other';
@@ -13596,6 +13596,7 @@ declare namespace io.flow.internal.v0.enums {
   type PaymentSummaryType = 'authorization' | 'capture' | 'refund' | 'reversal' | 'credit';
   type PaymentTerm = 'net7' | 'net15' | 'net30';
   type PendingRecordType = 'verification' | 'classification' | 'restriction';
+  type PlatformFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
   type PrateekItemType = 'physical' | 'digital';
   type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
   type PriceSelector = 'minimum' | 'maximum';
@@ -21354,6 +21355,19 @@ declare namespace io.flow.internal.v0.models {
     readonly 'rate': number;
   }
 
+  interface PlatformFeeTransaction {
+    readonly 'discriminator': 'platform_fee_transaction';
+    readonly 'order'?: io.flow.internal.v0.models.BillingOrderTransactionOrderReference;
+    readonly 'id': string;
+    readonly 'type': io.flow.internal.v0.enums.BillingTransactionType;
+    readonly 'status': io.flow.internal.v0.enums.BillingTransactionStatus;
+    readonly 'posted_at'?: string;
+    readonly 'value': io.flow.common.v0.models.Price;
+    readonly 'description': string;
+    readonly 'statement'?: io.flow.internal.v0.models.BillingStatementReference;
+    readonly 'created_at': string;
+  }
+
   interface PrateekItem {
     readonly 'id': string;
     readonly 'number': string;
@@ -22565,6 +22579,7 @@ declare namespace io.flow.internal.v0.models {
     readonly 'review': io.flow.internal.v0.models.RestrictionItemReview;
     readonly 'created_at': string;
     readonly 'updated_at': string;
+    readonly 'channel'?: string;
   }
 
   interface RestrictionItemRequestForm {
@@ -22690,6 +22705,7 @@ declare namespace io.flow.internal.v0.models {
     readonly 'updated_at': string;
     readonly 'taxonomy_category'?: io.flow.product.v0.models.ProductTaxonomyCategory;
     readonly 'taxonomy_data'?: io.flow.product.v0.models.ProductTaxonomyData[];
+    readonly 'channel'?: string;
   }
 
   interface RestrictionProductDecisionForm {
@@ -22808,7 +22824,6 @@ declare namespace io.flow.internal.v0.models {
     readonly 'organization_id': string;
     readonly 'rule_id': string;
     readonly 'description': string;
-    readonly 'is_rule_exempt': boolean;
     readonly 'exempt_regions'?: string[];
     readonly 'ignored_keywords'?: string[];
     readonly 'additional_keywords'?: string[];
@@ -25487,7 +25502,7 @@ declare namespace io.flow.internal.v0.unions {
   type TaskMetadata = (io.flow.internal.v0.models.StatementCreationMetadata | io.flow.internal.v0.models.AccountingPendingOrderMetadata | io.flow.internal.v0.models.TaxDutyReasonCodeMetadata | io.flow.internal.v0.models.AccountingReturnMetadata | io.flow.internal.v0.models.NonL4LTaxDutyFxFeeMetadata);
   type TaxAmount = (io.flow.internal.v0.models.CalculatedTaxAmount | io.flow.internal.v0.models.NoCalculatedTaxAmount);
   type Tracker = (io.flow.internal.v0.models.GoogleAnalytics | io.flow.internal.v0.models.GoogleGlobalSiteTag | io.flow.internal.v0.models.GoogleTagManager | io.flow.internal.v0.models.FacebookPixel | io.flow.internal.v0.models.SnapchatPixel);
-  type Transaction = (io.flow.internal.v0.models.InvoiceTransaction | io.flow.internal.v0.models.ManualTransaction | io.flow.internal.v0.models.ProcessingTransaction | io.flow.internal.v0.models.SubscriptionTransaction | io.flow.internal.v0.models.TaxRemittanceTransaction | io.flow.internal.v0.models.TransferTransaction | io.flow.internal.v0.models.VirtualCardTransaction | io.flow.internal.v0.models.DisputeTransaction | io.flow.internal.v0.models.ChannelTransaction | io.flow.internal.v0.models.LabelTransaction | io.flow.internal.v0.models.OrderTransaction | io.flow.internal.v0.models.ChannelBilledTransaction | io.flow.internal.v0.models.TaxTransaction | io.flow.internal.v0.models.DutyTransaction | io.flow.internal.v0.models.TrueupTransaction | io.flow.internal.v0.models.CarrierChargeTransaction | io.flow.internal.v0.models.NonL4LTaxDutyFxTransaction | io.flow.internal.v0.models.GeRevenueShareTransaction);
+  type Transaction = (io.flow.internal.v0.models.InvoiceTransaction | io.flow.internal.v0.models.ManualTransaction | io.flow.internal.v0.models.ProcessingTransaction | io.flow.internal.v0.models.SubscriptionTransaction | io.flow.internal.v0.models.TaxRemittanceTransaction | io.flow.internal.v0.models.TransferTransaction | io.flow.internal.v0.models.VirtualCardTransaction | io.flow.internal.v0.models.DisputeTransaction | io.flow.internal.v0.models.ChannelTransaction | io.flow.internal.v0.models.LabelTransaction | io.flow.internal.v0.models.OrderTransaction | io.flow.internal.v0.models.ChannelBilledTransaction | io.flow.internal.v0.models.TaxTransaction | io.flow.internal.v0.models.DutyTransaction | io.flow.internal.v0.models.TrueupTransaction | io.flow.internal.v0.models.CarrierChargeTransaction | io.flow.internal.v0.models.NonL4LTaxDutyFxTransaction | io.flow.internal.v0.models.GeRevenueShareTransaction | io.flow.internal.v0.models.PlatformFeeTransaction);
   type TransactionSummary = (io.flow.internal.v0.models.PaymentSummaryV2 | io.flow.internal.v0.models.FraudSummary);
 }
 
@@ -25656,6 +25671,7 @@ export const paymentSummaryStatus: PropTypes.Requireable<io.flow.internal.v0.enu
 export const paymentSummaryType: PropTypes.Requireable<io.flow.internal.v0.enums.PaymentSummaryType>;
 export const paymentTerm: PropTypes.Requireable<io.flow.internal.v0.enums.PaymentTerm>;
 export const pendingRecordType: PropTypes.Requireable<io.flow.internal.v0.enums.PendingRecordType>;
+export const platformFeeTransactionType: PropTypes.Requireable<io.flow.internal.v0.enums.PlatformFeeTransactionType>;
 export const prateekItemType: PropTypes.Requireable<io.flow.internal.v0.enums.PrateekItemType>;
 export const preferredBillingSchedule: PropTypes.Requireable<io.flow.internal.v0.enums.PreferredBillingSchedule>;
 export const priceSelector: PropTypes.Requireable<io.flow.internal.v0.enums.PriceSelector>;
@@ -26703,6 +26719,7 @@ export const platformFeeFlat: PropTypes.Requireable<io.flow.internal.v0.models.P
 export const platformFeePause: PropTypes.Requireable<io.flow.internal.v0.models.PlatformFeePause>;
 export const platformFeePercentage: PropTypes.Requireable<io.flow.internal.v0.models.PlatformFeePercentage>;
 export const platformFeePercentageTier: PropTypes.Requireable<io.flow.internal.v0.models.PlatformFeePercentageTier>;
+export const platformFeeTransaction: PropTypes.Requireable<io.flow.internal.v0.models.PlatformFeeTransaction>;
 export const prateekItem: PropTypes.Requireable<io.flow.internal.v0.models.PrateekItem>;
 export const prateekItemForm: PropTypes.Requireable<io.flow.internal.v0.models.PrateekItemForm>;
 export const prediction: PropTypes.Requireable<io.flow.internal.v0.models.Prediction>;