@flowio/api-types 0.0.256 → 0.0.258

package/generated/io.flow.billing.v0.billing.d.ts

@@ -5,7 +5,7 @@ declare namespace io.flow.billing.v0.enums {
   type PendingPayoutTransactionReasonCode = 'waiting_for_full_refund' | 'waiting_for_fulfillment' | 'waiting_for_in_transit' | 'waiting_for_next_payout_date' | 'waiting_for_tracking_info' | 'waiting_for_positive_account_balance' | 'unfulfilled_amount_greater_than_negative_balance' | 'account_payment_hold';
   type StatementAttachmentType = 'csv';
   type TaxDutyTransactionReasonCode = 'post_capture' | 'post_fulfilment' | 'manual_payment_or_gift_card' | 'order_edit' | 'mixed_fulfilment_non_lvg' | 'lvg_refund' | 'order_cancellation_above_de_min' | 'wyol_shipment_above_de_min' | 'full_refund_without_shipment' | 'unfulfilled_order_above_de_min';
-  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'trueup_base' | 'trueup_surcharge' | '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' | 'failed_payout' | 'tax_refund' | 'duty_refund' | 'non_l4l_tax_duty_fx' | 'merchant_payout' | 'merchant_refund' | 'ge_revenue_share';
+  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'trueup_base' | 'trueup_surcharge' | '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' | 'failed_payout' | 'tax_refund' | 'duty_refund' | 'non_l4l_tax_duty_fx' | 'merchant_payout' | 'merchant_refund' | 'ge_revenue_share' | 'merchant_fee';
   type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
   type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
 }

package/generated/io.flow.internal.v0.api-internal.d.ts

@@ -18,7 +18,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' | 'merchant_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';
@@ -126,6 +126,7 @@ declare namespace io.flow.internal.v0.enums {
   type LogisticsPayoutResolutionMethod = 'order_combined_shipment' | 'intransit_label_event' | 'shipping_notification';
   type ManualReviewRuleStatus = 'active' | 'archived';
   type ManualTransactionCategory = 'cancelled_order_refund' | 'client_accepted_chargeback' | 'fee_reimbursement' | 'platform_fee' | 'shipping_true_up' | 'tax_credit' | 'carrier_credit' | 'negative_balance_guarantee' | 'bank_payment_failure' | 'non_fraud_chargeback';
+  type MerchantFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
   type MerchantOfRecord = 'global_e_united_states' | 'global_e_united_kingdom' | 'global_e_canada' | 'global_e_netherlands';
   type MerchantOverrideStatus = 'pending' | 'in_review' | 'accepted' | 'rejected';
   type MixedBagWeight = '0' | '1' | '2';
@@ -6147,6 +6148,19 @@ declare namespace io.flow.internal.v0.models {
     readonly 'name': string;
   }
 
+  interface MerchantFeeTransaction {
+    readonly 'discriminator': 'merchant_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 MerchantFees {
     readonly 'duty_guarantee': number;
     readonly 'mor': number;
@@ -9133,6 +9147,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 {
@@ -9196,7 +9211,6 @@ declare namespace io.flow.internal.v0.models {
   interface RestrictionOrganizationDecisionSummary {
     readonly 'organization': io.flow.internal.v0.models.RestrictionOrganization;
     readonly 'earliest_pending_date': string;
-    readonly 'priority_score': number;
     readonly 'date': string;
     readonly 'counts': io.flow.internal.v0.models.RestrictionSummaryCounts;
   }
@@ -12055,6 +12069,6 @@ 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.MerchantFeeTransaction);
   type TransactionSummary = (io.flow.internal.v0.models.PaymentSummaryV2 | io.flow.internal.v0.models.FraudSummary);
 }

package/generated/io.flow.v0.api.d.ts

@@ -210,7 +210,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' | 'unknown' | 'unmapped';
   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' | 'trueup_base' | 'trueup_surcharge' | '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' | 'failed_payout' | 'tax_refund' | 'duty_refund' | 'non_l4l_tax_duty_fx' | 'merchant_payout' | 'merchant_refund' | 'ge_revenue_share';
+  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'shipping_label_revenue_share' | 'trueup' | 'trueup_base' | 'trueup_surcharge' | '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' | 'failed_payout' | 'tax_refund' | 'duty_refund' | 'non_l4l_tax_duty_fx' | 'merchant_payout' | 'merchant_refund' | 'ge_revenue_share' | 'merchant_fee';
   type TransferStatus = 'succeeded' | 'canceled';
   type TransferType = 'payout_to_merchant' | 'disputed_amount_to_merchant' | 'duties_and_taxes_adjustment_to_merchant' | 'disputed_amount_from_merchant' | 'duties_and_taxes_adjustment_from_merchant' | 'refund_from_merchant';
   type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
@@ -2167,6 +2167,18 @@ declare namespace io.flow.v0.models {
     readonly 'duty'?: io.flow.v0.models.ConsumerInvoiceLevyForm;
   }
 
+  interface ConsumerInvoiceLineTip {
+    readonly 'discriminator': 'tip';
+    readonly 'price': io.flow.v0.models.Price;
+    readonly 'tax'?: io.flow.v0.models.ConsumerInvoiceLevy;
+  }
+
+  interface ConsumerInvoiceLineTipForm {
+    readonly 'discriminator': 'tip';
+    readonly 'price': number;
+    readonly 'tax'?: io.flow.v0.models.ConsumerInvoiceLevyForm;
+  }
+
   interface ConsumerInvoiceOrderSummary {
     readonly 'id': string;
     readonly 'number': string;
@@ -10268,8 +10280,8 @@ declare namespace io.flow.v0.unions {
   type CardNumber = (io.flow.v0.models.PaymentMethodCardNumberCleartext | io.flow.v0.models.PaymentMethodCardNumberCipher);
   type CheckoutTokenForm = (io.flow.v0.models.CheckoutTokenOrderForm | io.flow.v0.models.CheckoutTokenReferenceForm);
   type ConfirmationDetails = (io.flow.v0.models.DirectDebit | io.flow.v0.models.CardConfirmationSummary);
-  type ConsumerInvoiceLine = (io.flow.v0.models.ConsumerInvoiceLineItem | io.flow.v0.models.ConsumerInvoiceLineDiscount | io.flow.v0.models.ConsumerInvoiceLineShipping);
-  type ConsumerInvoiceLineForm = (io.flow.v0.models.ConsumerInvoiceLineItemForm | io.flow.v0.models.ConsumerInvoiceLineDiscountForm | io.flow.v0.models.ConsumerInvoiceLineShippingForm);
+  type ConsumerInvoiceLine = (io.flow.v0.models.ConsumerInvoiceLineItem | io.flow.v0.models.ConsumerInvoiceLineDiscount | io.flow.v0.models.ConsumerInvoiceLineShipping | io.flow.v0.models.ConsumerInvoiceLineTip);
+  type ConsumerInvoiceLineForm = (io.flow.v0.models.ConsumerInvoiceLineItemForm | io.flow.v0.models.ConsumerInvoiceLineDiscountForm | io.flow.v0.models.ConsumerInvoiceLineShippingForm | io.flow.v0.models.ConsumerInvoiceLineTipForm);
   type Delivery = (io.flow.v0.models.DigitalDelivery | io.flow.v0.models.PhysicalDelivery);
   type Deminimis = (io.flow.v0.models.DeminimisSimple | io.flow.v0.models.DeminimisPerItem);
   type DeviceDetails = (io.flow.v0.models.DeviceDetailsBrowser);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowio/api-types",
-  "version": "0.0.256",
+  "version": "0.0.258",
   "description": "Global TypeScript typings for Flow Commerce API",
   "repository": {
     "type": "git",
@@ -14,5 +14,5 @@
   "scripts": {
     "generate": "apibuilder update && node scripts/generate-index.js"
   },
-  "gitHead": "303d0c0519735bb00069173b130ffc2680e7f93b"
+  "gitHead": "3006280bce074215dc46ad9c937db245d67d2783"
 }