@flowio/api-types 0.0.225 → 0.0.227

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);
+}