@storyblok/management-api-client 0.2.5 → 0.4.0

package/dist/generated/experiments/types.gen.d.cts

@@ -0,0 +1,522 @@
+//#region src/generated/experiments/types.gen.d.ts
+/**
+ * An A/B testing experiment
+ */
+type Experiment = {
+  /**
+   * Numeric ID of the experiment
+   */
+  id: number;
+  /**
+   * Internal name (lowercase letters, numbers, underscores)
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name: string;
+  /**
+   * Optional description of the experiment
+   */
+  description?: string | null;
+  /**
+   * Current status of the experiment
+   */
+  status: 'draft' | 'running' | 'paused' | 'completed';
+  /**
+   * Timestamp when the experiment was first activated
+   */
+  started_at?: string | null;
+  /**
+   * Timestamp when the experiment was completed
+   */
+  ended_at?: string | null;
+  /**
+   * Creation timestamp
+   */
+  created_at: string;
+  /**
+   * Last update timestamp
+   */
+  updated_at: string;
+  /**
+   * IDs of original stories assigned to this experiment
+   */
+  story_ids: Array<number>;
+  /**
+   * ID of the winning variant (set when completed with a winner)
+   */
+  winning_variant_id?: number | null;
+};
+/**
+ * Mapping between an original story and its variant copy
+ */
+type StoryMapping = {
+  /**
+   * ID of the variant this mapping belongs to
+   */
+  experiment_variant_id?: number;
+  /**
+   * ID of the original story
+   */
+  original_story_id?: number;
+  /**
+   * ID of the variant story copy
+   */
+  variant_story_id?: number | null;
+  /**
+   * Full slug of the original story
+   */
+  original_slug?: string | null;
+  /**
+   * Full slug of the variant story copy
+   */
+  variant_slug?: string | null;
+  /**
+   * The variant story object, when expanded
+   */
+  variant_story?: {
+    [key: string]: unknown;
+  } | null;
+};
+/**
+ * A variant within an experiment
+ */
+type ExperimentVariant = {
+  /**
+   * Numeric ID of the variant
+   */
+  id: number;
+  /**
+   * Internal name (lowercase, numbers, underscores)
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name: string;
+  /**
+   * Public identifier used for stable bucketing
+   */
+  public_id: string;
+  /**
+   * Traffic weight percentage (0-100)
+   */
+  weight: number;
+  /**
+   * Whether this is the control variant
+   */
+  is_control: boolean;
+  /**
+   * Story-level variant mappings
+   */
+  story_mappings: Array<StoryMapping>;
+};
+type ExperimentDetail = Experiment & {
+  /**
+   * Variants belonging to this experiment
+   */
+  experiment_variants: Array<ExperimentVariant>;
+  /**
+   * Metrics assigned to this experiment
+   */
+  experiment_assigned_metrics?: Array<{
+    [key: string]: unknown;
+  }>;
+};
+/**
+ * Input for creating an experiment
+ */
+type ExperimentCreate = {
+  /**
+   * Internal name (lowercase letters, numbers, underscores only)
+   */
+  name: string;
+  /**
+   * Human-readable display name
+   */
+  display_name: string;
+  /**
+   * Optional description of the experiment
+   */
+  description?: string;
+  /**
+   * IDs of stories to assign to this experiment
+   */
+  story_ids?: Array<number>;
+  /**
+   * Variants to create with the experiment
+   */
+  experiment_variants_attributes?: Array<{
+    name: string;
+    display_name: string;
+    weight?: number;
+    is_control?: boolean;
+  }>;
+};
+/**
+ * Input for updating an experiment
+ */
+type ExperimentUpdate = {
+  display_name?: string;
+  description?: string;
+  story_ids?: Array<number>;
+  /**
+   * Variants to add, update, or remove
+   */
+  experiment_variants_attributes?: Array<{
+    /**
+     * ID of an existing variant (required for update or delete)
+     */
+    id?: number;
+    name?: string;
+    display_name?: string;
+    weight?: number;
+    is_control?: boolean;
+    /**
+     * Set to true to remove this variant
+     */
+    _destroy?: boolean;
+  }>;
+};
+/**
+ * Bar chart with variant comparison data
+ */
+type BarChart = {
+  kind: 'bar';
+  title?: string | null;
+  xLabel?: string | null;
+  yLabel?: string | null;
+  labels: Array<string>;
+  series: Array<ChartSeries>;
+};
+/**
+ * Line chart for time-series data
+ */
+type LineChart = {
+  kind: 'line';
+  title?: string | null;
+  xLabel?: string | null;
+  yLabel?: string | null;
+  labels: Array<string>;
+  series: Array<ChartSeries>;
+};
+/**
+ * Text-only block for insights or summary copy
+ */
+type TextChart = {
+  kind: 'text';
+  title?: string | null;
+  /**
+   * Insight text content
+   */
+  body: string;
+};
+type ChartSeries = {
+  /**
+   * Series label
+   */
+  label: string;
+  /**
+   * Numeric data points aligned with labels
+   */
+  data: Array<number>;
+};
+/**
+ * A result chart. The kind field determines the chart type.
+ */
+type Chart = BarChart | LineChart | TextChart;
+/**
+ * Pre-computed result charts for an experiment
+ */
+type ExperimentResult = {
+  id: number;
+  experiment_id: number;
+  charts: Array<Chart>;
+  pushed_at: string;
+  created_at: string;
+  updated_at: string;
+};
+type ListData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: {
+    /**
+     * Filter experiments by status
+     */
+    by_status?: 'draft' | 'running' | 'paused' | 'completed';
+    /**
+     * Filter experiments that include the given original story id
+     */
+    by_story_id?: number;
+    /**
+     * Filter experiments that include the given variant story id
+     */
+    by_variant_story_id?: number;
+    /**
+     * Page number for pagination
+     */
+    page?: number;
+    /**
+     * Number of experiments per page
+     */
+    per_page?: number;
+  };
+  url: '/v1/spaces/{space_id}/experiments';
+};
+type ListResponses = {
+  /**
+   * List of experiments
+   */
+  200: {
+    experiments: Array<ExperimentDetail>;
+  };
+};
+type CreateData = {
+  body: {
+    experiment: ExperimentCreate;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments';
+};
+type CreateResponses = {
+  /**
+   * Experiment created
+   */
+  201: {
+    experiment: ExperimentDetail;
+  };
+};
+type DeleteResponses = {
+  /**
+   * Experiment deleted
+   */
+  204: void;
+};
+type GetResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type UpdateData = {
+  body: {
+    experiment: ExperimentUpdate;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}';
+};
+type UpdateResponses = {
+  /**
+   * Experiment updated
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type ActivateData = {
+  body?: never;
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: {
+    /**
+     * Optional scheduled end date for the experiment (ISO 8601)
+     */
+    end_date?: string;
+  };
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/activate';
+};
+type ActivateResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type PauseResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type CompleteResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type CompleteWithWinnerResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type SelectWinnerResponses = {
+  /**
+   * Experiment details
+   */
+  200: {
+    experiment: ExperimentDetail;
+  };
+};
+type CreateExperimentStoryData = {
+  body: {
+    experiment_story: {
+      /**
+       * ID of the story to link
+       */
+      story_id: number;
+    };
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/stories';
+};
+type CreateExperimentStoryResponses = {
+  /**
+   * Story linked
+   */
+  201: {
+    experiment: ExperimentDetail;
+  };
+};
+type DeleteExperimentStoryResponses = {
+  /**
+   * Story unlinked
+   */
+  204: void;
+};
+type CreateStoryMappingData = {
+  body: {
+    story_mapping: {
+      /**
+       * ID of the original story to map
+       */
+      original_story_id: number;
+      /**
+       * ID of an existing story to link as the variant. Omit to duplicate the original.
+       */
+      variant_story_id?: number | null;
+    };
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+    /**
+     * The numeric ID of the experiment variant
+     */
+    variant_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/variants/{variant_id}/story_mappings';
+};
+type CreateStoryMappingResponses = {
+  /**
+   * Story mapping created
+   */
+  201: {
+    story_mapping: StoryMapping;
+  };
+};
+type DeleteStoryMappingResponses = {
+  /**
+   * Story mapping deleted
+   */
+  204: void;
+};
+type GetResultsResponses = {
+  /**
+   * Experiment results
+   */
+  200: {
+    experiment_result: ExperimentResult;
+  };
+  /**
+   * No results have been pushed yet
+   */
+  204: void;
+};
+type PushResultsData = {
+  body: {
+    /**
+     * Pre-computed chart snapshots (max 20)
+     */
+    charts: Array<Chart>;
+  };
+  path: {
+    /**
+     * The ID of the Storyblok space (can be integer or string)
+     */
+    space_id: number | string;
+    /**
+     * The numeric ID of the experiment
+     */
+    experiment_id: number | string;
+  };
+  query?: never;
+  url: '/v1/spaces/{space_id}/experiments/{experiment_id}/results';
+};
+type PushResultsResponses = {
+  /**
+   * Experiment results stored
+   */
+  200: {
+    experiment_result: ExperimentResult;
+  };
+};
+//#endregion
+export { ActivateData, ActivateResponses, CompleteResponses, CompleteWithWinnerResponses, CreateData, CreateExperimentStoryData, CreateExperimentStoryResponses, CreateResponses, CreateStoryMappingData, CreateStoryMappingResponses, DeleteExperimentStoryResponses, DeleteResponses, DeleteStoryMappingResponses, GetResponses, GetResultsResponses, ListData, ListResponses, PauseResponses, PushResultsData, PushResultsResponses, SelectWinnerResponses, UpdateData, UpdateResponses };
+//# sourceMappingURL=types.gen.d.cts.map