@storyblok/management-api-client 0.5.0 → 0.6.0

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

@@ -1,522 +0,0 @@
-//#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.mts.map

package/dist/generated/internal_tags/client.gen.cjs

@@ -1,10 +0,0 @@
-const require_utils_gen = require('../shared/client/utils.gen.cjs');
-const require_client_gen = require('../shared/client/client.gen.cjs');
-require('../shared/client/index.cjs');
-
-//#region src/generated/internal_tags/client.gen.ts
-const client = require_client_gen.createClient(require_utils_gen.createConfig({ baseUrl: "https://mapi.storyblok.com" }));
-
-//#endregion
-exports.client = client;
-//# sourceMappingURL=client.gen.cjs.map

package/dist/generated/internal_tags/client.gen.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.gen.cjs","names":["createClient","createConfig"],"sources":["../../../src/generated/internal_tags/client.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport { type ClientOptions, type Config, createClient, createConfig } from '../shared/client';\nimport type { ClientOptions as ClientOptions2 } from './types.gen';\n\n/**\n * The `createClientConfig()` function will be called on client initialization\n * and the returned object will become the client's initial configuration.\n *\n * You may want to initialize your client this way instead of calling\n * `setConfig()`. This is useful for example if you're using Next.js\n * to ensure your client always has the correct values.\n */\nexport type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;\n\nexport const client = createClient(createConfig<ClientOptions2>({ baseUrl: 'https://mapi.storyblok.com' }));\n"],"mappings":";;;;;AAeA,MAAa,SAASA,gCAAaC,+BAA6B,EAAE,SAAS,8BAA8B,CAAC,CAAC"}

package/dist/generated/internal_tags/client.gen.mjs

@@ -1,10 +0,0 @@
-import { createConfig } from "../shared/client/utils.gen.mjs";
-import { createClient } from "../shared/client/client.gen.mjs";
-import "../shared/client/index.mjs";
-
-//#region src/generated/internal_tags/client.gen.ts
-const client = createClient(createConfig({ baseUrl: "https://mapi.storyblok.com" }));
-
-//#endregion
-export { client };
-//# sourceMappingURL=client.gen.mjs.map

package/dist/generated/internal_tags/client.gen.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.gen.mjs","names":[],"sources":["../../../src/generated/internal_tags/client.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport { type ClientOptions, type Config, createClient, createConfig } from '../shared/client';\nimport type { ClientOptions as ClientOptions2 } from './types.gen';\n\n/**\n * The `createClientConfig()` function will be called on client initialization\n * and the returned object will become the client's initial configuration.\n *\n * You may want to initialize your client this way instead of calling\n * `setConfig()`. This is useful for example if you're using Next.js\n * to ensure your client always has the correct values.\n */\nexport type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;\n\nexport const client = createClient(createConfig<ClientOptions2>({ baseUrl: 'https://mapi.storyblok.com' }));\n"],"mappings":";;;;;AAeA,MAAa,SAAS,aAAa,aAA6B,EAAE,SAAS,8BAA8B,CAAC,CAAC"}

package/dist/generated/internal_tags/sdk.gen.cjs

@@ -1,74 +0,0 @@
-const require_client_gen = require('./client.gen.cjs');
-
-//#region src/generated/internal_tags/sdk.gen.ts
-/**
-* Retrieve Multiple Internal Tags
-*/
-const list = (options) => (options.client ?? require_client_gen.client).get({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags",
-	...options
-});
-/**
-* Create an Internal Tag
-*/
-const create = (options) => (options.client ?? require_client_gen.client).post({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags",
-	...options,
-	headers: {
-		"Content-Type": "application/json",
-		...options.headers
-	}
-});
-/**
-* Delete an Internal Tag
-*/
-const delete_ = (options) => (options.client ?? require_client_gen.client).delete({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags/{internal_tag_id}",
-	...options
-});
-/**
-* Update an Internal Tag
-*/
-const update = (options) => (options.client ?? require_client_gen.client).put({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags/{internal_tag_id}",
-	...options,
-	headers: {
-		"Content-Type": "application/json",
-		...options.headers
-	}
-});
-
-//#endregion
-exports.create = create;
-exports.delete_ = delete_;
-exports.list = list;
-exports.update = update;
-//# sourceMappingURL=sdk.gen.cjs.map

package/dist/generated/internal_tags/sdk.gen.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sdk.gen.cjs","names":["client"],"sources":["../../../src/generated/internal_tags/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Client, Options as Options2, TDataShape } from '../shared/client';\nimport { client } from './client.gen';\nimport type { CreateData, CreateErrors, CreateResponses, DeleteData, DeleteErrors, DeleteResponses, ListData, ListErrors, ListResponses, UpdateData, UpdateErrors, UpdateResponses } from './types.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {\n    /**\n     * You can provide a client instance returned by `createClient()` instead of\n     * individual options. This might be also useful if you want to implement a\n     * custom client.\n     */\n    client?: Client;\n    /**\n     * You can pass arbitrary values through the `meta` object. This can be\n     * used to access values that aren't defined as part of the SDK function.\n     */\n    meta?: Record<string, unknown>;\n};\n\n/**\n * Retrieve Multiple Internal Tags\n */\nexport const list = <ThrowOnError extends boolean = false>(options: Options<ListData, ThrowOnError>) => (options.client ?? client).get<ListResponses, ListErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/internal_tags',\n    ...options\n});\n\n/**\n * Create an Internal Tag\n */\nexport const create = <ThrowOnError extends boolean = false>(options: Options<CreateData, ThrowOnError>) => (options.client ?? client).post<CreateResponses, CreateErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/internal_tags',\n    ...options,\n    headers: {\n        'Content-Type': 'application/json',\n        ...options.headers\n    }\n});\n\n/**\n * Delete an Internal Tag\n */\nexport const delete_ = <ThrowOnError extends boolean = false>(options: Options<DeleteData, ThrowOnError>) => (options.client ?? client).delete<DeleteResponses, DeleteErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/internal_tags/{internal_tag_id}',\n    ...options\n});\n\n/**\n * Update an Internal Tag\n */\nexport const update = <ThrowOnError extends boolean = false>(options: Options<UpdateData, ThrowOnError>) => (options.client ?? client).put<UpdateResponses, UpdateErrors, ThrowOnError>({\n    security: [{ name: 'Authorization', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],\n    url: '/v1/spaces/{space_id}/internal_tags/{internal_tag_id}',\n    ...options,\n    headers: {\n        'Content-Type': 'application/json',\n        ...options.headers\n    }\n});\n"],"mappings":";;;;;;AAuBA,MAAa,QAA8C,aAA8C,QAAQ,UAAUA,2BAAQ,IAA6C;CAC5K,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;AAKF,MAAa,UAAgD,aAAgD,QAAQ,UAAUA,2BAAQ,KAAkD;CACrL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC;;;;AAKF,MAAa,WAAiD,aAAgD,QAAQ,UAAUA,2BAAQ,OAAoD;CACxL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACN,CAAC;;;;AAKF,MAAa,UAAgD,aAAgD,QAAQ,UAAUA,2BAAQ,IAAiD;CACpL,UAAU,CAAC;EAAE,MAAM;EAAiB,MAAM;EAAU,EAAE;EAAE,QAAQ;EAAU,MAAM;EAAQ,CAAC;CACzF,KAAK;CACL,GAAG;CACH,SAAS;EACL,gBAAgB;EAChB,GAAG,QAAQ;EACd;CACJ,CAAC"}

package/dist/generated/internal_tags/sdk.gen.mjs

@@ -1,71 +0,0 @@
-import { client } from "./client.gen.mjs";
-
-//#region src/generated/internal_tags/sdk.gen.ts
-/**
-* Retrieve Multiple Internal Tags
-*/
-const list = (options) => (options.client ?? client).get({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags",
-	...options
-});
-/**
-* Create an Internal Tag
-*/
-const create = (options) => (options.client ?? client).post({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags",
-	...options,
-	headers: {
-		"Content-Type": "application/json",
-		...options.headers
-	}
-});
-/**
-* Delete an Internal Tag
-*/
-const delete_ = (options) => (options.client ?? client).delete({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags/{internal_tag_id}",
-	...options
-});
-/**
-* Update an Internal Tag
-*/
-const update = (options) => (options.client ?? client).put({
-	security: [{
-		name: "Authorization",
-		type: "apiKey"
-	}, {
-		scheme: "bearer",
-		type: "http"
-	}],
-	url: "/v1/spaces/{space_id}/internal_tags/{internal_tag_id}",
-	...options,
-	headers: {
-		"Content-Type": "application/json",
-		...options.headers
-	}
-});
-
-//#endregion
-export { create, delete_, list, update };
-//# sourceMappingURL=sdk.gen.mjs.map