Function LibraryStructureApiAxiosParamCreator

LibraryStructureApi - axios parameter creator

Export

  • LibraryStructureApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        addMediaPath: (
            mediaPathDto: MediaPathDto,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        addVirtualFolder: (
            name?: string,
            collectionType?: CollectionTypeOptions,
            paths?: string[],
            refreshLibrary?: boolean,
            addVirtualFolderDto?: AddVirtualFolderDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getVirtualFolders: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        removeMediaPath: (
            name?: string,
            path?: string,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        removeVirtualFolder: (
            name?: string,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        renameVirtualFolder: (
            name?: string,
            newName?: string,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateLibraryOptions: (
            updateLibraryOptionsDto?: UpdateLibraryOptionsDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateMediaPath: (
            updateMediaPathRequestDto: UpdateMediaPathRequestDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    Returns {
        addMediaPath: (
            mediaPathDto: MediaPathDto,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        addVirtualFolder: (
            name?: string,
            collectionType?: CollectionTypeOptions,
            paths?: string[],
            refreshLibrary?: boolean,
            addVirtualFolderDto?: AddVirtualFolderDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getVirtualFolders: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        removeMediaPath: (
            name?: string,
            path?: string,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        removeVirtualFolder: (
            name?: string,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        renameVirtualFolder: (
            name?: string,
            newName?: string,
            refreshLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateLibraryOptions: (
            updateLibraryOptionsDto?: UpdateLibraryOptionsDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        updateMediaPath: (
            updateMediaPathRequestDto: UpdateMediaPathRequestDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • addMediaPath: (
          mediaPathDto: MediaPathDto,
          refreshLibrary?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • addVirtualFolder: (
          name?: string,
          collectionType?: CollectionTypeOptions,
          paths?: string[],
          refreshLibrary?: boolean,
          addVirtualFolderDto?: AddVirtualFolderDto,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • getVirtualFolders: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

    • removeMediaPath: (
          name?: string,
          path?: string,
          refreshLibrary?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • removeVirtualFolder: (
          name?: string,
          refreshLibrary?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • renameVirtualFolder: (
          name?: string,
          newName?: string,
          refreshLibrary?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • updateLibraryOptions: (
          updateLibraryOptionsDto?: UpdateLibraryOptionsDto,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • updateMediaPath: (
          updateMediaPathRequestDto: UpdateMediaPathRequestDto,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

Settings

Member Visibility