@storyblok/management-api-client 0.1.9 → 0.2.0

package/dist/generated/spaces/sdk.gen.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"sdk.gen.mjs","names":["_heyApiClient","args?: {\n        client?: Client;\n    }","options?: Options<ListData, ThrowOnError>","options: Options<CreateData, ThrowOnError>","options: Options<DeleteData, ThrowOnError>","options: Options<GetData, ThrowOnError>","options: Options<UpdateData, ThrowOnError>"],"sources":["../../../src/generated/spaces/sdk.gen.ts"],"sourcesContent":["// This file is auto-generated by @hey-api/openapi-ts\n\nimport type { Options as ClientOptions, TDataShape, Client } from './client';\nimport type { ListData, ListResponses, ListErrors, CreateData, CreateResponses, CreateErrors, DeleteData, DeleteResponses, DeleteErrors, GetData, GetResponses, GetErrors, UpdateData, UpdateResponses, UpdateErrors } from './types.gen';\nimport { client as _heyApiClient } from './client.gen';\n\nexport type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<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\nclass _HeyApiClient {\n    protected _client: Client = _heyApiClient;\n    \n    constructor(args?: {\n        client?: Client;\n    }) {\n        if (args?.client) {\n            this._client = args.client;\n        }\n    }\n}\n\nexport class Sdk extends _HeyApiClient {\n    /**\n     * Retrieve Multiple Spaces\n     * Returns an array of space objects.\n     */\n    public list<ThrowOnError extends boolean = false>(options?: Options<ListData, ThrowOnError>) {\n        return (options?.client ?? this._client).get<ListResponses, ListErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/spaces',\n            ...options\n        });\n    }\n    \n    /**\n     * Create a Space\n     * This endpoint creates a new space. To duplicate an existing space, include the dup_id parameter in the request body.\n     */\n    public create<ThrowOnError extends boolean = false>(options: Options<CreateData, ThrowOnError>) {\n        return (options.client ?? this._client).post<CreateResponses, CreateErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/spaces',\n            ...options,\n            headers: {\n                'Content-Type': 'application/json',\n                ...options.headers\n            }\n        });\n    }\n    \n    /**\n     * Delete a Space\n     * Delete a space by its numeric id.\n     */\n    public delete<ThrowOnError extends boolean = false>(options: Options<DeleteData, ThrowOnError>) {\n        return (options.client ?? this._client).delete<DeleteResponses, DeleteErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/spaces/{space_id}',\n            ...options\n        });\n    }\n    \n    /**\n     * Retrieve a Single Space\n     * Returns a single space object by providing a specific numeric id.\n     */\n    public get<ThrowOnError extends boolean = false>(options: Options<GetData, ThrowOnError>) {\n        return (options.client ?? this._client).get<GetResponses, GetErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/spaces/{space_id}',\n            ...options\n        });\n    }\n    \n    /**\n     * Update a Space\n     * Update a space using the numeric ID. You can only able to update the properties mentioned here.\n     */\n    public update<ThrowOnError extends boolean = false>(options: Options<UpdateData, ThrowOnError>) {\n        return (options.client ?? this._client).put<UpdateResponses, UpdateErrors, ThrowOnError>({\n            security: [\n                {\n                    name: 'Authorization',\n                    type: 'apiKey'\n                },\n                {\n                    scheme: 'bearer',\n                    type: 'http'\n                }\n            ],\n            url: '/v1/spaces/{space_id}',\n            ...options,\n            headers: {\n                'Content-Type': 'application/json',\n                ...options.headers\n            }\n        });\n    }\n}"],"mappings":";;;AAoBA,IAAM,gBAAN,MAAoB;CAChB,AAAU,UAAkBA;CAE5B,YAAYC,MAET;AACC,MAAI,MAAM,QACN,KAAK,UAAU,KAAK;CAE3B;AACJ;AAED,IAAa,MAAb,cAAyB,cAAc;;;;;CAKnC,AAAO,KAA2CC,SAA2C;AACzF,UAAQ,SAAS,UAAU,KAAK,SAAS,IAA6C;GAClF,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;EACN,EAAC;CACL;;;;;CAMD,AAAO,OAA6CC,SAA4C;AAC5F,UAAQ,QAAQ,UAAU,KAAK,SAAS,KAAkD;GACtF,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;GACH,SAAS;IACL,gBAAgB;IAChB,GAAG,QAAQ;GACd;EACJ,EAAC;CACL;;;;;CAMD,AAAO,OAA6CC,SAA4C;AAC5F,UAAQ,QAAQ,UAAU,KAAK,SAAS,OAAoD;GACxF,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;EACN,EAAC;CACL;;;;;CAMD,AAAO,IAA0CC,SAAyC;AACtF,UAAQ,QAAQ,UAAU,KAAK,SAAS,IAA2C;GAC/E,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;EACN,EAAC;CACL;;;;;CAMD,AAAO,OAA6CC,SAA4C;AAC5F,UAAQ,QAAQ,UAAU,KAAK,SAAS,IAAiD;GACrF,UAAU,CACN;IACI,MAAM;IACN,MAAM;GACT,GACD;IACI,QAAQ;IACR,MAAM;GACT,CACJ;GACD,KAAK;GACL,GAAG;GACH,SAAS;IACL,gBAAgB;IAChB,GAAG,QAAQ;GACd;EACJ,EAAC;CACL;AACJ"}

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

@@ -1,698 +0,0 @@
-declare namespace types_gen_d_exports {
-  export { ClientOptions, Collaborator, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetErrors, GetResponse, GetResponses, ListData, ListErrors, ListResponse, ListResponses, Space, SpaceCreateRequest, SpaceId, SpaceUpdateRequest, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses };
-}
-/**
- * The Space Object
- */
-type Space = {
-  /**
-   * Name of the Space
-   */
-  name?: string;
-  /**
-   * Domain for your default preview url
-   */
-  domain?: string;
-  /**
-   * Unique Domain for the Storyblok Rendering Service
-   */
-  uniq_domain?: string;
-  /**
-   * Space Plan
-   */
-  plan?: string;
-  /**
-   * Plan Level of Space
-   */
-  plan_level?: number;
-  /**
-   * Limits of the space
-   */
-  limits?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Creation date
-   */
-  created_at?: string;
-  /**
-   * ID of the space
-   */
-  readonly id: number;
-  /**
-   * Role of the collaborator, could be admin, editor or custom roles
-   */
-  role?: string;
-  /**
-   * Numeric user id of the owner for that space
-   */
-  owner_id?: number;
-  /**
-   * Published Webhook URL
-   */
-  story_published_hook?: string;
-  /**
-   * Array of name, location (url) objects
-   */
-  environments?: Array<{
-    /**
-     * Environment name
-     */
-    name?: string;
-    /**
-     * Environment URL
-     */
-    location?: string;
-  }>;
-  /**
-   * Number of Stories in the Space
-   */
-  stories_count?: number;
-  /**
-   * Space id of a possible parent space
-   */
-  parent_id?: number;
-  /**
-   * Number of Assets in the Space
-   */
-  assets_count?: number;
-  /**
-   * Searchblok id, if available
-   */
-  searchblok_id?: number;
-  /**
-   * Is the space globally duplicatable by all users
-   */
-  duplicatable?: boolean;
-  /**
-   * Request Count of the day
-   */
-  request_count_today?: number;
-  /**
-   * Number of Exceeded Requests
-   */
-  exceeded_requests?: number;
-  /**
-   * Billing information used to generate your invoices for this space
-   */
-  billing_address?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Routes for the Storyblok Rendering Service
-   */
-  routes?: Array<string>;
-  /**
-   * Is the space in trial mode
-   */
-  trial?: boolean;
-  /**
-   * Component name which will be used as default content type for this folders entries
-   */
-  default_root?: string;
-  /**
-   * Does the space have a slack webhook
-   */
-  has_slack_webhook?: boolean;
-  /**
-   * If the space has pending tasks like backup, deployment etc
-   */
-  has_pending_tasks?: boolean;
-  /**
-   * Legacy (no longer in use). Used to enable or disable AI translations.
-   */
-  ai_translation_disabled?: boolean;
-  /**
-   * The oldest available preview token of the space
-   */
-  first_token?: string;
-  /**
-   * Options for backup and language configurations
-   */
-  options?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Array of Collaborators of the Space
-   */
-  collaborator?: Array<Collaborator>;
-  /**
-   * The user Object of the Owner
-   */
-  owner?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Organization object for the space
-   */
-  org?: {
-    /**
-     * Name of the organization
-     */
-    name?: string;
-    /**
-     * Whether AI text generator is disabled in the organization
-     */
-    ai_text_generator_disabled_in_org?: boolean;
-    /**
-     * Custom upload limit in MB for the organization
-     */
-    custom_upload_limit_in_mb?: number;
-  };
-  /**
-   * Whether the space is in an organization
-   */
-  in_org?: boolean;
-  /**
-   * Whether the space is assigned to a partner
-   */
-  assign_partner?: boolean;
-  /**
-   * Array of language objects available in the space
-   */
-  languages?: Array<{
-    /**
-     * Language code (e.g., 'en', 'de', 'fr')
-     */
-    code?: string;
-    /**
-     * Display name of the language
-     */
-    name?: string;
-    /**
-     * AI translation code for the language, can be null
-     */
-    ai_translation_code?: string;
-  }>;
-  /**
-   * Default language code for the space
-   */
-  default_lang_name?: string;
-};
-/**
- * The Collaborator Object
- */
-type Collaborator = {
-  /**
-   * The user object inside a collaborator object
-   */
-  user?: {
-    /**
-     * The user ID
-     */
-    id?: number;
-    /**
-     * First name of collaborator
-     */
-    firstname?: string;
-    /**
-     * Last name of collaborator
-     */
-    lastname?: string;
-    /**
-     * Email of collaborator
-     */
-    alt_email?: string;
-    /**
-     * Avatar of collaborator usually an image
-     */
-    avatar?: string;
-    /**
-     * User ID of collaborator
-     */
-    userid?: string;
-    /**
-     * Friendly name of collaborator
-     */
-    friendly_name?: string;
-  };
-  /**
-   * Role of the collaborator, could be admin, editor or custom roles
-   */
-  role?: string;
-  /**
-   * Numeric ID of the user
-   */
-  user_id?: number;
-  /**
-   * Allow specific actions for collaborator in interface and add the permission as array of strings
-   */
-  permissions?: Array<'read_stories' | 'save_stories' | 'publish_stories' | 'unpublish_stories' | 'publish_folders' | 'unpublish_folders' | 'deploy_stories' | 'delete_stories' | 'edit_image' | 'view_composer' | 'change_alternate_group' | 'move_story' | 'edit_story_slug' | 'view_content' | 'view_folders' | 'view_draft_json' | 'view_published_json' | 'manage_tags' | 'edit_datasources' | 'edit_datasource_keys' | 'access_commerce' | 'manage_block_library' | 'hide_asset_folders'>;
-  /**
-   * Story ids the user should have access to (acts as whitelist). If no item is selected the user has rights to access all content items.
-   */
-  allowed_paths?: Array<number>;
-  /**
-   * Hide specific fields for this user with an array of strings with the schema
-   */
-  field_permissions?: Array<string>;
-  /**
-   * Numeric id of collaborator
-   */
-  id?: number;
-  /**
-   * Numeric ID of the space role
-   */
-  space_role_id?: number;
-  /**
-   * Array of space role ids
-   */
-  space_role_ids?: Array<number>;
-  /**
-   * Numeric id of the collaborator space
-   */
-  space_id?: number;
-};
-/**
- * Request body for creating a space
- */
-type SpaceCreateRequest = {
-  /**
-   * Name of the Space
-   */
-  name: string;
-  /**
-   * Domain for your default preview url
-   */
-  domain?: string;
-  /**
-   * Published Webhook URL
-   */
-  story_published_hook?: string;
-  /**
-   * Array of name, location (url) objects
-   */
-  environments?: Array<{
-    /**
-     * Environment name
-     */
-    name?: string;
-    /**
-     * Environment URL
-     */
-    location?: string;
-  }>;
-  /**
-   * Searchblok id, if available
-   */
-  searchblok_id?: number;
-  /**
-   * Space id of a possible parent space
-   */
-  parent_id?: number;
-  /**
-   * Whether this is a demo space
-   */
-  is_demo?: boolean;
-  /**
-   * Reference to a blueprint
-   */
-  blueprint_reference?: string;
-  /**
-   * Organization object for the space
-   */
-  org?: {
-    /**
-     * Name of the organization
-     */
-    name?: string;
-    /**
-     * Whether AI text generator is disabled in the organization
-     */
-    ai_text_generator_disabled_in_org?: boolean;
-    /**
-     * Custom upload limit in MB for the organization
-     */
-    custom_upload_limit_in_mb?: number;
-  };
-  /**
-   * Whether the space is in an organization
-   */
-  in_org?: boolean;
-  /**
-   * Whether the space is assigned to a partner
-   */
-  assign_partner?: boolean;
-};
-/**
- * Request body for updating a space
- */
-type SpaceUpdateRequest = {
-  /**
-   * Name of the Space
-   */
-  name?: string;
-  /**
-   * Domain for your default preview url
-   */
-  domain?: string;
-  /**
-   * Unique Domain for the Storyblok Rendering Service
-   */
-  uniq_domain?: string;
-  /**
-   * Numeric user id of the owner for that space
-   */
-  owner_id?: number;
-  /**
-   * Published Webhook URL
-   */
-  story_published_hook?: string;
-  /**
-   * Array of name, location (url) objects
-   */
-  environments?: Array<{
-    /**
-     * Environment name
-     */
-    name?: string;
-    /**
-     * Environment URL
-     */
-    location?: string;
-  }>;
-  /**
-   * Space id of a possible parent space
-   */
-  parent_id?: number;
-  /**
-   * Searchblok id, if available
-   */
-  searchblok_id?: number;
-  /**
-   * Is the space globally duplicatable by all users
-   */
-  duplicatable?: boolean;
-  /**
-   * Billing information used to generate your invoices for this space
-   */
-  billing_address?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Routes for the Storyblok Rendering Service
-   */
-  routes?: Array<string>;
-  /**
-   * Component name which will be used as default content type for this folders entries
-   */
-  default_root?: string;
-  /**
-   * Array of language objects
-   */
-  languages?: Array<{
-    /**
-     * Language code
-     */
-    code?: string;
-    /**
-     * Language name
-     */
-    name?: string;
-    /**
-     * AI translation code for the language
-     */
-    ai_translation_code?: string;
-  }>;
-  /**
-   * Crawl configuration
-   */
-  crawl_config?: {
-    /**
-     * Base URL for crawling
-     */
-    base_url?: string;
-    /**
-     * Whether crawling is enabled
-     */
-    enabled?: boolean;
-  };
-  /**
-   * Required asset fields
-   */
-  required_assest_fields?: Array<string>;
-  /**
-   * Custom metadata schema for assets
-   */
-  asset_custom_meta_data_schema?: Array<{
-    /**
-     * Field key
-     */
-    key?: string;
-    /**
-     * Display name for the field
-     */
-    display_name?: string;
-    /**
-     * Regex pattern for validation
-     */
-    regex?: string;
-    /**
-     * Error message for regex validation
-     */
-    regex_message?: string;
-    /**
-     * Whether the field is required
-     */
-    required?: boolean;
-    /**
-     * Whether the field is translatable
-     */
-    translatable?: boolean;
-    /**
-     * Allowed file types
-     */
-    filetypes?: Array<string>;
-  }>;
-  /**
-   * Translatable asset fields
-   */
-  translatable_asset_fields?: Array<string>;
-  /**
-   * Dimensions app folder IDs
-   */
-  dimensions_app_folder_ids?: Array<number>;
-  /**
-   * Disclaimer ID for the space
-   */
-  disclaimer_id?: number;
-};
-/**
- * The ID of the Storyblok space (can be integer or string)
- */
-type SpaceId = number | string;
-type ListData = {
-  body?: never;
-  path?: never;
-  query?: {
-    /**
-     * Search term to filter spaces by name
-     */
-    search?: string;
-  };
-  url: '/v1/spaces';
-};
-type ListErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Forbidden - insufficient permissions
-   */
-  403: unknown;
-};
-type ListResponses = {
-  /**
-   * List of spaces
-   */
-  200: {
-    spaces?: Array<Space>;
-  };
-};
-type ListResponse = ListResponses[keyof ListResponses];
-type CreateData = {
-  body: {
-    space: SpaceCreateRequest;
-    /**
-     * The numeric id of the original space to duplicate. When provided, the new space will be a duplicate of the specified space.
-     */
-    dup_id?: number;
-    /**
-     * Whether to create the space within the user's organization
-     */
-    in_org?: boolean;
-    /**
-     * Type of space for enterprise plans
-     */
-    space_type?: string;
-    /**
-     * Whether to assign a partner to the space
-     */
-    assign_partner?: boolean;
-  };
-  path?: never;
-  query?: never;
-  url: '/v1/spaces';
-};
-type CreateErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Forbidden - insufficient permissions
-   */
-  403: unknown;
-  /**
-   * Unprocessable entity - validation errors
-   */
-  422: unknown;
-};
-type CreateResponses = {
-  /**
-   * Space created
-   */
-  201: {
-    space?: Space;
-  };
-};
-type CreateResponse = CreateResponses[keyof CreateResponses];
-type DeleteData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}';
-};
-type DeleteErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Forbidden - insufficient permissions
-   */
-  403: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-  /**
-   * Unprocessable entity - validation errors
-   */
-  422: unknown;
-};
-type DeleteResponses = {
-  /**
-   * Space deleted
-   */
-  200: {
-    space?: Space;
-  };
-};
-type DeleteResponse = DeleteResponses[keyof DeleteResponses];
-type GetData = {
-  body?: never;
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}';
-};
-type GetErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Forbidden - insufficient permissions
-   */
-  403: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-};
-type GetResponses = {
-  /**
-   * Space details
-   */
-  200: {
-    space?: Space;
-  };
-};
-type GetResponse = GetResponses[keyof GetResponses];
-type UpdateData = {
-  body: {
-    space: SpaceUpdateRequest;
-  };
-  path: {
-    /**
-     * The ID of the Storyblok space (can be integer or string)
-     */
-    space_id: number | string;
-  };
-  query?: never;
-  url: '/v1/spaces/{space_id}';
-};
-type UpdateErrors = {
-  /**
-   * Bad request
-   */
-  400: unknown;
-  /**
-   * Unauthorized
-   */
-  401: unknown;
-  /**
-   * Forbidden - insufficient permissions
-   */
-  403: unknown;
-  /**
-   * Space not found
-   */
-  404: unknown;
-  /**
-   * Unprocessable entity - validation errors
-   */
-  422: unknown;
-};
-type UpdateResponses = {
-  /**
-   * Space updated
-   */
-  200: {
-    space?: Space;
-  };
-};
-type UpdateResponse = UpdateResponses[keyof UpdateResponses];
-type ClientOptions = {
-  baseUrl: 'https://mapi.storyblok.com' | 'https://api-us.storyblok.com' | 'https://api-ca.storyblok.com' | 'https://api-ap.storyblok.com' | 'https://app.storyblok.cn' | (string & {});
-};
-//#endregion
-export { ClientOptions, Collaborator, CreateData, CreateErrors, CreateResponse, CreateResponses, DeleteData, DeleteErrors, DeleteResponse, DeleteResponses, GetData, GetErrors, GetResponse, GetResponses, ListData, ListErrors, ListResponse, ListResponses, Space, SpaceCreateRequest, SpaceId, SpaceUpdateRequest, UpdateData, UpdateErrors, UpdateResponse, UpdateResponses, types_gen_d_exports };
-//# sourceMappingURL=types.gen.d.mts.map

package/dist/generated/spaces/types.gen.mjs

@@ -1,6 +0,0 @@
-//#region src/generated/spaces/types.gen.ts
-var types_gen_exports = {};
-
-//#endregion
-export { types_gen_exports };
-//# sourceMappingURL=types.gen.mjs.map