@storyblok/api-client 1.0.0-alpha.1 → 1.0.0-alpha.2

package/dist/generated/capi/types-aliased.gen.d.cts

@@ -0,0 +1,181 @@
+//#region src/generated/capi/types-aliased.gen.d.ts
+type Datasource = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The unique slug of the datasource.
+   */
+  slug: string;
+  /**
+   * Dimensions of the datasource.
+   */
+  dimensions: Array<Dimension>;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type DatasourceEntry = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * Given value in default dimension.
+   */
+  value: string;
+  /**
+   * Given value in the requested dimension.
+   */
+  dimension_value: string | null;
+};
+type Link = {
+  /**
+   * ID.
+   */
+  id: number;
+  uuid: string;
+  /**
+   * The full slug of the story or folder.
+   */
+  slug: string;
+  /**
+   * Real path defined in the story's entry configuration.
+   */
+  path?: string | null;
+  /**
+   * Either the full slug of the story or folder with a leading /, or, if existent, the value of the real path defined in the story's entry configuration with a leading /.
+   */
+  real_path?: string | null;
+  /**
+   * The complete name of the story or folder.
+   */
+  name: string;
+  /**
+   * true if a story is currently published, even if it has unpublished changes.
+   */
+  published: boolean;
+  /**
+   * ID of the parent folder.
+   */
+  parent_id: number;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * true if the story is defined as root for the folder.
+   */
+  is_startpage: boolean;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position: number;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at?: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string | null;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Alternate language variants.
+   */
+  alternates?: Array<Alternate>;
+};
+type Tag = {
+  /**
+   * The name of the tag.
+   */
+  name: string;
+  /**
+   * The minimum value of `taggings_count` is 1, not 0.
+   * - The number of tags with this name that exist in the space, or
+   * - The number of draft or published stories with this tag, or
+   * - The number of deleted stories with this tag.
+   */
+  taggings_count?: number;
+  /**
+   * Only visible when passing the `all_tags` parameter. The number of stories currently associated with the tag, corresponding to the <strong>Assigned items</strong> column in the <a href='https://www.storyblok.com/docs/manuals/stories#tags'>Tags tab</a>.
+   */
+  tag_on_stories?: number;
+};
+type StoryAlternate = {
+  id: number;
+  name: string;
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  is_folder: boolean;
+  parent_id: number;
+};
+type Dimension = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The value provided for the datasource dimension.
+   */
+  entry_value: string;
+  /**
+   * The numeric ID of the datasource that the dimension belongs to.
+   */
+  datasource_id?: number;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type Alternate = {
+  /**
+   * Translated slug (or parent slug if not installed).
+   */
+  path: string;
+  /**
+   * Translated name of the story or folder.
+   */
+  name: string;
+  /**
+   * Language code of this story variant.
+   */
+  lang: string;
+  /**
+   * True if this variant is published.
+   */
+  published: boolean;
+  /**
+   * Translated slug of the story.
+   */
+  translated_slug: string;
+};
+//#endregion
+export { Datasource, DatasourceEntry, Link, StoryAlternate, Tag };
+//# sourceMappingURL=types-aliased.gen.d.cts.map

package/dist/generated/capi/types-aliased.gen.d.mts

@@ -0,0 +1,181 @@
+//#region src/generated/capi/types-aliased.gen.d.ts
+type Datasource = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The unique slug of the datasource.
+   */
+  slug: string;
+  /**
+   * Dimensions of the datasource.
+   */
+  dimensions: Array<Dimension>;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type DatasourceEntry = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * Given value in default dimension.
+   */
+  value: string;
+  /**
+   * Given value in the requested dimension.
+   */
+  dimension_value: string | null;
+};
+type Link = {
+  /**
+   * ID.
+   */
+  id: number;
+  uuid: string;
+  /**
+   * The full slug of the story or folder.
+   */
+  slug: string;
+  /**
+   * Real path defined in the story's entry configuration.
+   */
+  path?: string | null;
+  /**
+   * Either the full slug of the story or folder with a leading /, or, if existent, the value of the real path defined in the story's entry configuration with a leading /.
+   */
+  real_path?: string | null;
+  /**
+   * The complete name of the story or folder.
+   */
+  name: string;
+  /**
+   * true if a story is currently published, even if it has unpublished changes.
+   */
+  published: boolean;
+  /**
+   * ID of the parent folder.
+   */
+  parent_id: number;
+  /**
+   * true if the instance constitutes a folder.
+   */
+  is_folder: boolean;
+  /**
+   * true if the story is defined as root for the folder.
+   */
+  is_startpage: boolean;
+  /**
+   * Numeric representation of the story's position in the folder.
+   */
+  position: number;
+  /**
+   * Latest publication timestamp (format is ISO 8601 standard in UTC).
+   */
+  published_at?: string | null;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string | null;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string | null;
+  /**
+   * Alternate language variants.
+   */
+  alternates?: Array<Alternate>;
+};
+type Tag = {
+  /**
+   * The name of the tag.
+   */
+  name: string;
+  /**
+   * The minimum value of `taggings_count` is 1, not 0.
+   * - The number of tags with this name that exist in the space, or
+   * - The number of draft or published stories with this tag, or
+   * - The number of deleted stories with this tag.
+   */
+  taggings_count?: number;
+  /**
+   * Only visible when passing the `all_tags` parameter. The number of stories currently associated with the tag, corresponding to the <strong>Assigned items</strong> column in the <a href='https://www.storyblok.com/docs/manuals/stories#tags'>Tags tab</a>.
+   */
+  tag_on_stories?: number;
+};
+type StoryAlternate = {
+  id: number;
+  name: string;
+  slug: string;
+  published: boolean | null;
+  full_slug: string;
+  is_folder: boolean;
+  parent_id: number;
+};
+type Dimension = {
+  /**
+   * ID.
+   */
+  id: number;
+  /**
+   * Name.
+   */
+  name: string;
+  /**
+   * The value provided for the datasource dimension.
+   */
+  entry_value: string;
+  /**
+   * The numeric ID of the datasource that the dimension belongs to.
+   */
+  datasource_id?: number;
+  /**
+   * Creation timestamp (format is ISO 8601 standard in UTC).
+   */
+  created_at?: string;
+  /**
+   * Latest update timestamp (format is ISO 8601 standard in UTC).
+   */
+  updated_at?: string;
+};
+type Alternate = {
+  /**
+   * Translated slug (or parent slug if not installed).
+   */
+  path: string;
+  /**
+   * Translated name of the story or folder.
+   */
+  name: string;
+  /**
+   * Language code of this story variant.
+   */
+  lang: string;
+  /**
+   * True if this variant is published.
+   */
+  published: boolean;
+  /**
+   * Translated slug of the story.
+   */
+  translated_slug: string;
+};
+//#endregion
+export { Datasource, DatasourceEntry, Link, StoryAlternate, Tag };
+//# sourceMappingURL=types-aliased.gen.d.mts.map