@flowio/api-types 0.0.260 → 0.0.262

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

@@ -3,10 +3,11 @@ declare namespace io.flow.billing.v0.enums {
   type PayoutAttachmentType = 'transactions';
   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' | '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' | 'merchant_fee';
-  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups';
+  type StatementAttachmentType = 'csv' | 'pdf';
+  type StatementStatusCode = 'scheduled' | 'sent' | 'failed';
+  type TaxDutyTransactionReasonCode = 'post_capture' | 'post_fulfilment' | 'manual_payment_or_gift_card' | 'order_edit' | 'mixed_fulfilment_non_lvg' | 'lvg_refund' | 'us_inbound_tax_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' | 'merchant_fee' | 'b2b_tax' | 'b2b_tax_refund';
+  type TrueupSource = 'flow' | 'channel' | 'dhl-parcel' | 'dhl' | 'ups' | 'fedex';
   type WithholdingDeductionType = 'tax' | 'duty' | 'freight' | 'insurance';
 }
 
@@ -268,6 +269,11 @@ declare namespace io.flow.billing.v0.models {
     readonly 'created_at': string;
   }
 
+  interface StatementStatusForm {
+    readonly 'code': io.flow.billing.v0.enums.StatementStatusCode;
+    readonly 'failure_reason'?: io.flow.billing.v0.enums.PayoutStatusFailureCode;
+  }
+
   interface Transaction {
     readonly 'statement'?: io.flow.billing.v0.models.BillingChannelStatementReference;
     readonly 'id': string;
@@ -366,6 +372,25 @@ declare namespace io.flow.billing.v0.models {
   interface TransactionMetadataTaxDuty {
     readonly 'discriminator': 'transaction_tax_duty';
     readonly 'reason_code': io.flow.billing.v0.enums.TaxDutyTransactionReasonCode;
+    readonly 'local_currency'?: string;
+    readonly 'actual'?: io.flow.billing.v0.models.TransactionMetadataTaxDutyActual;
+    readonly 'estimate'?: io.flow.billing.v0.models.TransactionMetadataTaxDutyEstimate;
+    readonly 'delta'?: io.flow.billing.v0.models.TransactionMetadataTaxDutyDelta;
+  }
+
+  interface TransactionMetadataTaxDutyActual {
+    readonly 'base'?: number;
+    readonly 'local'?: number;
+  }
+
+  interface TransactionMetadataTaxDutyDelta {
+    readonly 'base'?: number;
+    readonly 'local'?: number;
+  }
+
+  interface TransactionMetadataTaxDutyEstimate {
+    readonly 'base'?: number;
+    readonly 'local'?: number;
   }
 
   interface TransactionMetadataTrueup {

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

@@ -2,7 +2,7 @@ declare namespace io.flow.channel.internal.v0.enums {
   type ChannelOrderAcceptanceErrorAction = 'auto_reject' | 'auto_accept';
   type ChannelOrderAcceptanceFailureReasonCode = 'channel_order_mor_invalid' | 'channel_order_does_not_exist';
   type ChannelOrderAcceptanceNextActionFrom = 'cx_team' | 'core_team' | 'core_team_investigate' | 'mex_team' | 'payments_team' | 'tc_team' | 'logistics_team';
-  type ChannelOrderAcceptanceRejectionReason = 'unsupported_origin_country' | 'unsupported_destination_country' | 'domestic_order' | 'order_contains_gift_card' | 'order_contains_restricted_goods' | 'missing_order_information' | 'missing_classification_information' | 'unsupported_payment_information' | 'unsupported_shop_currency' | 'unsupported_free_order' | 'extracting_distribution_info_failed' | 'shipping_estimation_failed' | 'payment_authorization_failed' | 'unsupported_subsidized_order' | 'unsupported_virtual_goods' | 'non_matching_currencies' | 'unsupported_order_edit' | 'order_missing';
+  type ChannelOrderAcceptanceRejectionReason = 'unsupported_origin_country' | 'unsupported_destination_country' | 'domestic_order' | 'order_contains_gift_card' | 'order_contains_restricted_goods' | 'missing_order_information' | 'missing_classification_information' | 'unsupported_payment_information' | 'unsupported_shop_currency' | 'unsupported_free_order' | 'extracting_distribution_info_failed' | 'shipping_estimation_failed' | 'payment_authorization_failed' | 'unsupported_subsidized_order' | 'unsupported_virtual_goods' | 'non_matching_currencies' | 'unsupported_order_edit' | 'order_allocation_duties_mismatch' | 'order_missing';
   type ChannelOrderAcceptanceStatus = 'accepted' | 'rejected' | 'review' | 'edit_review' | 'edit_accepted';
   type ChannelService = 'payment' | 'duty_tax_calculator' | 'sellability' | 'all';
   type OrderPaymentSourceType = 'globale' | 'third_party';
@@ -54,6 +54,7 @@ declare namespace io.flow.channel.internal.v0.models {
     readonly 'order_updated_at'?: string;
     readonly 'order_edit_summary'?: io.flow.channel.internal.v0.models.OrderEditSummary;
     readonly 'payment_source'?: io.flow.channel.internal.v0.enums.OrderPaymentSourceType;
+    readonly 'external_order_summary'?: io.flow.channel.shopify.v0.models.ExternalOrderSummary;
   }
 
   interface ChannelOrderAcceptanceDetails {
@@ -79,9 +80,9 @@ declare namespace io.flow.channel.internal.v0.models {
     readonly 'rejection_reason'?: io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceRejectionReason;
   }
 
-  interface ChannelOrganizationDomain {
+  interface ChannelOrganizationDomains {
     readonly 'internal': string;
-    readonly 'public': string;
+    readonly 'external': string;
   }
 
   interface ChannelOrganizationInstallation {
@@ -95,7 +96,7 @@ declare namespace io.flow.channel.internal.v0.models {
   }
 
   interface ChannelOrganizationMetadata {
-    readonly 'domain': io.flow.channel.internal.v0.models.ChannelOrganizationDomain;
+    readonly 'domain': io.flow.channel.internal.v0.models.ChannelOrganizationDomains;
     readonly 'token': string;
   }
 

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

@@ -0,0 +1,28 @@
+declare namespace io.flow.channel.shopify.v0.enums {
+  type ChannelShopifyOrderStateReasonCode = 'placeholder_reason_code';
+}
+
+declare namespace io.flow.channel.shopify.v0.models {
+  interface ChannelShopifyOrderState {
+    readonly 'id': string;
+    readonly 'shopify_order_summary': io.flow.channel.shopify.v0.models.ChannelShopifyOrderSummary;
+    readonly 'status': io.flow.channel.internal.v0.enums.ChannelOrderAcceptanceStatus;
+    readonly 'reasons'?: io.flow.channel.shopify.v0.models.ChannelShopifyOrderStateReason[];
+    readonly 'external_order_summary'?: io.flow.channel.shopify.v0.models.ExternalOrderSummary;
+  }
+
+  interface ChannelShopifyOrderStateReason {
+    readonly 'code': io.flow.channel.shopify.v0.enums.ChannelShopifyOrderStateReasonCode;
+    readonly 'message': string;
+  }
+
+  interface ChannelShopifyOrderSummary {
+    readonly 'order_id': number;
+    readonly 'shop_id': number;
+  }
+
+  interface ExternalOrderSummary {
+    readonly 'id': string;
+    readonly 'edit_ids': string[];
+  }
+}

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

@@ -262,6 +262,8 @@ declare namespace io.flow.common.v0.models {
   interface MerchantOfRecordEntityRegistration {
     readonly 'number': string;
     readonly 'country': string;
+    readonly 'province_number'?: string;
+    readonly 'province'?: string;
   }
 
   interface Money {

package/generated/io.flow.consumer.invoice.v0.consumer-invoice.d.ts

@@ -0,0 +1,242 @@
+declare namespace io.flow.consumer.invoice.v0.enums {
+  type B2BInvoiceType = 'self_bill_invoice' | 'invoice';
+  type ConsumerInvoiceCustomerType = 'business_eu_verified' | 'business_non_verified' | 'individual';
+  type ConsumerInvoiceDocumentType = 'pdf';
+  type ConsumerInvoiceStatus = 'pending' | 'available' | 'invalid';
+  type TaxJurisdictionType = 'country' | 'province';
+  type TaxType = 'vat' | 'gst' | 'hst' | 'pst' | 'qst' | 'sales_tax';
+}
+
+declare namespace io.flow.consumer.invoice.v0.models {
+  interface B2BCreditMemo {
+    readonly 'id': string;
+    readonly 'number': string;
+    readonly 'buyer': io.flow.common.v0.models.MerchantOfRecordEntity;
+    readonly 'seller': io.flow.common.v0.models.MerchantOfRecordEntity;
+    readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
+    readonly 'date': string;
+    readonly 'key': string;
+    readonly 'invoice': io.flow.consumer.invoice.v0.models.B2BInvoiceReference;
+    readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
+    readonly 'tax_lines'?: io.flow.consumer.invoice.v0.models.InvoiceTaxLine[];
+    readonly 'tax'?: io.flow.common.v0.models.Money;
+    readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
+    readonly 'attributes': Record<string, string>;
+    readonly 'b2b_invoice_type': io.flow.consumer.invoice.v0.enums.B2BInvoiceType;
+    readonly 'center'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceCenterReference;
+    readonly 'order'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceOrderSummary;
+  }
+
+  interface B2BInvoice {
+    readonly 'id': string;
+    readonly 'number': string;
+    readonly 'buyer': io.flow.common.v0.models.MerchantOfRecordEntity;
+    readonly 'seller': io.flow.common.v0.models.MerchantOfRecordEntity;
+    readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
+    readonly 'date': string;
+    readonly 'key': string;
+    readonly 'order': io.flow.consumer.invoice.v0.models.ConsumerInvoiceOrderSummary;
+    readonly 'economic_title_location': io.flow.merchant.of.record.v0.enums.EconomicTitleLocation;
+    readonly 'center'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceCenterReference;
+    readonly 'destination'?: io.flow.experience.v0.models.OrderAddress;
+    readonly 'tax': io.flow.common.v0.models.Money;
+    readonly 'tax_lines'?: io.flow.consumer.invoice.v0.models.InvoiceTaxLine[];
+    readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
+    readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
+    readonly 'attributes': Record<string, string>;
+    readonly 'estimated_delivery_date'?: string;
+    readonly 'b2b_invoice_type': io.flow.consumer.invoice.v0.enums.B2BInvoiceType;
+  }
+
+  interface B2BInvoiceReference {
+    readonly 'id': string;
+    readonly 'key': string;
+    readonly 'number': string;
+  }
+
+  interface ConsumerInvoice {
+    readonly 'id': string;
+    readonly 'number': string;
+    readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
+    readonly 'date': string;
+    readonly 'key': string;
+    readonly 'order': io.flow.consumer.invoice.v0.models.ConsumerInvoiceOrderSummary;
+    readonly 'entity': io.flow.common.v0.models.MerchantOfRecordEntity;
+    readonly 'payments': io.flow.consumer.invoice.v0.models.ConsumerInvoicePayment[];
+    readonly 'center'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceCenterReference;
+    readonly 'destination': io.flow.experience.v0.models.OrderAddress;
+    readonly 'billing_address'?: io.flow.common.v0.models.BillingAddress;
+    readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
+    readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
+    readonly 'attributes': Record<string, string>;
+    readonly 'tax_registration'?: io.flow.harmonization.v0.models.TaxRegistration;
+    readonly 'customer_type'?: io.flow.consumer.invoice.v0.enums.ConsumerInvoiceCustomerType;
+    readonly 'estimated_delivery_date'?: string;
+  }
+
+  interface ConsumerInvoiceCenterReference {
+    readonly 'id': string;
+    readonly 'key': string;
+    readonly 'name': string;
+    readonly 'address': io.flow.common.v0.models.Address;
+  }
+
+  interface ConsumerInvoiceDocument {
+    readonly 'type': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceDocumentType;
+    readonly 'language': string;
+    readonly 'url': string;
+  }
+
+  interface ConsumerInvoiceForm {
+    readonly 'order_number': string;
+    readonly 'attributes'?: Record<string, string>;
+  }
+
+  interface ConsumerInvoiceFormByOrder {
+    readonly 'attributes'?: Record<string, string>;
+  }
+
+  interface ConsumerInvoiceLevy {
+    readonly 'rate': number;
+    readonly 'value': io.flow.common.v0.models.Price;
+  }
+
+  interface ConsumerInvoiceLevyForm {
+    readonly 'rate': number;
+    readonly 'amount': number;
+  }
+
+  interface ConsumerInvoiceLineDiscount {
+    readonly 'discriminator': 'discount';
+    readonly 'line_id'?: string;
+    readonly 'price': io.flow.common.v0.models.Price;
+  }
+
+  interface ConsumerInvoiceLineDiscountForm {
+    readonly 'discriminator': 'discount';
+    readonly 'price': number;
+  }
+
+  interface ConsumerInvoiceLineItem {
+    readonly 'discriminator': 'item';
+    readonly 'line_id'?: string;
+    readonly 'item': io.flow.common.v0.models.ItemReference;
+    readonly 'description': string;
+    readonly 'quantity': number;
+    readonly 'unit_price': io.flow.common.v0.models.Price;
+    readonly 'unit_discount'?: io.flow.common.v0.models.Price;
+    readonly 'unit_tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
+    readonly 'unit_duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
+  }
+
+  interface ConsumerInvoiceLineItemForm {
+    readonly 'discriminator': 'item';
+    readonly 'item_number': string;
+    readonly 'quantity': number;
+    readonly 'unit_price': number;
+    readonly 'unit_discount'?: number;
+    readonly 'unit_tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
+    readonly 'unit_duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
+  }
+
+  interface ConsumerInvoiceLineShipping {
+    readonly 'discriminator': 'shipping';
+    readonly 'line_id'?: string;
+    readonly 'price': io.flow.common.v0.models.Price;
+    readonly 'discount'?: io.flow.common.v0.models.Price;
+    readonly 'tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
+    readonly 'duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
+  }
+
+  interface ConsumerInvoiceLineShippingForm {
+    readonly 'discriminator': 'shipping';
+    readonly 'price': number;
+    readonly 'discount'?: number;
+    readonly 'tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
+    readonly 'duty'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
+  }
+
+  interface ConsumerInvoiceLineTip {
+    readonly 'discriminator': 'tip';
+    readonly 'line_id'?: string;
+    readonly 'price': io.flow.common.v0.models.Price;
+    readonly 'tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevy;
+  }
+
+  interface ConsumerInvoiceLineTipForm {
+    readonly 'discriminator': 'tip';
+    readonly 'price': number;
+    readonly 'tax'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceLevyForm;
+  }
+
+  interface ConsumerInvoiceOrderSummary {
+    readonly 'id': string;
+    readonly 'number': string;
+    readonly 'submitted_at': string;
+  }
+
+  interface ConsumerInvoicePayment {
+    readonly 'date': string;
+    readonly 'description': string;
+    readonly 'value': io.flow.common.v0.models.Price;
+    readonly 'billing_address'?: io.flow.common.v0.models.BillingAddress;
+  }
+
+  interface ConsumerInvoiceReference {
+    readonly 'id': string;
+    readonly 'key': string;
+    readonly 'number': string;
+  }
+
+  interface CreditMemo {
+    readonly 'id': string;
+    readonly 'number'?: string;
+    readonly 'status': io.flow.consumer.invoice.v0.enums.ConsumerInvoiceStatus;
+    readonly 'date': string;
+    readonly 'key': string;
+    readonly 'invoice': io.flow.consumer.invoice.v0.models.ConsumerInvoiceReference;
+    readonly 'entity': io.flow.common.v0.models.MerchantOfRecordEntity;
+    readonly 'payments': io.flow.consumer.invoice.v0.models.ConsumerInvoicePayment[];
+    readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLine[];
+    readonly 'documents': io.flow.consumer.invoice.v0.models.ConsumerInvoiceDocument[];
+    readonly 'attributes': Record<string, string>;
+    readonly 'tax_registration'?: io.flow.harmonization.v0.models.TaxRegistration;
+    readonly 'center'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceCenterReference;
+    readonly 'order'?: io.flow.consumer.invoice.v0.models.ConsumerInvoiceOrderSummary;
+  }
+
+  interface CreditMemoForm {
+    readonly 'refund_id'?: string;
+    readonly 'refund_key'?: string;
+    readonly 'refund_identifier'?: string;
+    readonly 'lines': io.flow.consumer.invoice.v0.unions.ConsumerInvoiceLineForm[];
+    readonly 'attributes'?: Record<string, string>;
+  }
+
+  interface InvoiceExport {
+    readonly 'id': string;
+  }
+
+  interface InvoiceExportForm {
+    readonly 'date_from'?: string;
+    readonly 'date_to'?: string;
+  }
+
+  interface InvoiceTaxLine {
+    readonly 'line_id': string;
+    readonly 'tax_breakdown': io.flow.consumer.invoice.v0.models.TaxBreakdown[];
+  }
+
+  interface TaxBreakdown {
+    readonly 'label': string;
+    readonly 'calculated_tax': io.flow.common.v0.models.Money;
+    readonly 'rate': number;
+    readonly 'line_total': io.flow.common.v0.models.Money;
+    readonly 'jurisdiction_type': io.flow.consumer.invoice.v0.enums.TaxJurisdictionType;
+  }
+}
+
+declare namespace io.flow.consumer.invoice.v0.unions {
+  type ConsumerInvoiceLine = (io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineItem | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineDiscount | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineShipping | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineTip);
+  type ConsumerInvoiceLineForm = (io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineItemForm | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineDiscountForm | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineShippingForm | io.flow.consumer.invoice.v0.models.ConsumerInvoiceLineTipForm);
+}