/** * OpenAPI definition * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosInstance, AxiosPromise, AxiosRequestConfig } from 'axios'; import { BaseAPI, RequestArgs } from './base'; import { Configuration } from './configuration'; /** * * @export * @interface CabinetResultManyCard */ export interface CabinetResultManyCard { /** * * @type {Array} * @memberof CabinetResultManyCard */ 'queries'?: Array; /** * * @type {Array} * @memberof CabinetResultManyCard */ 'markdown'?: Array; /** * * @type {Array} * @memberof CabinetResultManyCard */ 'items'?: Array; /** * * @type {number} * @memberof CabinetResultManyCard */ 'totalResults'?: number; /** * * @type {number} * @memberof CabinetResultManyCard */ 'page'?: number; /** * * @type {number} * @memberof CabinetResultManyCard */ 'pageSize'?: number; /** * * @type {number} * @memberof CabinetResultManyCard */ 'totalPages'?: number; /** * * @type {boolean} * @memberof CabinetResultManyCard */ 'hasNextPage'?: boolean; /** * * @type {boolean} * @memberof CabinetResultManyCard */ 'hasPrevPage'?: boolean; /** * * @type {boolean} * @memberof CabinetResultManyCard */ 'isFirst'?: boolean; /** * * @type {boolean} * @memberof CabinetResultManyCard */ 'isLast'?: boolean; /** * * @type {boolean} * @memberof CabinetResultManyCard */ 'isEmpty'?: boolean; /** * * @type {string} * @memberof CabinetResultManyCard */ 'selectorType'?: CabinetResultManyCardSelectorTypeEnum; } /** * @export * @enum {string} */ export declare enum CabinetResultManyCardSelectorTypeEnum { None = "NONE", Citekey = "CITEKEY", Cardid = "CARDID", Filepath = "FILEPATH" } /** * * @export * @interface CabinetResultOneCard */ export interface CabinetResultOneCard { /** * * @type {Card} * @memberof CabinetResultOneCard */ 'item'?: Card; } /** * * @export * @interface Card */ export interface Card { /** * * @type {string} * @memberof Card */ 'id'?: string; /** * * @type {string} * @memberof Card */ 'extra'?: string; /** * * @type {string} * @memberof Card */ 'modified'?: string; /** * * @type {string} * @memberof Card */ 'created'?: string; /** * * @type {string} * @memberof Card */ 'text'?: string; /** * * @type {string} * @memberof Card */ 'title'?: string; /** * * @type {number} * @memberof Card */ 'importance'?: number; /** * * @type {Set} * @memberof Card */ 'tags'?: Set; /** * * @type {Set} * @memberof Card */ 'comments'?: Set; /** * * @type {Source} * @memberof Card */ 'source'?: Source; } /** * * @export * @interface Comment */ export interface Comment { /** * * @type {string} * @memberof Comment */ 'id'?: string; /** * * @type {string} * @memberof Comment */ 'extra'?: string; /** * * @type {string} * @memberof Comment */ 'text'?: string; /** * * @type {Set} * @memberof Comment */ 'cards'?: Set; } /** * * @export * @interface ExtractPdfPagesRequest */ export interface ExtractPdfPagesRequest { /** * * @type {string} * @memberof ExtractPdfPagesRequest */ 'filePath'?: string; /** * * @type {Array} * @memberof ExtractPdfPagesRequest */ 'pageIndices'?: Array; /** * * @type {boolean} * @memberof ExtractPdfPagesRequest */ 'storeAllPages'?: boolean; } /** * * @export * @interface ExtractPdfRequest */ export interface ExtractPdfRequest { /** * * @type {Array} * @memberof ExtractPdfRequest */ 'filePaths'?: Array; } /** * * @export * @interface ExtractPdfRequestOne */ export interface ExtractPdfRequestOne { /** * * @type {string} * @memberof ExtractPdfRequestOne */ 'filePath'?: string; } /** * * @export * @interface ExtractResult */ export interface ExtractResult { /** * * @type {Array} * @memberof ExtractResult */ 'extractedPdf'?: Array; /** * * @type {string} * @memberof ExtractResult */ 'outputPath'?: string; /** * * @type {string} * @memberof ExtractResult */ 'outputType'?: string; } /** * * @export * @interface GetCardsById */ export interface GetCardsById { /** * * @type {Array} * @memberof GetCardsById */ 'cardIds'?: Array; } /** * * @export * @interface GetCardsByIdentifiers */ export interface GetCardsByIdentifiers { /** * * @type {Array} * @memberof GetCardsByIdentifiers */ 'filePaths'?: Array; /** * * @type {Array} * @memberof GetCardsByIdentifiers */ 'citeKeys'?: Array; /** * * @type {Array} * @memberof GetCardsByIdentifiers */ 'cardIds'?: Array; } /** * * @export * @interface ParseRequest */ export interface ParseRequest { /** * * @type {string} * @memberof ParseRequest */ 'text': string; /** * * @type {boolean} * @memberof ParseRequest */ 'replace'?: boolean; } /** * * @export * @interface ParseResult */ export interface ParseResult { /** * * @type {string} * @memberof ParseResult */ 'processedText'?: string; /** * * @type {Array} * @memberof ParseResult */ 'tags'?: Array; /** * * @type {boolean} * @memberof ParseResult */ 'replaced'?: boolean; /** * * @type {string} * @memberof ParseResult */ 'extractDate'?: string; /** * * @type {boolean} * @memberof ParseResult */ 'hasResult'?: boolean; } /** * * @export * @interface PdfAnnotation */ export interface PdfAnnotation { /** * * @type {string} * @memberof PdfAnnotation */ 'id'?: string; /** * * @type {number} * @memberof PdfAnnotation */ 'pageIndex'?: number; /** * * @type {string} * @memberof PdfAnnotation */ 'comment'?: string; /** * * @type {string} * @memberof PdfAnnotation */ 'text'?: string; /** * * @type {string} * @memberof PdfAnnotation */ 'modifiedDate'?: string; /** * * @type {string} * @memberof PdfAnnotation */ 'author'?: string; /** * * @type {string} * @memberof PdfAnnotation */ 'annotationType'?: string; /** * * @type {string} * @memberof PdfAnnotation */ 'image'?: string; } /** * * @export * @interface PdfDocument */ export interface PdfDocument { /** * * @type {string} * @memberof PdfDocument */ 'id'?: string; /** * * @type {PdfDocumentInfo} * @memberof PdfDocument */ 'docInfo'?: PdfDocumentInfo; /** * * @type {Array} * @memberof PdfDocument */ 'fullTexts'?: Array; /** * * @type {Array} * @memberof PdfDocument */ 'annotations'?: Array; } /** * * @export * @interface PdfDocumentInfo */ export interface PdfDocumentInfo { /** * * @type {string} * @memberof PdfDocumentInfo */ 'creator'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'title'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'author'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'fileName'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'filePath'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'citeKey'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'createdDate'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'modifiedDate'?: string; /** * * @type {string} * @memberof PdfDocumentInfo */ 'extractDate'?: string; /** * * @type {number} * @memberof PdfDocumentInfo */ 'pages'?: number; } /** * * @export * @interface PdfPage */ export interface PdfPage { /** * * @type {string} * @memberof PdfPage */ 'id'?: string; /** * * @type {number} * @memberof PdfPage */ 'pageIndex'?: number; /** * * @type {string} * @memberof PdfPage */ 'text'?: string; } /** * * @export * @interface SaveResults */ export interface SaveResults { /** * * @type {number} * @memberof SaveResults */ 'savedCards'?: number; /** * * @type {number} * @memberof SaveResults */ 'savedFiles'?: number; } /** * * @export * @interface Source */ export interface Source { /** * * @type {string} * @memberof Source */ 'id'?: string; /** * * @type {string} * @memberof Source */ 'extra'?: string; /** * * @type {string} * @memberof Source */ 'title'?: string; /** * * @type {string} * @memberof Source */ 'text'?: string; /** * * @type {string} * @memberof Source */ 'publicationDate'?: string; /** * * @type {string} * @memberof Source */ 'citation'?: string; /** * * @type {number} * @memberof Source */ 'pageIndex'?: number; /** * * @type {string} * @memberof Source */ 'uniqueId'?: string; /** * * @type {string} * @memberof Source */ 'uniqueIdNote'?: string; /** * * @type {string} * @memberof Source */ 'filePath'?: string; /** * * @type {string} * @memberof Source */ 'dirPath'?: string; /** * * @type {string} * @memberof Source */ 'fileName'?: string; /** * * @type {string} * @memberof Source */ 'modified'?: string; /** * * @type {string} * @memberof Source */ 'created'?: string; /** * * @type {Array} * @memberof Source */ 'cards'?: Array; } /** * * @export * @interface Tag */ export interface Tag { /** * * @type {string} * @memberof Tag */ 'id'?: string; /** * * @type {string} * @memberof Tag */ 'extra'?: string; /** * * @type {string} * @memberof Tag */ 'key'?: string; /** * * @type {string} * @memberof Tag */ 'value'?: string; /** * * @type {string} * @memberof Tag */ 'note'?: string; /** * * @type {Set} * @memberof Tag */ 'cards'?: Set; } /** * * @export * @interface TagExtract */ export interface TagExtract { /** * * @type {string} * @memberof TagExtract */ 'tagMarker'?: string; /** * * @type {string} * @memberof TagExtract */ 'tagValue'?: string; /** * * @type {string} * @memberof TagExtract */ 'tagNote'?: string; /** * * @type {string} * @memberof TagExtract */ 'tagKey'?: string; } /** * CardApi - axios parameter creator * @export */ export declare const CardApiAxiosParamCreator: (configuration?: Configuration) => { /** * export cards by ids * @summary export cards by ids * @param {'MARKDOWN'} format * @param {GetCardsById} getCardsById * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsById: (format: 'MARKDOWN', getCardsById: GetCardsById, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig) => Promise; /** * export cards by params * @summary export cards by params * @param {'MARKDOWN'} format * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsByParams: (format: 'MARKDOWN', includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig) => Promise; /** * export cards by tags * @summary export cards by tags * @param {'MARKDOWN'} format * @param {Array} key * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsByTags: (format: 'MARKDOWN', key: Array, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig) => Promise; /** * get one card by card id. * @summary get card by card id. * @param {string} cardId * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardById: (cardId: string, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig) => Promise; /** * list cards by params. * @summary list cards * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCards: (includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig) => Promise; /** * list cards by sources. * @summary list cards by identifiers plus standard params. Identifiers include cardsIds etc * @param {GetCardsByIdentifiers} getCardsByIdentifiers * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardsBySelectors: (getCardsByIdentifiers: GetCardsByIdentifiers, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig) => Promise; /** * get cards by a list of tag keys. Tag key matching can be exact or fuzzy. * @summary get cards by tags * @param {Array} key * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardsByTags: (key: Array, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig) => Promise; }; /** * CardApi - functional programming interface * @export */ export declare const CardApiFp: (configuration?: Configuration) => { /** * export cards by ids * @summary export cards by ids * @param {'MARKDOWN'} format * @param {GetCardsById} getCardsById * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsById(format: 'MARKDOWN', getCardsById: GetCardsById, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * export cards by params * @summary export cards by params * @param {'MARKDOWN'} format * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsByParams(format: 'MARKDOWN', includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * export cards by tags * @summary export cards by tags * @param {'MARKDOWN'} format * @param {Array} key * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsByTags(format: 'MARKDOWN', key: Array, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * get one card by card id. * @summary get card by card id. * @param {string} cardId * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardById(cardId: string, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * list cards by params. * @summary list cards * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCards(includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * list cards by sources. * @summary list cards by identifiers plus standard params. Identifiers include cardsIds etc * @param {GetCardsByIdentifiers} getCardsByIdentifiers * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardsBySelectors(getCardsByIdentifiers: GetCardsByIdentifiers, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * get cards by a list of tag keys. Tag key matching can be exact or fuzzy. * @summary get cards by tags * @param {Array} key * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardsByTags(key: Array, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * CardApi - factory interface * @export */ export declare const CardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * export cards by ids * @summary export cards by ids * @param {'MARKDOWN'} format * @param {GetCardsById} getCardsById * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsById(format: 'MARKDOWN', getCardsById: GetCardsById, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: any): AxiosPromise; /** * export cards by params * @summary export cards by params * @param {'MARKDOWN'} format * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsByParams(format: 'MARKDOWN', includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: any): AxiosPromise; /** * export cards by tags * @summary export cards by tags * @param {'MARKDOWN'} format * @param {Array} key * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportCardsByTags(format: 'MARKDOWN', key: Array, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: any): AxiosPromise; /** * get one card by card id. * @summary get card by card id. * @param {string} cardId * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardById(cardId: string, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: any): AxiosPromise; /** * list cards by params. * @summary list cards * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCards(includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: any): AxiosPromise; /** * list cards by sources. * @summary list cards by identifiers plus standard params. Identifiers include cardsIds etc * @param {GetCardsByIdentifiers} getCardsByIdentifiers * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardsBySelectors(getCardsByIdentifiers: GetCardsByIdentifiers, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: any): AxiosPromise; /** * get cards by a list of tag keys. Tag key matching can be exact or fuzzy. * @summary get cards by tags * @param {Array} key * @param {boolean} [includeMarkdown] * @param {string} [markdownTitle] * @param {string} [search] * @param {boolean} [searchExact] * @param {number} [page] * @param {number} [pageSize] * @param {boolean} [mactchExact] * @param {boolean} [commentedOnly] * @param {string} [fromDate] * @param {string} [toDate] * @param {string} [modifiedDate] * @param {string} [order] * @param {string} [sortBy] * @param {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} [selectorType] * @param {Array} [sourceIdentifiers] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCardsByTags(key: Array, includeMarkdown?: boolean, markdownTitle?: string, search?: string, searchExact?: boolean, page?: number, pageSize?: number, mactchExact?: boolean, commentedOnly?: boolean, fromDate?: string, toDate?: string, modifiedDate?: string, order?: string, sortBy?: string, selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH', sourceIdentifiers?: Array, options?: any): AxiosPromise; }; /** * Request parameters for exportCardsById operation in CardApi. * @export * @interface CardApiExportCardsByIdRequest */ export interface CardApiExportCardsByIdRequest { /** * * @type {'MARKDOWN'} * @memberof CardApiExportCardsById */ readonly format: 'MARKDOWN'; /** * * @type {GetCardsById} * @memberof CardApiExportCardsById */ readonly getCardsById: GetCardsById; /** * * @type {boolean} * @memberof CardApiExportCardsById */ readonly includeMarkdown?: boolean; /** * * @type {string} * @memberof CardApiExportCardsById */ readonly markdownTitle?: string; /** * * @type {string} * @memberof CardApiExportCardsById */ readonly search?: string; /** * * @type {boolean} * @memberof CardApiExportCardsById */ readonly searchExact?: boolean; /** * * @type {number} * @memberof CardApiExportCardsById */ readonly page?: number; /** * * @type {number} * @memberof CardApiExportCardsById */ readonly pageSize?: number; /** * * @type {boolean} * @memberof CardApiExportCardsById */ readonly mactchExact?: boolean; /** * * @type {boolean} * @memberof CardApiExportCardsById */ readonly commentedOnly?: boolean; /** * * @type {string} * @memberof CardApiExportCardsById */ readonly fromDate?: string; /** * * @type {string} * @memberof CardApiExportCardsById */ readonly toDate?: string; /** * * @type {string} * @memberof CardApiExportCardsById */ readonly modifiedDate?: string; /** * * @type {string} * @memberof CardApiExportCardsById */ readonly order?: string; /** * * @type {string} * @memberof CardApiExportCardsById */ readonly sortBy?: string; /** * * @type {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} * @memberof CardApiExportCardsById */ readonly selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'; /** * * @type {Array} * @memberof CardApiExportCardsById */ readonly sourceIdentifiers?: Array; } /** * Request parameters for exportCardsByParams operation in CardApi. * @export * @interface CardApiExportCardsByParamsRequest */ export interface CardApiExportCardsByParamsRequest { /** * * @type {'MARKDOWN'} * @memberof CardApiExportCardsByParams */ readonly format: 'MARKDOWN'; /** * * @type {boolean} * @memberof CardApiExportCardsByParams */ readonly includeMarkdown?: boolean; /** * * @type {string} * @memberof CardApiExportCardsByParams */ readonly markdownTitle?: string; /** * * @type {string} * @memberof CardApiExportCardsByParams */ readonly search?: string; /** * * @type {boolean} * @memberof CardApiExportCardsByParams */ readonly searchExact?: boolean; /** * * @type {number} * @memberof CardApiExportCardsByParams */ readonly page?: number; /** * * @type {number} * @memberof CardApiExportCardsByParams */ readonly pageSize?: number; /** * * @type {boolean} * @memberof CardApiExportCardsByParams */ readonly mactchExact?: boolean; /** * * @type {boolean} * @memberof CardApiExportCardsByParams */ readonly commentedOnly?: boolean; /** * * @type {string} * @memberof CardApiExportCardsByParams */ readonly fromDate?: string; /** * * @type {string} * @memberof CardApiExportCardsByParams */ readonly toDate?: string; /** * * @type {string} * @memberof CardApiExportCardsByParams */ readonly modifiedDate?: string; /** * * @type {string} * @memberof CardApiExportCardsByParams */ readonly order?: string; /** * * @type {string} * @memberof CardApiExportCardsByParams */ readonly sortBy?: string; /** * * @type {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} * @memberof CardApiExportCardsByParams */ readonly selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'; /** * * @type {Array} * @memberof CardApiExportCardsByParams */ readonly sourceIdentifiers?: Array; } /** * Request parameters for exportCardsByTags operation in CardApi. * @export * @interface CardApiExportCardsByTagsRequest */ export interface CardApiExportCardsByTagsRequest { /** * * @type {'MARKDOWN'} * @memberof CardApiExportCardsByTags */ readonly format: 'MARKDOWN'; /** * * @type {Array} * @memberof CardApiExportCardsByTags */ readonly key: Array; /** * * @type {boolean} * @memberof CardApiExportCardsByTags */ readonly includeMarkdown?: boolean; /** * * @type {string} * @memberof CardApiExportCardsByTags */ readonly markdownTitle?: string; /** * * @type {string} * @memberof CardApiExportCardsByTags */ readonly search?: string; /** * * @type {boolean} * @memberof CardApiExportCardsByTags */ readonly searchExact?: boolean; /** * * @type {number} * @memberof CardApiExportCardsByTags */ readonly page?: number; /** * * @type {number} * @memberof CardApiExportCardsByTags */ readonly pageSize?: number; /** * * @type {boolean} * @memberof CardApiExportCardsByTags */ readonly mactchExact?: boolean; /** * * @type {boolean} * @memberof CardApiExportCardsByTags */ readonly commentedOnly?: boolean; /** * * @type {string} * @memberof CardApiExportCardsByTags */ readonly fromDate?: string; /** * * @type {string} * @memberof CardApiExportCardsByTags */ readonly toDate?: string; /** * * @type {string} * @memberof CardApiExportCardsByTags */ readonly modifiedDate?: string; /** * * @type {string} * @memberof CardApiExportCardsByTags */ readonly order?: string; /** * * @type {string} * @memberof CardApiExportCardsByTags */ readonly sortBy?: string; /** * * @type {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} * @memberof CardApiExportCardsByTags */ readonly selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'; /** * * @type {Array} * @memberof CardApiExportCardsByTags */ readonly sourceIdentifiers?: Array; } /** * Request parameters for getCardById operation in CardApi. * @export * @interface CardApiGetCardByIdRequest */ export interface CardApiGetCardByIdRequest { /** * * @type {string} * @memberof CardApiGetCardById */ readonly cardId: string; /** * * @type {boolean} * @memberof CardApiGetCardById */ readonly includeMarkdown?: boolean; /** * * @type {string} * @memberof CardApiGetCardById */ readonly markdownTitle?: string; /** * * @type {string} * @memberof CardApiGetCardById */ readonly search?: string; /** * * @type {boolean} * @memberof CardApiGetCardById */ readonly searchExact?: boolean; /** * * @type {number} * @memberof CardApiGetCardById */ readonly page?: number; /** * * @type {number} * @memberof CardApiGetCardById */ readonly pageSize?: number; /** * * @type {boolean} * @memberof CardApiGetCardById */ readonly mactchExact?: boolean; /** * * @type {boolean} * @memberof CardApiGetCardById */ readonly commentedOnly?: boolean; /** * * @type {string} * @memberof CardApiGetCardById */ readonly fromDate?: string; /** * * @type {string} * @memberof CardApiGetCardById */ readonly toDate?: string; /** * * @type {string} * @memberof CardApiGetCardById */ readonly modifiedDate?: string; /** * * @type {string} * @memberof CardApiGetCardById */ readonly order?: string; /** * * @type {string} * @memberof CardApiGetCardById */ readonly sortBy?: string; /** * * @type {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} * @memberof CardApiGetCardById */ readonly selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'; /** * * @type {Array} * @memberof CardApiGetCardById */ readonly sourceIdentifiers?: Array; } /** * Request parameters for getCards operation in CardApi. * @export * @interface CardApiGetCardsRequest */ export interface CardApiGetCardsRequest { /** * * @type {boolean} * @memberof CardApiGetCards */ readonly includeMarkdown?: boolean; /** * * @type {string} * @memberof CardApiGetCards */ readonly markdownTitle?: string; /** * * @type {string} * @memberof CardApiGetCards */ readonly search?: string; /** * * @type {boolean} * @memberof CardApiGetCards */ readonly searchExact?: boolean; /** * * @type {number} * @memberof CardApiGetCards */ readonly page?: number; /** * * @type {number} * @memberof CardApiGetCards */ readonly pageSize?: number; /** * * @type {boolean} * @memberof CardApiGetCards */ readonly mactchExact?: boolean; /** * * @type {boolean} * @memberof CardApiGetCards */ readonly commentedOnly?: boolean; /** * * @type {string} * @memberof CardApiGetCards */ readonly fromDate?: string; /** * * @type {string} * @memberof CardApiGetCards */ readonly toDate?: string; /** * * @type {string} * @memberof CardApiGetCards */ readonly modifiedDate?: string; /** * * @type {string} * @memberof CardApiGetCards */ readonly order?: string; /** * * @type {string} * @memberof CardApiGetCards */ readonly sortBy?: string; /** * * @type {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} * @memberof CardApiGetCards */ readonly selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'; /** * * @type {Array} * @memberof CardApiGetCards */ readonly sourceIdentifiers?: Array; } /** * Request parameters for getCardsBySelectors operation in CardApi. * @export * @interface CardApiGetCardsBySelectorsRequest */ export interface CardApiGetCardsBySelectorsRequest { /** * * @type {GetCardsByIdentifiers} * @memberof CardApiGetCardsBySelectors */ readonly getCardsByIdentifiers: GetCardsByIdentifiers; /** * * @type {boolean} * @memberof CardApiGetCardsBySelectors */ readonly includeMarkdown?: boolean; /** * * @type {string} * @memberof CardApiGetCardsBySelectors */ readonly markdownTitle?: string; /** * * @type {string} * @memberof CardApiGetCardsBySelectors */ readonly search?: string; /** * * @type {boolean} * @memberof CardApiGetCardsBySelectors */ readonly searchExact?: boolean; /** * * @type {number} * @memberof CardApiGetCardsBySelectors */ readonly page?: number; /** * * @type {number} * @memberof CardApiGetCardsBySelectors */ readonly pageSize?: number; /** * * @type {boolean} * @memberof CardApiGetCardsBySelectors */ readonly mactchExact?: boolean; /** * * @type {boolean} * @memberof CardApiGetCardsBySelectors */ readonly commentedOnly?: boolean; /** * * @type {string} * @memberof CardApiGetCardsBySelectors */ readonly fromDate?: string; /** * * @type {string} * @memberof CardApiGetCardsBySelectors */ readonly toDate?: string; /** * * @type {string} * @memberof CardApiGetCardsBySelectors */ readonly modifiedDate?: string; /** * * @type {string} * @memberof CardApiGetCardsBySelectors */ readonly order?: string; /** * * @type {string} * @memberof CardApiGetCardsBySelectors */ readonly sortBy?: string; /** * * @type {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} * @memberof CardApiGetCardsBySelectors */ readonly selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'; /** * * @type {Array} * @memberof CardApiGetCardsBySelectors */ readonly sourceIdentifiers?: Array; } /** * Request parameters for getCardsByTags operation in CardApi. * @export * @interface CardApiGetCardsByTagsRequest */ export interface CardApiGetCardsByTagsRequest { /** * * @type {Array} * @memberof CardApiGetCardsByTags */ readonly key: Array; /** * * @type {boolean} * @memberof CardApiGetCardsByTags */ readonly includeMarkdown?: boolean; /** * * @type {string} * @memberof CardApiGetCardsByTags */ readonly markdownTitle?: string; /** * * @type {string} * @memberof CardApiGetCardsByTags */ readonly search?: string; /** * * @type {boolean} * @memberof CardApiGetCardsByTags */ readonly searchExact?: boolean; /** * * @type {number} * @memberof CardApiGetCardsByTags */ readonly page?: number; /** * * @type {number} * @memberof CardApiGetCardsByTags */ readonly pageSize?: number; /** * * @type {boolean} * @memberof CardApiGetCardsByTags */ readonly mactchExact?: boolean; /** * * @type {boolean} * @memberof CardApiGetCardsByTags */ readonly commentedOnly?: boolean; /** * * @type {string} * @memberof CardApiGetCardsByTags */ readonly fromDate?: string; /** * * @type {string} * @memberof CardApiGetCardsByTags */ readonly toDate?: string; /** * * @type {string} * @memberof CardApiGetCardsByTags */ readonly modifiedDate?: string; /** * * @type {string} * @memberof CardApiGetCardsByTags */ readonly order?: string; /** * * @type {string} * @memberof CardApiGetCardsByTags */ readonly sortBy?: string; /** * * @type {'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'} * @memberof CardApiGetCardsByTags */ readonly selectorType?: 'NONE' | 'CITEKEY' | 'CARDID' | 'FILEPATH'; /** * * @type {Array} * @memberof CardApiGetCardsByTags */ readonly sourceIdentifiers?: Array; } /** * CardApi - object-oriented interface * @export * @class CardApi * @extends {BaseAPI} */ export declare class CardApi extends BaseAPI { /** * export cards by ids * @summary export cards by ids * @param {CardApiExportCardsByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardApi */ exportCardsById(requestParameters: CardApiExportCardsByIdRequest, options?: AxiosRequestConfig): Promise>; /** * export cards by params * @summary export cards by params * @param {CardApiExportCardsByParamsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardApi */ exportCardsByParams(requestParameters: CardApiExportCardsByParamsRequest, options?: AxiosRequestConfig): Promise>; /** * export cards by tags * @summary export cards by tags * @param {CardApiExportCardsByTagsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardApi */ exportCardsByTags(requestParameters: CardApiExportCardsByTagsRequest, options?: AxiosRequestConfig): Promise>; /** * get one card by card id. * @summary get card by card id. * @param {CardApiGetCardByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardApi */ getCardById(requestParameters: CardApiGetCardByIdRequest, options?: AxiosRequestConfig): Promise>; /** * list cards by params. * @summary list cards * @param {CardApiGetCardsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardApi */ getCards(requestParameters?: CardApiGetCardsRequest, options?: AxiosRequestConfig): Promise>; /** * list cards by sources. * @summary list cards by identifiers plus standard params. Identifiers include cardsIds etc * @param {CardApiGetCardsBySelectorsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardApi */ getCardsBySelectors(requestParameters: CardApiGetCardsBySelectorsRequest, options?: AxiosRequestConfig): Promise>; /** * get cards by a list of tag keys. Tag key matching can be exact or fuzzy. * @summary get cards by tags * @param {CardApiGetCardsByTagsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CardApi */ getCardsByTags(requestParameters: CardApiGetCardsByTagsRequest, options?: AxiosRequestConfig): Promise>; } /** * ExtractPdfControllerApi - axios parameter creator * @export */ export declare const ExtractPdfControllerApiAxiosParamCreator: (configuration?: Configuration) => { /** * Extract and store pdf and return stats. * @param {ExtractPdfRequest} extractPdfRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractAndStorePdfAndReturnStats: (extractPdfRequest: ExtractPdfRequest, options?: AxiosRequestConfig) => Promise; /** * Extract and store pdf and return cards on specific pages. * @param {ExtractPdfPagesRequest} extractPdfPagesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractCardsOnPages: (extractPdfPagesRequest: ExtractPdfPagesRequest, options?: AxiosRequestConfig) => Promise; /** * Extract pdf and return raw extraction results. * @param {ExtractPdfRequestOne} extractPdfRequestOne * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractPdf: (extractPdfRequestOne: ExtractPdfRequestOne, options?: AxiosRequestConfig) => Promise; /** * Extract and store pdf and return cards stored. * @param {ExtractPdfRequest} extractPdfRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractReturnCards: (extractPdfRequest: ExtractPdfRequest, options?: AxiosRequestConfig) => Promise; }; /** * ExtractPdfControllerApi - functional programming interface * @export */ export declare const ExtractPdfControllerApiFp: (configuration?: Configuration) => { /** * Extract and store pdf and return stats. * @param {ExtractPdfRequest} extractPdfRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractAndStorePdfAndReturnStats(extractPdfRequest: ExtractPdfRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Extract and store pdf and return cards on specific pages. * @param {ExtractPdfPagesRequest} extractPdfPagesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractCardsOnPages(extractPdfPagesRequest: ExtractPdfPagesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Extract pdf and return raw extraction results. * @param {ExtractPdfRequestOne} extractPdfRequestOne * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractPdf(extractPdfRequestOne: ExtractPdfRequestOne, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Extract and store pdf and return cards stored. * @param {ExtractPdfRequest} extractPdfRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractReturnCards(extractPdfRequest: ExtractPdfRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ExtractPdfControllerApi - factory interface * @export */ export declare const ExtractPdfControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Extract and store pdf and return stats. * @param {ExtractPdfRequest} extractPdfRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractAndStorePdfAndReturnStats(extractPdfRequest: ExtractPdfRequest, options?: any): AxiosPromise; /** * Extract and store pdf and return cards on specific pages. * @param {ExtractPdfPagesRequest} extractPdfPagesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractCardsOnPages(extractPdfPagesRequest: ExtractPdfPagesRequest, options?: any): AxiosPromise; /** * Extract pdf and return raw extraction results. * @param {ExtractPdfRequestOne} extractPdfRequestOne * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractPdf(extractPdfRequestOne: ExtractPdfRequestOne, options?: any): AxiosPromise; /** * Extract and store pdf and return cards stored. * @param {ExtractPdfRequest} extractPdfRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ extractReturnCards(extractPdfRequest: ExtractPdfRequest, options?: any): AxiosPromise; }; /** * Request parameters for extractAndStorePdfAndReturnStats operation in ExtractPdfControllerApi. * @export * @interface ExtractPdfControllerApiExtractAndStorePdfAndReturnStatsRequest */ export interface ExtractPdfControllerApiExtractAndStorePdfAndReturnStatsRequest { /** * * @type {ExtractPdfRequest} * @memberof ExtractPdfControllerApiExtractAndStorePdfAndReturnStats */ readonly extractPdfRequest: ExtractPdfRequest; } /** * Request parameters for extractCardsOnPages operation in ExtractPdfControllerApi. * @export * @interface ExtractPdfControllerApiExtractCardsOnPagesRequest */ export interface ExtractPdfControllerApiExtractCardsOnPagesRequest { /** * * @type {ExtractPdfPagesRequest} * @memberof ExtractPdfControllerApiExtractCardsOnPages */ readonly extractPdfPagesRequest: ExtractPdfPagesRequest; } /** * Request parameters for extractPdf operation in ExtractPdfControllerApi. * @export * @interface ExtractPdfControllerApiExtractPdfRequest */ export interface ExtractPdfControllerApiExtractPdfRequest { /** * * @type {ExtractPdfRequestOne} * @memberof ExtractPdfControllerApiExtractPdf */ readonly extractPdfRequestOne: ExtractPdfRequestOne; } /** * Request parameters for extractReturnCards operation in ExtractPdfControllerApi. * @export * @interface ExtractPdfControllerApiExtractReturnCardsRequest */ export interface ExtractPdfControllerApiExtractReturnCardsRequest { /** * * @type {ExtractPdfRequest} * @memberof ExtractPdfControllerApiExtractReturnCards */ readonly extractPdfRequest: ExtractPdfRequest; } /** * ExtractPdfControllerApi - object-oriented interface * @export * @class ExtractPdfControllerApi * @extends {BaseAPI} */ export declare class ExtractPdfControllerApi extends BaseAPI { /** * Extract and store pdf and return stats. * @param {ExtractPdfControllerApiExtractAndStorePdfAndReturnStatsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtractPdfControllerApi */ extractAndStorePdfAndReturnStats(requestParameters: ExtractPdfControllerApiExtractAndStorePdfAndReturnStatsRequest, options?: AxiosRequestConfig): Promise>; /** * Extract and store pdf and return cards on specific pages. * @param {ExtractPdfControllerApiExtractCardsOnPagesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtractPdfControllerApi */ extractCardsOnPages(requestParameters: ExtractPdfControllerApiExtractCardsOnPagesRequest, options?: AxiosRequestConfig): Promise>; /** * Extract pdf and return raw extraction results. * @param {ExtractPdfControllerApiExtractPdfRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtractPdfControllerApi */ extractPdf(requestParameters: ExtractPdfControllerApiExtractPdfRequest, options?: AxiosRequestConfig): Promise>; /** * Extract and store pdf and return cards stored. * @param {ExtractPdfControllerApiExtractReturnCardsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExtractPdfControllerApi */ extractReturnCards(requestParameters: ExtractPdfControllerApiExtractReturnCardsRequest, options?: AxiosRequestConfig): Promise>; } /** * TagParserControllerApi - axios parameter creator * @export */ export declare const TagParserControllerApiAxiosParamCreator: (configuration?: Configuration) => { /** * Parse tags in the string and return tags and original or replaced text. * @param {ParseRequest} parseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ parseTags: (parseRequest: ParseRequest, options?: AxiosRequestConfig) => Promise; }; /** * TagParserControllerApi - functional programming interface * @export */ export declare const TagParserControllerApiFp: (configuration?: Configuration) => { /** * Parse tags in the string and return tags and original or replaced text. * @param {ParseRequest} parseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ parseTags(parseRequest: ParseRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TagParserControllerApi - factory interface * @export */ export declare const TagParserControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Parse tags in the string and return tags and original or replaced text. * @param {ParseRequest} parseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ parseTags(parseRequest: ParseRequest, options?: any): AxiosPromise; }; /** * Request parameters for parseTags operation in TagParserControllerApi. * @export * @interface TagParserControllerApiParseTagsRequest */ export interface TagParserControllerApiParseTagsRequest { /** * * @type {ParseRequest} * @memberof TagParserControllerApiParseTags */ readonly parseRequest: ParseRequest; } /** * TagParserControllerApi - object-oriented interface * @export * @class TagParserControllerApi * @extends {BaseAPI} */ export declare class TagParserControllerApi extends BaseAPI { /** * Parse tags in the string and return tags and original or replaced text. * @param {TagParserControllerApiParseTagsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TagParserControllerApi */ parseTags(requestParameters: TagParserControllerApiParseTagsRequest, options?: AxiosRequestConfig): Promise>; }