@flowio/api-types 0.0.226 → 0.0.228

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

@@ -4,6 +4,7 @@ declare namespace io.flow.billing.accounting.v0.models {
     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 'payment'?: io.flow.billing.accounting.v0.models.PaymentSummary;
     readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
     readonly 'sequence_number': number;
     readonly 'posting_cutoff': string;
@@ -148,11 +149,21 @@ declare namespace io.flow.billing.accounting.v0.models {
     readonly 'currency': string;
   }
 
+  interface PaymentSummary {
+    readonly 'psp': number;
+    readonly 'credit': number;
+    readonly 'subsidized': number;
+    readonly 'manual': number;
+    readonly 'cod': number;
+    readonly 'total': number;
+  }
+
   interface PendingOrder {
     readonly 'id': string;
     readonly 'order': io.flow.billing.accounting.v0.models.OrderSummary;
     readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
     readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
+    readonly 'payment'?: io.flow.billing.accounting.v0.models.PaymentSummary;
     readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
     readonly 'sequence_number': number;
     readonly 'posting_cutoff': string;
@@ -169,6 +180,7 @@ declare namespace io.flow.billing.accounting.v0.models {
     readonly 'shopper': io.flow.billing.accounting.v0.models.ShopperSummary;
     readonly 'merchant': io.flow.billing.accounting.v0.models.MerchantSummary;
     readonly 'remittance': io.flow.billing.accounting.v0.models.RemittanceResponsibility;
+    readonly 'payment'?: io.flow.billing.accounting.v0.models.PaymentSummary;
     readonly 'sequence_number': number;
     readonly 'posting_cutoff': string;
     readonly 'trigger': io.flow.billing.accounting.v0.unions.ReturnTrigger;
@@ -221,6 +233,7 @@ declare namespace io.flow.billing.accounting.v0.models {
     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 'tips'?: number;
     readonly 'order_discount': number;
     readonly 'total': number;
   }

package/generated/io.flow.billing.bank.account.v0.billing-bank-account.d.ts

@@ -32,4 +32,4 @@ declare namespace io.flow.billing.bank.account.v0.models {
 
 declare namespace io.flow.billing.bank.account.v0.unions {
   type BankAccountInfo = (io.flow.billing.bank.account.v0.models.BankAccountInfoUsa | io.flow.billing.bank.account.v0.models.BankAccountInfoCan | io.flow.billing.bank.account.v0.models.BankAccountInfoGbr | io.flow.billing.bank.account.v0.models.BankAccountInfoFra | io.flow.billing.bank.account.v0.models.BankAccountInfoIta);
-}
+}

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

@@ -1,5 +1,5 @@
 declare namespace io.flow.billing.internal.v0.enums {
-  type AccountPaymentHoldReason = 'fraudulent' | 'invalid_bank_account';
+  type AccountPaymentHoldReason = 'fraudulent' | 'frozen' | 'invalid_bank_account';
   type AccountSettingLiabilitiesMethod = 'withholding' | 'transaction';
   type AccountType = 'channel' | 'organization';
   type AdjustmentTransactionType = 'adjustment' | 'reversal';

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

@@ -4,7 +4,6 @@ declare namespace io.flow.billing.reporting.csv.v0.models {
     readonly 'sequence_number': number;
     readonly 'fulfilled_at': string;
     readonly 'completes_order': boolean;
-    readonly 'payment': io.flow.billing.reporting.v0.models.ReportingPayment;
     readonly 'value': io.flow.billing.reporting.v0.models.FulfillmentShopperBreakdown;
     readonly 'dispatch_country'?: io.flow.billing.reporting.v0.models.ReportingCountry;
     readonly 'destination': io.flow.billing.reporting.v0.models.ReportingDestination;

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

@@ -1,7 +1,7 @@
 declare namespace io.flow.billing.reporting.v0.enums {
   type ReportPaymentType = 'credit' | 'debit';
   type ReportStatus = 'created' | 'completed' | 'completed_no_records' | 'failed';
-  type ReportType = 'sales_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment' | 'account_quarterly_balances' | 'invariants';
+  type ReportType = 'sales_record' | 'refund_record' | 'other_record' | 'pending_record' | 'trueup_overview' | 'non_channel_payment_bank_account' | 'scheduled_payment' | 'account_quarterly_balances' | 'invariants' | 'payments';
   type ReportingFulfillmentIsVirtual = 'all' | 'mixed' | 'none';
   type RevenueRecordType = 'pending' | 'sales' | 'refund';
 }
@@ -14,6 +14,7 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'subtotal': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'tips'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'discount': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
   }
@@ -143,11 +144,11 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'sequence_number': number;
     readonly 'fulfilled_at': string;
     readonly 'completes_order': boolean;
-    readonly 'payment': io.flow.billing.reporting.v0.models.ReportingPayment;
     readonly 'refund'?: io.flow.billing.reporting.v0.models.ReportingRefundReference;
     readonly 'value': io.flow.billing.reporting.v0.models.FulfillmentShopperBreakdown;
     readonly 'dispatch_country'?: io.flow.billing.reporting.v0.models.ReportingCountry;
     readonly 'destination'?: io.flow.billing.reporting.v0.models.ReportingDestination;
+    readonly 'payment'?: io.flow.billing.reporting.v0.models.ReportingPayment;
     readonly 'shipment'?: io.flow.billing.reporting.v0.models.ReportingShipment;
     readonly 'is': io.flow.billing.reporting.v0.models.ReportingFulfillmentIs;
     readonly 'has': io.flow.billing.reporting.v0.models.ReportingFulfillmentHas;
@@ -166,6 +167,11 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'wyol': boolean;
     readonly 'b2b': boolean;
     readonly 'domestic': boolean;
+    readonly 'combined_shipment'?: boolean;
+    readonly 'order_cancelled'?: boolean;
+    readonly 'lvg'?: boolean;
+    readonly 'tax_inclusive'?: boolean;
+    readonly 'duty_inclusive'?: boolean;
   }
 
   interface ReportingFx {
@@ -174,6 +180,7 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'product': io.flow.billing.reporting.v0.models.ReportingUsd;
     readonly 'tax': io.flow.billing.reporting.v0.models.ReportingUsd;
     readonly 'duty': io.flow.billing.reporting.v0.models.ReportingUsd;
+    readonly 'tips'?: io.flow.billing.reporting.v0.models.ReportingUsd;
     readonly 'total': io.flow.billing.reporting.v0.models.ReportingUsd;
   }
 
@@ -191,6 +198,7 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'processing': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'rate_lock': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'transfer': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
   }
 
   interface ReportingMerchantSubsidies {
@@ -198,6 +206,7 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
   }
 
   interface ReportingMerchantTransactions {
@@ -206,6 +215,8 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'tax': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'duty': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'freight': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'discount'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
   }
 
   interface ReportingMonetaryValue {
@@ -228,25 +239,14 @@ declare namespace io.flow.billing.reporting.v0.models {
   }
 
   interface ReportingPayment {
-    readonly 'metadata'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadata;
     readonly 'psp': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'credit': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'subsidized': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'manual': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'cod': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'total': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
   }
 
-  interface ReportingPaymentMetadata {
-    readonly 'gateway': io.flow.payment.internal.v0.enums.Processor;
-    readonly 'method': string;
-    readonly 'psp_reference'?: string;
-    readonly 'authorization'?: io.flow.billing.reporting.v0.models.ReportingAuthorizationReference;
-    readonly 'settlement_date': string;
-    readonly 'additional_authorizations'?: io.flow.billing.reporting.v0.models.ReportingPaymentMetadataAdditionalAuthorizations;
-  }
-
-  interface ReportingPaymentMetadataAdditionalAuthorizations {
-    readonly 'ids': string;
-  }
-
   interface ReportingProvince {
     readonly 'code'?: string;
     readonly 'name': string;
@@ -275,6 +275,7 @@ declare namespace io.flow.billing.reporting.v0.models {
     readonly 'ccf': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'emergency': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
     readonly 'peak': io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
+    readonly 'total'?: io.flow.billing.reporting.v0.models.ReportingMonetaryValue;
   }
 
   interface ReportingUsd {

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

@@ -301,7 +301,7 @@ declare namespace io.flow.billing.v0.models {
     readonly 'discriminator': 'channel';
     readonly 'method': string;
     readonly 'card'?: io.flow.billing.v0.models.TransactionMetadataChannelCardMetadata;
-    readonly 'organization_transaction': io.flow.billing.v0.models.TransactionReference;
+    readonly 'organization_transaction': io.flow.billing.v0.models.TransactionMetadataChannelOrganizationTransaction;
   }
 
   interface TransactionMetadataChannelCardMetadata {
@@ -314,6 +314,11 @@ declare namespace io.flow.billing.v0.models {
     readonly 'country': string;
   }
 
+  interface TransactionMetadataChannelOrganizationTransaction {
+    readonly 'id': string;
+    readonly 'metadata': io.flow.billing.v0.models.TransactionMetadataPaymentTransaction;
+  }
+
   interface TransactionMetadataFailedPayout {
     readonly 'discriminator': 'failed_payout';
     readonly 'failed_payout': io.flow.billing.v0.models.TransactionMetadataFailedPayoutReference;

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

@@ -1,7 +1,7 @@
 declare namespace io.flow.channel.internal.v0.enums {
   type ChannelOrderAcceptanceErrorAction = 'auto_reject' | 'auto_accept';
   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' | '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';
+  type ChannelOrderAcceptanceRejectionReason = 'unsupported_origin_country' | 'unsupported_destination_country' | 'domestic_order' | 'order_contains_gift_card' | 'order_contains_restricted_goods' | 'missing_order_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 ChannelOrderAcceptanceStatus = 'accepted' | 'rejected' | 'review' | 'edit_review' | 'edit_accepted';
 }
 

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

@@ -0,0 +1,191 @@
+declare namespace io.flow.experiment.internal.v0.enums {
+  type ExperimentDiscriminatorKey = 'experience' | 'feature';
+  type Scope = 'organization' | 'global';
+  type SignificanceAction = 'end_and_implement_winner' | 'end_and_revert' | 'do_nothing';
+  type Status = 'draft' | 'scheduled' | 'live' | 'ended' | 'archived';
+  type TimeseriesType = 'daily' | 'weekly' | 'monthly' | 'yearly';
+}
+
+declare namespace io.flow.experiment.internal.v0.models {
+  interface DailyExperimentResults {
+    readonly 'id': string;
+    readonly 'day': string;
+    readonly 'experiment_key': string;
+    readonly 'experiment_variant_key': string;
+    readonly 'visitor_count': number;
+    readonly 'visitors_with_transactions_count': number;
+    readonly 'conversion_rate': number;
+    readonly 'lower_bound': number;
+    readonly 'upper_bound': number;
+    readonly 'probability_of_being_best'?: number;
+    readonly 'currency'?: string;
+    readonly 'average_order_value'?: number;
+    readonly 'revenue_generated'?: number;
+    readonly 'total_order_count'?: number;
+    readonly 'conversion_rate_uplift'?: number;
+    readonly 'average_order_value_uplift'?: number;
+    readonly 'revenue_generated_uplift'?: number;
+  }
+
+  interface ExperienceExperiment {
+    readonly 'discriminator': 'experience';
+    readonly 'id': string;
+    readonly 'key': string;
+    readonly 'name': string;
+    readonly 'description'?: string;
+    readonly 'status': io.flow.experiment.internal.v0.enums.Status;
+    readonly 'emails': string[];
+    readonly 'started_at'?: string;
+    readonly 'ended_at'?: string;
+    readonly 'variants': io.flow.experiment.internal.v0.models.ExperienceVariant[];
+    readonly 'transitions'?: io.flow.experiment.internal.v0.enums.Status[];
+    readonly 'significance_action'?: io.flow.experiment.internal.v0.enums.SignificanceAction;
+  }
+
+  interface ExperienceVariant {
+    readonly 'discriminator': 'experience_variant';
+    readonly 'experience': io.flow.experiment.internal.v0.models.ExperienceVariantSummary;
+    readonly 'traffic_percentage': number;
+    readonly 'experiment_results'?: io.flow.experiment.internal.v0.models.ExperimentResults;
+  }
+
+  interface ExperienceVariantForm {
+    readonly 'discriminator': 'experience';
+    readonly 'key': string;
+    readonly 'traffic_percentage': number;
+  }
+
+  interface ExperienceVariantSummary {
+    readonly 'key': string;
+    readonly 'name'?: string;
+  }
+
+  interface ExperimentForm {
+    readonly 'name': string;
+    readonly 'description'?: string;
+    readonly 'emails': string[];
+    readonly 'variants': io.flow.experiment.internal.v0.unions.VariantForm[];
+    readonly 'significance_action'?: io.flow.experiment.internal.v0.enums.SignificanceAction;
+    readonly 'session_query'?: string;
+  }
+
+  interface ExperimentFormDefault {
+    readonly 'discriminator': io.flow.experiment.internal.v0.models.ExperimentFormDefaultDiscriminator;
+    readonly 'variants'?: io.flow.experiment.internal.v0.models.ExperimentFormDefaultVariant[];
+  }
+
+  interface ExperimentFormDefaultDiscriminator {
+    readonly 'key': io.flow.experiment.internal.v0.enums.ExperimentDiscriminatorKey;
+    readonly 'values': io.flow.experiment.internal.v0.models.ExperimentFormDefaultDiscriminatorValue[];
+  }
+
+  interface ExperimentFormDefaultDiscriminatorValue {
+    readonly 'key': string;
+    readonly 'name': string;
+    readonly 'scope': io.flow.experiment.internal.v0.enums.Scope;
+  }
+
+  interface ExperimentFormDefaultVariant {
+    readonly 'key': string;
+    readonly 'name': string;
+    readonly 'traffic_percentage'?: number;
+  }
+
+  interface ExperimentMilestone {
+    readonly 'id': string;
+    readonly 'experiment': io.flow.experiment.internal.v0.models.ExperimentReference;
+    readonly 'timestamp': string;
+    readonly 'description': string;
+  }
+
+  interface ExperimentMilestoneForm {
+    readonly 'timestamp'?: string;
+    readonly 'description': string;
+  }
+
+  interface ExperimentReference {
+    readonly 'key': string;
+  }
+
+  interface ExperimentResults {
+    readonly 'id': string;
+    readonly 'experiment_key': string;
+    readonly 'experiment_variant_key': string;
+    readonly 'visitor_count': number;
+    readonly 'visitors_with_transactions_count': number;
+    readonly 'conversion_rate': number;
+    readonly 'lower_bound': number;
+    readonly 'upper_bound': number;
+    readonly 'probability_of_being_best'?: number;
+    readonly 'currency'?: string;
+    readonly 'average_order_value'?: number;
+    readonly 'revenue_generated'?: number;
+    readonly 'total_order_count'?: number;
+    readonly 'conversion_rate_uplift'?: number;
+    readonly 'average_order_value_uplift'?: number;
+    readonly 'revenue_generated_uplift'?: number;
+  }
+
+  interface ExperimentResultsWithTimestamp {
+    readonly 'timestamp': string;
+    readonly 'results': io.flow.experiment.internal.v0.models.ExperimentResults[];
+  }
+
+  interface ExperimentSessionQueryForm {
+    readonly 'session_query'?: string;
+  }
+
+  interface ExperimentVersion {
+    readonly 'id': string;
+    readonly 'timestamp': string;
+    readonly 'type': io.flow.common.v0.enums.ChangeType;
+    readonly 'experiment': io.flow.experiment.internal.v0.unions.Experiment;
+  }
+
+  interface FeatureExperiment {
+    readonly 'discriminator': 'feature';
+    readonly 'id': string;
+    readonly 'key': string;
+    readonly 'name': string;
+    readonly 'description'?: string;
+    readonly 'status': io.flow.experiment.internal.v0.enums.Status;
+    readonly 'emails': string[];
+    readonly 'scope': io.flow.experiment.internal.v0.enums.Scope;
+    readonly 'started_at'?: string;
+    readonly 'ended_at'?: string;
+    readonly 'variants': io.flow.experiment.internal.v0.models.FeatureVariant[];
+    readonly 'transitions'?: io.flow.experiment.internal.v0.enums.Status[];
+    readonly 'significance_action'?: io.flow.experiment.internal.v0.enums.SignificanceAction;
+    readonly 'session_query'?: string;
+  }
+
+  interface FeatureValueReference {
+    readonly 'feature_key': string;
+    readonly 'value': string;
+  }
+
+  interface FeatureVariant {
+    readonly 'discriminator': 'feature_variant';
+    readonly 'value': io.flow.experiment.internal.v0.models.FeatureVariantSummary;
+    readonly 'traffic_percentage': number;
+    readonly 'experiment_results'?: io.flow.experiment.internal.v0.models.ExperimentResults;
+  }
+
+  interface FeatureVariantForm {
+    readonly 'discriminator': 'feature';
+    readonly 'key': string;
+    readonly 'traffic_percentage': number;
+  }
+
+  interface FeatureVariantSummary {
+    readonly 'key': string;
+    readonly 'feature_value': io.flow.experiment.internal.v0.models.FeatureValueReference;
+    readonly 'name'?: string;
+  }
+}
+
+declare namespace io.flow.experiment.internal.v0.unions {
+  type Experiment = (io.flow.experiment.internal.v0.models.ExperienceExperiment | io.flow.experiment.internal.v0.models.FeatureExperiment);
+  type Variant = (io.flow.experiment.internal.v0.models.ExperienceVariant | io.flow.experiment.internal.v0.models.FeatureVariant);
+  type VariantForm = (io.flow.experiment.internal.v0.models.ExperienceVariantForm | io.flow.experiment.internal.v0.models.FeatureVariantForm);
+}