@flowio/api-types 0.0.219 → 0.0.221

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

@@ -0,0 +1,211 @@
+declare namespace io.flow.billing.accounting.v0.models {
+  interface Fulfillment {
+    readonly 'id': string;
+    readonly 'order': io.flow.billing.accounting.v0.models.OrderSummary;
+    readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
+    readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
+    readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
+    readonly 'sequence_number': number;
+    readonly 'posting_cutoff': string;
+    readonly 'trigger': io.flow.billing.accounting.v0.unions.FulfillmentTrigger;
+    readonly 'fulfilled_at': string;
+    readonly 'owner': io.flow.billing.internal.v0.enums.ResponsibleParty;
+    readonly 'origin'?: io.flow.billing.accounting.v0.models.FulfillmentOrigin;
+    readonly 'business'?: io.flow.billing.accounting.v0.models.FulfillmentBusiness;
+    readonly 'completes_order': boolean;
+  }
+
+  interface FulfillmentBusiness {
+    readonly 'vat_registration_number': string;
+  }
+
+  interface FulfillmentOrigin {
+    readonly 'country': string;
+    readonly 'province_code'?: string;
+  }
+
+  interface FulfillmentProofExternalFulfillmentProofReference {
+    readonly 'discriminator': 'external_fulfillment';
+    readonly 'id': string;
+    readonly 'carrier_id'?: string;
+    readonly 'carrier_service_id'?: string;
+    readonly 'carrier_tracking_number'?: string;
+    readonly 'label_id'?: string;
+    readonly 'created_at'?: string;
+  }
+
+  interface FulfillmentProofLabelTrackingReference {
+    readonly 'discriminator': 'label_tracking';
+    readonly 'id': string;
+    readonly 'carrier_id'?: string;
+    readonly 'carrier_service_id'?: string;
+    readonly 'carrier_tracking_number'?: string;
+    readonly 'label_id'?: string;
+    readonly 'created_at'?: string;
+  }
+
+  interface FulfillmentProofOrderCombinedShipmentReference {
+    readonly 'discriminator': 'order_combined_shipment';
+    readonly 'id': string;
+    readonly 'carrier_id'?: string;
+    readonly 'carrier_service_id'?: string;
+    readonly 'carrier_tracking_number'?: string;
+    readonly 'label_id'?: string;
+    readonly 'created_at'?: string;
+  }
+
+  interface FulfillmentProofShippingNotificationReference {
+    readonly 'discriminator': 'shipping_notification';
+    readonly 'id': string;
+    readonly 'carrier_id'?: string;
+    readonly 'carrier_service_id'?: string;
+    readonly 'carrier_tracking_number'?: string;
+    readonly 'label_id'?: string;
+    readonly 'created_at'?: string;
+  }
+
+  interface FulfillmentReference {
+    readonly 'id': string;
+  }
+
+  interface FulfillmentSubsidyBreakdown {
+    readonly 'tax': number;
+    readonly 'duty': number;
+    readonly 'total': number;
+  }
+
+  interface FulfillmentTriggerProof {
+    readonly 'discriminator': 'by_proof';
+    readonly 'proof': io.flow.billing.accounting.v0.unions.FulfillmentProof;
+  }
+
+  interface FulfillmentTriggerTime {
+    readonly 'discriminator': 'by_time';
+    readonly 'placeholder'?: string;
+  }
+
+  interface ItemSummary {
+    readonly 'number': string;
+    readonly 'fulfillment_method': io.flow.catalog.v0.enums.FulfillmentMethodValue;
+    readonly 'country_of_origin'?: string;
+    readonly 'tarriff_code'?: string;
+    readonly 'inferred'?: boolean;
+  }
+
+  interface MerchantFees {
+    readonly 'duty_guarantee': number;
+    readonly 'mor': number;
+    readonly 'fraud': number;
+    readonly 'fx': number;
+    readonly 'processing': number;
+    readonly 'rate_lock': number;
+    readonly 'transfer': number;
+    readonly 'total': number;
+  }
+
+  interface MerchantSubsidies {
+    readonly 'fees': io.flow.billing.accounting.v0.models.ShopperFees;
+    readonly 'tax': number;
+    readonly 'duty': number;
+    readonly 'total': number;
+  }
+
+  interface MerchantSummary {
+    readonly 'subsidies': io.flow.billing.accounting.v0.models.MerchantSubsidies;
+    readonly 'fees': io.flow.billing.accounting.v0.models.MerchantFees;
+    readonly 'transactions': io.flow.billing.accounting.v0.models.MerchantTransactions;
+    readonly 'total': number;
+  }
+
+  interface MerchantTransactions {
+    readonly 'adjustment': number;
+    readonly 'reversal': number;
+    readonly 'tax': number;
+    readonly 'duty': number;
+    readonly 'freight': number;
+    readonly 'total': number;
+  }
+
+  interface OrderSummary {
+    readonly 'id': string;
+    readonly 'organization': io.flow.common.v0.models.OrganizationReference;
+    readonly 'number': string;
+    readonly 'type': io.flow.experience.v0.enums.OrderType;
+    readonly 'submitted_at': string;
+    readonly 'delivered_duty': io.flow.common.v0.enums.DeliveredDuty;
+    readonly 'currency': string;
+  }
+
+  interface RemittanceResponsibility {
+    readonly 'tax': io.flow.billing.internal.v0.enums.ResponsibleParty;
+    readonly 'duty': io.flow.billing.internal.v0.enums.ResponsibleParty;
+  }
+
+  interface Return {
+    readonly 'id': string;
+    readonly 'order': io.flow.billing.accounting.v0.models.OrderSummary;
+    readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
+    readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
+    readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
+    readonly 'sequence_number': number;
+    readonly 'posting_cutoff': string;
+    readonly 'trigger': io.flow.billing.accounting.v0.unions.ReturnTrigger;
+    readonly 'returned_at': string;
+    readonly 'completes_order': boolean;
+  }
+
+  interface ReturnTriggerRefund {
+    readonly 'discriminator': 'by_refund';
+    readonly 'refund': io.flow.payment.v0.models.RefundReference;
+  }
+
+  interface ShopperFees {
+    readonly 'fuel': number;
+    readonly 'remote_area': number;
+    readonly 'oversize': number;
+    readonly 'ccf': number;
+    readonly 'emergency': number;
+    readonly 'peak': number;
+    readonly 'total': number;
+  }
+
+  interface ShopperFreight {
+    readonly 'price': number;
+    readonly 'discount': number;
+    readonly 'tax': number;
+    readonly 'duty': number;
+    readonly 'subsidies': io.flow.billing.accounting.v0.models.FulfillmentSubsidyBreakdown;
+    readonly 'total': number;
+  }
+
+  interface ShopperLine {
+    readonly 'item': io.flow.billing.accounting.v0.models.ItemSummary;
+    readonly 'quantity': number;
+    readonly 'unit_price': number;
+    readonly 'price': number;
+    readonly 'discount': number;
+    readonly 'tax': number;
+    readonly 'duty': number;
+    readonly 'subsidies': io.flow.billing.accounting.v0.models.FulfillmentSubsidyBreakdown;
+    readonly 'total': number;
+  }
+
+  interface ShopperLines {
+    readonly 'lines': io.flow.billing.accounting.v0.models.ShopperLine[];
+    readonly 'total': number;
+  }
+
+  interface ShopperSummary {
+    readonly 'product': io.flow.billing.accounting.v0.models.ShopperLines;
+    readonly 'fees': io.flow.billing.accounting.v0.models.ShopperFees;
+    readonly 'freight': io.flow.billing.accounting.v0.models.ShopperFreight;
+    readonly 'order_discount': number;
+    readonly 'total': number;
+  }
+}
+
+declare namespace io.flow.billing.accounting.v0.unions {
+  type FulfillmentProof = (io.flow.billing.accounting.v0.models.FulfillmentProofLabelTrackingReference | io.flow.billing.accounting.v0.models.FulfillmentProofShippingNotificationReference | io.flow.billing.accounting.v0.models.FulfillmentProofExternalFulfillmentProofReference | io.flow.billing.accounting.v0.models.FulfillmentProofOrderCombinedShipmentReference);
+  type FulfillmentTrigger = (io.flow.billing.accounting.v0.models.FulfillmentTriggerProof | io.flow.billing.accounting.v0.models.FulfillmentTriggerTime);
+  type ReturnTrigger = (io.flow.billing.accounting.v0.models.ReturnTriggerRefund);
+}

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

@@ -348,6 +348,7 @@ declare namespace io.flow.billing.csv.v0.models {
     readonly 'processing': number;
     readonly 'rate_lock': number;
     readonly 'transfer': number;
+    readonly 'negative_balance': number;
   }
 
   interface BillingCsvTransactionIdentifiers {
@@ -368,6 +369,7 @@ declare namespace io.flow.billing.csv.v0.models {
     readonly 'label_created_at': string;
     readonly 'carrier_id': string;
     readonly 'carrier_tracking_number': string;
+    readonly 'revenue_share_percentage': number;
     readonly 'outbound_transaction_id'?: string;
   }
 

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

@@ -1,5 +1,6 @@
 declare namespace io.flow.billing.internal.v0.enums {
   type AccountSettingLiabilitiesMethod = 'withholding' | 'transaction';
+  type AccountStatus = 'active' | 'inactive';
   type AccountType = 'channel' | 'organization';
   type AdjustmentTransactionType = 'adjustment' | 'reversal';
   type BankPaymentPromiseCompletedMethod = 'credit' | 'time';
@@ -9,7 +10,7 @@ declare namespace io.flow.billing.internal.v0.enums {
   type BillingStatementBatchFileKey = 'summary';
   type BillingTransactionStatus = 'pending' | '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';
-  type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge';
+  type CarrierChargeTransactionType = 'adjustment' | 'reversal' | 'charge' | 'revenue_share';
   type ChannelBilledTransactionType = 'adjustment' | 'reversal' | 'channel_initiated';
   type ChannelTransactionType = 'adjustment' | 'reversal' | 'processing';
   type DisputeTransactionType = 'adjustment' | 'dispute';
@@ -100,7 +101,7 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'merchant_of_record_fee'?: number;
     readonly 'duty_guarantee_fee'?: number;
     readonly 'transfer_fee'?: number;
-    readonly 'negative_balance_guarantee_fee'?: number;
+    readonly 'negative_balance_fee'?: number;
     readonly 'order_service_fee'?: io.flow.billing.internal.v0.models.TieredFee;
     readonly 'label_fees'?: io.flow.billing.internal.v0.models.AccountSettingLabelFees;
     readonly 'charge_label_cost_directly': boolean;
@@ -285,6 +286,7 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'b2b_tax_remittance_days'?: number;
     readonly 'mor_fee'?: number;
     readonly 'duty_guarantee_fee'?: number;
+    readonly 'negative_balance_fee'?: number;
     readonly 'order_service_fee'?: io.flow.billing.internal.v0.models.TieredFee;
     readonly 'label_fee'?: io.flow.billing.internal.v0.models.TieredFee;
   }
@@ -382,6 +384,7 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'channel': io.flow.common.v0.models.ChannelReference;
     readonly 'id': string;
     readonly 'key'?: string;
+    readonly 'status': io.flow.billing.internal.v0.enums.AccountStatus;
     readonly 'origin'?: io.flow.billing.internal.v0.models.AccountOrigin;
     readonly 'currency': string;
     readonly 'updated_at': string;
@@ -598,6 +601,7 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'source': io.flow.billing.internal.v0.models.AccountSource;
     readonly 'id': string;
     readonly 'key'?: string;
+    readonly 'status': io.flow.billing.internal.v0.enums.AccountStatus;
     readonly 'origin'?: io.flow.billing.internal.v0.models.AccountOrigin;
     readonly 'currency': string;
     readonly 'updated_at': string;
@@ -612,6 +616,18 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'created_at': string;
   }
 
+  interface FlowAccountStatusForm {
+    readonly 'status': io.flow.billing.internal.v0.enums.AccountStatus;
+  }
+
+  interface FlowBillingStatement {
+    readonly 'id': string;
+    readonly 'account': io.flow.billing.v0.models.AccountReference;
+    readonly 'period': io.flow.common.v0.models.DatetimeRange;
+    readonly 'totals': io.flow.billing.internal.v0.models.BillingStatementTotals;
+    readonly 'attachments': io.flow.billing.internal.v0.models.BillingStatementAttachment[];
+  }
+
   interface FxFee {
     readonly 'base': io.flow.common.v0.models.Money;
     readonly 'local': io.flow.common.v0.models.Money;
@@ -782,6 +798,7 @@ declare namespace io.flow.billing.internal.v0.models {
     readonly 'organization': io.flow.common.v0.models.OrganizationReference;
     readonly 'id': string;
     readonly 'key'?: string;
+    readonly 'status': io.flow.billing.internal.v0.enums.AccountStatus;
     readonly 'origin'?: io.flow.billing.internal.v0.models.AccountOrigin;
     readonly 'currency': string;
     readonly 'updated_at': string;

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

@@ -251,6 +251,7 @@ declare namespace io.flow.billing.reporting.v0.models {
   }
 
   interface ReportingShipment {
+    readonly 'remittance'?: io.flow.billing.accounting.v0.models.RemittanceResponsibility;
     readonly 'carrier': string;
     readonly 'tracking_number'?: string;
   }

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

@@ -4,12 +4,16 @@ declare namespace io.flow.billing.v0.enums {
   type PayoutStatusFailureCode = 'invalid_account_number' | 'account_closed' | 'could_not_process';
   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';
   type StatementAttachmentType = 'csv';
-  type TransactionSource = 'capture' | 'refund' | 'dispute' | 'adjustment' | 'reversal' | 'shipping_label' | 'shipping_label_service' | 'trueup' | 'carrier_charge' | 'shipping_label_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' | '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 WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
 }
 
 declare namespace io.flow.billing.v0.models {
+  interface AccountIdReference {
+    readonly 'id': string;
+  }
+
   interface AccountReference {
     readonly 'id': string;
     readonly 'currency': string;
@@ -106,6 +110,7 @@ declare namespace io.flow.billing.v0.models {
   interface ChannelTransaction {
     readonly 'statement'?: io.flow.billing.v0.models.BillingChannelStatementReference;
     readonly 'id': string;
+    readonly 'account': io.flow.billing.v0.models.AccountIdReference;
     readonly 'metadata'?: io.flow.billing.v0.unions.TransactionMetadata;
     readonly 'order'?: io.flow.billing.v0.models.BillingChannelOrderSummary;
     readonly 'payment_request'?: io.flow.billing.v0.models.BillingChannelPaymentRequestReference;
@@ -132,6 +137,26 @@ declare namespace io.flow.billing.v0.models {
     readonly 'description'?: string;
   }
 
+  interface FlowTransaction {
+    readonly 'statement'?: io.flow.billing.v0.models.BillingChannelStatementReference;
+    readonly 'id': string;
+    readonly 'account': io.flow.billing.v0.models.AccountIdReference;
+    readonly 'metadata'?: io.flow.billing.v0.unions.TransactionMetadata;
+    readonly 'order'?: io.flow.billing.v0.models.BillingChannelOrderSummary;
+    readonly 'payment_request'?: io.flow.billing.v0.models.BillingChannelPaymentRequestReference;
+    readonly 'currency': string;
+    readonly 'source': io.flow.billing.v0.enums.TransactionSource;
+    readonly 'parent'?: io.flow.billing.v0.models.ParentTransactionSummary;
+    readonly 'gross': number;
+    readonly 'fees': io.flow.billing.v0.models.FeeDeduction[];
+    readonly 'withholdings': io.flow.billing.v0.models.WithholdingDeduction[];
+    readonly 'discounts': io.flow.billing.v0.models.BillingDiscount[];
+    readonly 'net': number;
+    readonly 'identifiers': Record<string, string>;
+    readonly 'created_at': string;
+    readonly 'updated_at': string;
+  }
+
   interface OrganizationBankAccount {
     readonly 'id': string;
     readonly 'key': string;
@@ -195,6 +220,7 @@ declare namespace io.flow.billing.v0.models {
 
   interface PayoutTransaction {
     readonly 'id': string;
+    readonly 'account': io.flow.billing.v0.models.AccountIdReference;
     readonly 'metadata'?: io.flow.billing.v0.unions.TransactionMetadata;
     readonly 'order'?: io.flow.billing.v0.models.BillingChannelOrderSummary;
     readonly 'payment_request'?: io.flow.billing.v0.models.BillingChannelPaymentRequestReference;
@@ -244,6 +270,7 @@ declare namespace io.flow.billing.v0.models {
   interface Transaction {
     readonly 'statement'?: io.flow.billing.v0.models.BillingChannelStatementReference;
     readonly 'id': string;
+    readonly 'account': io.flow.billing.v0.models.AccountIdReference;
     readonly 'metadata'?: io.flow.billing.v0.unions.TransactionMetadata;
     readonly 'order'?: io.flow.billing.v0.models.BillingChannelOrderSummary;
     readonly 'payment_request'?: io.flow.billing.v0.models.BillingChannelPaymentRequestReference;
@@ -266,6 +293,7 @@ declare namespace io.flow.billing.v0.models {
     readonly 'label_created_at': string;
     readonly 'carrier_id': string;
     readonly 'carrier_tracking_number': string;
+    readonly 'revenue_share_percentage': number;
     readonly 'outbound'?: io.flow.billing.v0.models.TransactionMetadataCarrierChargeOutbound;
   }
 

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

@@ -42,6 +42,7 @@ declare namespace io.flow.channel.internal.v0.models {
     readonly 'channel_id': string;
     readonly 'external_order_reference': string;
     readonly 'payment_request_id'?: string;
+    readonly 'order_edit_payment_request_ids'?: string[];
     readonly 'status': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceStatus;
     readonly 'reasons': io.flow.channel.internal.v0.models.ChannelOrderAcceptanceReason[];
     readonly 'next_action_from'?: io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceNextActionFrom;