/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateDirectoryRequest, CreateDirectoryResponse, DirectoriesServiceUpdateBody, GetDirectoryResponse, ListDirectoriesResponse, UpdateDirectoryResponse } from '../models/index'; export interface DirectoriesServiceCreateRequest { createDirectoryRequest: CreateDirectoryRequest; } export interface DirectoriesServiceDeleteRequest { id: string; } export interface DirectoriesServiceGetRequest { id: string; } export interface DirectoriesServiceListRequest { pageSize: number; pageToken?: string; parentDirectoryId?: string; search?: string; includeRoot?: boolean; recursive?: boolean; } export interface DirectoriesServiceUpdateRequest { id: string; directoriesServiceUpdateBody: DirectoriesServiceUpdateBody; } /** * DirectoriesApi - interface * * @export * @interface DirectoriesApiInterface */ export interface DirectoriesApiInterface { /** * Creates request options for directoriesServiceCreate without sending the request * @param {CreateDirectoryRequest} createDirectoryRequest * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceCreateRequestOpts(requestParameters: DirectoriesServiceCreateRequest): Promise; /** * Create a new directory in the workspace. Optionally nest it under an existing directory. * @summary Create a directory * @param {CreateDirectoryRequest} createDirectoryRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceCreateRaw(requestParameters: DirectoriesServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new directory in the workspace. Optionally nest it under an existing directory. * Create a directory */ directoriesServiceCreate(requestParameters: DirectoriesServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceDelete without sending the request * @param {string} id The ID of the directory to delete. The directory must be empty before deletion; if it still contains links or child directories, the request fails. * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceDeleteRequestOpts(requestParameters: DirectoriesServiceDeleteRequest): Promise; /** * Remove a directory from the workspace. This operation cannot be undone. A directory cannot be deleted while it still contains links or child directories; move or remove them first. * @summary Delete a directory * @param {string} id The ID of the directory to delete. The directory must be empty before deletion; if it still contains links or child directories, the request fails. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceDeleteRaw(requestParameters: DirectoriesServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Remove a directory from the workspace. This operation cannot be undone. A directory cannot be deleted while it still contains links or child directories; move or remove them first. * Delete a directory */ directoriesServiceDelete(requestParameters: DirectoriesServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceGet without sending the request * @param {string} id The ID of the directory to retrieve (UUID) * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceGetRequestOpts(requestParameters: DirectoriesServiceGetRequest): Promise; /** * Retrieve a directory by its unique identifier. * @summary Get a directory * @param {string} id The ID of the directory to retrieve (UUID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceGetRaw(requestParameters: DirectoriesServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a directory by its unique identifier. * Get a directory */ directoriesServiceGet(requestParameters: DirectoriesServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceList without sending the request * @param {number} pageSize The maximum number of directories to return * @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned * @param {string} [parentDirectoryId] Filter directories by parent. When empty, returns root-level directories. * @param {string} [search] Search query to filter directories by name Search query to filter directories by name * @param {boolean} [includeRoot] When listing with parent_directory_id, also include root-level directories if true When listing with parent_directory_id, also include root-level directories. * @param {boolean} [recursive] When true, returns all directories recursively regardless of parent filter Useful for getting a complete flat list of all directories in the workspace (e.g., for directory pickers) When false (default), returns only immediate children based on parent_directory_id Return all directories recursively. When true with empty parent_directory_id, returns all directories in workspace. When true with parent_directory_id set, returns all descendants of that directory. * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceListRequestOpts(requestParameters: DirectoriesServiceListRequest): Promise; /** * List directories in the workspace with optional filtering by parent directory, search, and pagination. * @summary List directories * @param {number} pageSize The maximum number of directories to return * @param {string} [pageToken] The token for retrieving the next page of results If not provided, the first page of results will be returned * @param {string} [parentDirectoryId] Filter directories by parent. When empty, returns root-level directories. * @param {string} [search] Search query to filter directories by name Search query to filter directories by name * @param {boolean} [includeRoot] When listing with parent_directory_id, also include root-level directories if true When listing with parent_directory_id, also include root-level directories. * @param {boolean} [recursive] When true, returns all directories recursively regardless of parent filter Useful for getting a complete flat list of all directories in the workspace (e.g., for directory pickers) When false (default), returns only immediate children based on parent_directory_id Return all directories recursively. When true with empty parent_directory_id, returns all directories in workspace. When true with parent_directory_id set, returns all descendants of that directory. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceListRaw(requestParameters: DirectoriesServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List directories in the workspace with optional filtering by parent directory, search, and pagination. * List directories */ directoriesServiceList(requestParameters: DirectoriesServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceUpdate without sending the request * @param {string} id The ID of the directory to update (UUID) * @param {DirectoriesServiceUpdateBody} directoriesServiceUpdateBody * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceUpdateRequestOpts(requestParameters: DirectoriesServiceUpdateRequest): Promise; /** * Update a directory\'s name or move it under a different parent directory. * @summary Update a directory * @param {string} id The ID of the directory to update (UUID) * @param {DirectoriesServiceUpdateBody} directoriesServiceUpdateBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DirectoriesApiInterface */ directoriesServiceUpdateRaw(requestParameters: DirectoriesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a directory\'s name or move it under a different parent directory. * Update a directory */ directoriesServiceUpdate(requestParameters: DirectoriesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class DirectoriesApi extends runtime.BaseAPI implements DirectoriesApiInterface { /** * Creates request options for directoriesServiceCreate without sending the request */ directoriesServiceCreateRequestOpts(requestParameters: DirectoriesServiceCreateRequest): Promise; /** * Create a new directory in the workspace. Optionally nest it under an existing directory. * Create a directory */ directoriesServiceCreateRaw(requestParameters: DirectoriesServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new directory in the workspace. Optionally nest it under an existing directory. * Create a directory */ directoriesServiceCreate(requestParameters: DirectoriesServiceCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceDelete without sending the request */ directoriesServiceDeleteRequestOpts(requestParameters: DirectoriesServiceDeleteRequest): Promise; /** * Remove a directory from the workspace. This operation cannot be undone. A directory cannot be deleted while it still contains links or child directories; move or remove them first. * Delete a directory */ directoriesServiceDeleteRaw(requestParameters: DirectoriesServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Remove a directory from the workspace. This operation cannot be undone. A directory cannot be deleted while it still contains links or child directories; move or remove them first. * Delete a directory */ directoriesServiceDelete(requestParameters: DirectoriesServiceDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceGet without sending the request */ directoriesServiceGetRequestOpts(requestParameters: DirectoriesServiceGetRequest): Promise; /** * Retrieve a directory by its unique identifier. * Get a directory */ directoriesServiceGetRaw(requestParameters: DirectoriesServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve a directory by its unique identifier. * Get a directory */ directoriesServiceGet(requestParameters: DirectoriesServiceGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceList without sending the request */ directoriesServiceListRequestOpts(requestParameters: DirectoriesServiceListRequest): Promise; /** * List directories in the workspace with optional filtering by parent directory, search, and pagination. * List directories */ directoriesServiceListRaw(requestParameters: DirectoriesServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List directories in the workspace with optional filtering by parent directory, search, and pagination. * List directories */ directoriesServiceList(requestParameters: DirectoriesServiceListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for directoriesServiceUpdate without sending the request */ directoriesServiceUpdateRequestOpts(requestParameters: DirectoriesServiceUpdateRequest): Promise; /** * Update a directory\'s name or move it under a different parent directory. * Update a directory */ directoriesServiceUpdateRaw(requestParameters: DirectoriesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a directory\'s name or move it under a different parent directory. * Update a directory */ directoriesServiceUpdate(requestParameters: DirectoriesServiceUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }