/** * kameleo-local-api * You can use the following API endpoints to communicate with the local running Kameleo programmatically. * * The version of the OpenAPI document: 4.4.0 * * * 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 { AddProfileToFolderRequest, CreateFolderRequest, DeleteFolderResponse, FolderResponse, ListFoldersResponse, ProfileResponse, ShareGroupRequest, SharingOptionsResponse, UpdateFolderRequest } from "../models/index"; export interface AddProfileToFolderOperationRequest { guid: string; addProfileToFolderRequest?: AddProfileToFolderRequest; } export interface CreateFolderOperationRequest { createFolderRequest?: CreateFolderRequest; } export interface DeleteFolderRequest { guid: string; includeProfiles?: boolean; } export interface ReadFolderRequest { guid: string; } export interface RemoveProfileFromFolderRequest { guid: string; profileId: string; } export interface ShareGroupOperationRequest { guid: string; shareGroupRequest?: ShareGroupRequest; } export interface UpdateFolderOperationRequest { guid: string; updateFolderRequest?: UpdateFolderRequest; } /** * */ export declare class FolderApi extends runtime.BaseAPI { /** * Adds the given profile to the specified folder. */ addProfileToFolderRaw(requestParameters: AddProfileToFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Adds the given profile to the specified folder. */ addProfileToFolder(guid: string, addProfileToFolderRequest?: AddProfileToFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create a new folder in your workspace by providing a human-readable name in the request body. Use this to organize your profiles effectively. */ createFolderRaw(requestParameters: CreateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new folder in your workspace by providing a human-readable name in the request body. Use this to organize your profiles effectively. */ createFolder(createFolderRequest?: CreateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Deletes a folder along with all its subfolders. Profiles within the folder will either be deleted or moved to the top-level based on the query parameters. */ deleteFolderRaw(requestParameters: DeleteFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Deletes a folder along with all its subfolders. Profiles within the folder will either be deleted or moved to the top-level based on the query parameters. */ deleteFolder(guid: string, includeProfiles?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve the complete list of folders in your workspace. Use this endpoint to see the entire folder hierarchy - including subfolders and unassigned profiles. */ listFoldersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the complete list of folders in your workspace. Use this endpoint to see the entire folder hierarchy - including subfolders and unassigned profiles. */ listFolders(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Fetch detailed information for a specific folder by its unique GUID. Use this to review the folder’s metadata, contained profiles, and sharing settings. */ readFolderRaw(requestParameters: ReadFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Fetch detailed information for a specific folder by its unique GUID. Use this to review the folder’s metadata, contained profiles, and sharing settings. */ readFolder(guid: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve the sharing options available for folders. Use this endpoint to review the list of users and roles that can access your folder resources. */ readSharingOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the sharing options available for folders. Use this endpoint to review the list of users and roles that can access your folder resources. */ readSharingOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Removes the given profile from the specified folder. */ removeProfileFromFolderRaw(requestParameters: RemoveProfileFromFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Removes the given profile from the specified folder. */ removeProfileFromFolder(guid: string, profileId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update the sharing settings for a folder by submitting a list of share access rules (user and role details) in the request body. Use this to adjust access permissions as needed. */ shareGroupRaw(requestParameters: ShareGroupOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update the sharing settings for a folder by submitting a list of share access rules (user and role details) in the request body. Use this to adjust access permissions as needed. */ shareGroup(guid: string, shareGroupRequest?: ShareGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates the details of an existing folder, not including its content. */ updateFolderRaw(requestParameters: UpdateFolderOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates the details of an existing folder, not including its content. */ updateFolder(guid: string, updateFolderRequest?: UpdateFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }