@flowio/api-types 0.0.256 → 0.0.257

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.
@@ -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' | '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' | 'platform_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';
@@ -164,6 +164,7 @@ declare namespace io.flow.internal.v0.enums {
164
164
  type PaymentSummaryType = 'authorization' | 'capture' | 'refund' | 'reversal' | 'credit';
165
165
  type PaymentTerm = 'net7' | 'net15' | 'net30';
166
166
  type PendingRecordType = 'verification' | 'classification' | 'restriction';
167
+ type PlatformFeeTransactionType = 'adjustment' | 'reversal' | 'fee';
167
168
  type PrateekItemType = 'physical' | 'digital';
168
169
  type PreferredBillingSchedule = 'monthly' | 'bi-monthly';
169
170
  type PriceSelector = 'minimum' | 'maximum';
@@ -7922,6 +7923,19 @@ declare namespace io.flow.internal.v0.models {
7922
7923
  readonly 'rate': number;
7923
7924
  }
7924
7925
 
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
+
7925
7939
  interface PrateekItem {
7926
7940
  readonly 'id': string;
7927
7941
  readonly 'number': string;
@@ -9133,6 +9147,7 @@ declare namespace io.flow.internal.v0.models {
9133
9147
  readonly 'review': io.flow.internal.v0.models.RestrictionItemReview;
9134
9148
  readonly 'created_at': string;
9135
9149
  readonly 'updated_at': string;
9150
+ readonly 'channel'?: string;
9136
9151
  }
9137
9152
 
9138
9153
  interface RestrictionItemRequestForm {
@@ -12055,6 +12070,6 @@ declare namespace io.flow.internal.v0.unions {
12055
12070
  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);
12056
12071
  type TaxAmount = (io.flow.internal.v0.models.CalculatedTaxAmount | io.flow.internal.v0.models.NoCalculatedTaxAmount);
12057
12072
  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);
12058
- 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);
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);
12059
12074
  type TransactionSummary = (io.flow.internal.v0.models.PaymentSummaryV2 | io.flow.internal.v0.models.FraudSummary);
12060
12075
  }
@@ -2167,6 +2167,18 @@ declare namespace io.flow.v0.models {
2167
2167
  readonly 'duty'?: io.flow.v0.models.ConsumerInvoiceLevyForm;
2168
2168
  }
2169
2169
 
2170
+ interface ConsumerInvoiceLineTip {
2171
+ readonly 'discriminator': 'tip';
2172
+ readonly 'price': io.flow.v0.models.Price;
2173
+ readonly 'tax'?: io.flow.v0.models.ConsumerInvoiceLevy;
2174
+ }
2175
+
2176
+ interface ConsumerInvoiceLineTipForm {
2177
+ readonly 'discriminator': 'tip';
2178
+ readonly 'price': number;
2179
+ readonly 'tax'?: io.flow.v0.models.ConsumerInvoiceLevyForm;
2180
+ }
2181
+
2170
2182
  interface ConsumerInvoiceOrderSummary {
2171
2183
  readonly 'id': string;
2172
2184
  readonly 'number': string;
@@ -10268,8 +10280,8 @@ declare namespace io.flow.v0.unions {
10268
10280
  type CardNumber = (io.flow.v0.models.PaymentMethodCardNumberCleartext | io.flow.v0.models.PaymentMethodCardNumberCipher);
10269
10281
  type CheckoutTokenForm = (io.flow.v0.models.CheckoutTokenOrderForm | io.flow.v0.models.CheckoutTokenReferenceForm);
10270
10282
  type ConfirmationDetails = (io.flow.v0.models.DirectDebit | io.flow.v0.models.CardConfirmationSummary);
10271
- type ConsumerInvoiceLine = (io.flow.v0.models.ConsumerInvoiceLineItem | io.flow.v0.models.ConsumerInvoiceLineDiscount | io.flow.v0.models.ConsumerInvoiceLineShipping);
10272
- type ConsumerInvoiceLineForm = (io.flow.v0.models.ConsumerInvoiceLineItemForm | io.flow.v0.models.ConsumerInvoiceLineDiscountForm | io.flow.v0.models.ConsumerInvoiceLineShippingForm);
10283
+ type ConsumerInvoiceLine = (io.flow.v0.models.ConsumerInvoiceLineItem | io.flow.v0.models.ConsumerInvoiceLineDiscount | io.flow.v0.models.ConsumerInvoiceLineShipping | io.flow.v0.models.ConsumerInvoiceLineTip);
10284
+ type ConsumerInvoiceLineForm = (io.flow.v0.models.ConsumerInvoiceLineItemForm | io.flow.v0.models.ConsumerInvoiceLineDiscountForm | io.flow.v0.models.ConsumerInvoiceLineShippingForm | io.flow.v0.models.ConsumerInvoiceLineTipForm);
10273
10285
  type Delivery = (io.flow.v0.models.DigitalDelivery | io.flow.v0.models.PhysicalDelivery);
10274
10286
  type Deminimis = (io.flow.v0.models.DeminimisSimple | io.flow.v0.models.DeminimisPerItem);
10275
10287
  type DeviceDetails = (io.flow.v0.models.DeviceDetailsBrowser);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flowio/api-types",
3
- "version": "0.0.256",
3
+ "version": "0.0.257",
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": "303d0c0519735bb00069173b130ffc2680e7f93b"
17
+ "gitHead": "5c6b5f5cb926cc945c9f4291efe22dedfde83355"
18
18
  }