@flowio/api-types 0.0.257 → 0.0.258

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5,7 +5,7 @@ declare namespace io.flow.billing.v0.enums {
5
5
  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';
6
6
  type StatementAttachmentType = 'csv';
7
7
  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';
8
- 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';
8
+ 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';
9
9
  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
10
10
  type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
11
11
  }
@@ -18,7 +18,7 @@ declare namespace io.flow.internal.v0.enums {
18
18
  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';
19
19
  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';
20
20
  type BillingTransactionStatus = 'pending_proof' | 'posted';
21
- 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';
21
+ 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';
22
22
  type CalculatorEngine = 'dtce_with_deminimis' | 'dtce_with_inclusive_pricing' | 'dtce_and_us_tax';
23
23
  type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
24
24
  type CarrierChargeType = 'label' | 'tax' | 'other';
@@ -126,6 +126,7 @@ declare namespace io.flow.internal.v0.enums {
126
126
  type LogisticsPayoutResolutionMethod = 'order_combined_shipment' | 'intransit_label_event' | 'shipping_notification';
127
127
  type ManualReviewRuleStatus = 'active' | 'archived';
128
128
  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';
129
+ type MerchantFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
129
130
  type MerchantOfRecord = 'global_e_united_states' | 'global_e_united_kingdom' | 'global_e_canada' | 'global_e_netherlands';
130
131
  type MerchantOverrideStatus = 'pending' | 'in_review' | 'accepted' | 'rejected';
131
132
  type MixedBagWeight = '0' | '1' | '2';
@@ -164,7 +165,6 @@ declare namespace io.flow.internal.v0.enums {
164
165
  type PaymentSummaryType = 'authorization' | 'capture' | 'refund' | 'reversal' | 'credit';
165
166
  type PaymentTerm = 'net7' | 'net15' | 'net30';
166
167
  type PendingRecordType = 'verification' | 'classification' | 'restriction';
167
- type PlatformFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
168
168
  type PrateekItemType = 'physical' | 'digital';
169
169
  type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
170
170
  type PriceSelector = 'minimum' | 'maximum';
@@ -6148,6 +6148,19 @@ declare namespace io.flow.internal.v0.models {
6148
6148
  readonly 'name': string;
6149
6149
  }
6150
6150
 
6151
+ interface MerchantFeeTransaction {
6152
+ readonly 'discriminator': 'merchant_fee_transaction';
6153
+ readonly 'order'?: io.flow.internal.v0.models.BillingOrderTransactionOrderReference;
6154
+ readonly 'id': string;
6155
+ readonly 'type': io.flow.internal.v0.enums.BillingTransactionType;
6156
+ readonly 'status': io.flow.internal.v0.enums.BillingTransactionStatus;
6157
+ readonly 'posted_at'?: string;
6158
+ readonly 'value': io.flow.common.v0.models.Price;
6159
+ readonly 'description': string;
6160
+ readonly 'statement'?: io.flow.internal.v0.models.BillingStatementReference;
6161
+ readonly 'created_at': string;
6162
+ }
6163
+
6151
6164
  interface MerchantFees {
6152
6165
  readonly 'duty_guarantee': number;
6153
6166
  readonly 'mor': number;
@@ -7923,19 +7936,6 @@ declare namespace io.flow.internal.v0.models {
7923
7936
  readonly 'rate': number;
7924
7937
  }
7925
7938
 
7926
- interface PlatformFeeTransaction {
7927
- readonly 'discriminator': 'platform_fee_transaction';
7928
- readonly 'order'?: io.flow.internal.v0.models.BillingOrderTransactionOrderReference;
7929
- readonly 'id': string;
7930
- readonly 'type': io.flow.internal.v0.enums.BillingTransactionType;
7931
- readonly 'status': io.flow.internal.v0.enums.BillingTransactionStatus;
7932
- readonly 'posted_at'?: string;
7933
- readonly 'value': io.flow.common.v0.models.Price;
7934
- readonly 'description': string;
7935
- readonly 'statement'?: io.flow.internal.v0.models.BillingStatementReference;
7936
- readonly 'created_at': string;
7937
- }
7938
-
7939
7939
  interface PrateekItem {
7940
7940
  readonly 'id': string;
7941
7941
  readonly 'number': string;
@@ -9211,7 +9211,6 @@ declare namespace io.flow.internal.v0.models {
9211
9211
  interface RestrictionOrganizationDecisionSummary {
9212
9212
  readonly 'organization': io.flow.internal.v0.models.RestrictionOrganization;
9213
9213
  readonly 'earliest_pending_date': string;
9214
- readonly 'priority_score': number;
9215
9214
  readonly 'date': string;
9216
9215
  readonly 'counts': io.flow.internal.v0.models.RestrictionSummaryCounts;
9217
9216
  }
@@ -12070,6 +12069,6 @@ declare namespace io.flow.internal.v0.unions {
12070
12069
  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);
12071
12070
  type TaxAmount = (io.flow.internal.v0.models.CalculatedTaxAmount | io.flow.internal.v0.models.NoCalculatedTaxAmount);
12072
12071
  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);
12073
- 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);
12072
+ 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);
12074
12073
  type TransactionSummary = (io.flow.internal.v0.models.PaymentSummaryV2 | io.flow.internal.v0.models.FraudSummary);
12075
12074
  }
@@ -210,7 +210,7 @@ declare namespace io.flow.v0.enums {
210
210
  type TrackingStatus = 'label_created' | 'pending' | 'info_received' | 'picked_up' | 'in_transit' | 'out_for_delivery' | 'attempt_fail' | 'delivered' | 'exception' | 'returned' | 'expired' | 'unknown' | 'unmapped';
211
211
  type TradeAgreementName = 'USMCA' | 'T-MEC' | 'CUSMA' | 'TCA';
212
212
  type TradeAgreementStatus = 'supported' | 'not_supported';
213
- 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';
213
+ 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';
214
214
  type TransferStatus = 'succeeded' | 'canceled';
215
215
  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';
216
216
  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/api-types",
3
- "version": "0.0.257",
3
+ "version": "0.0.258",
4
4
  "description": "Global TypeScript typings for Flow Commerce API",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,5 +14,5 @@
14
14
  "scripts": {
15
15
  "generate": "apibuilder update && node scripts/generate-index.js"
16
16
  },
17
- "gitHead": "5c6b5f5cb926cc945c9f4291efe22dedfde83355"
17
+ "gitHead": "3006280bce074215dc46ad9c937db245d67d2783"
18
18
  }