Function PersonsApiFp

Returns {
    getPerson(
        name: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>,
    >;
    getPersons(
        limit?: number,
        searchTerm?: string,
        fields?: ItemFields[],
        filters?: ItemFilter[],
        isFavorite?: boolean,
        enableUserData?: boolean,
        imageTypeLimit?: number,
        enableImageTypes?: ImageType[],
        excludePersonTypes?: string[],
        personTypes?: string[],
        appearsInItemId?: string,
        userId?: string,
        enableImages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >;
}

• getPerson: function

  • getPerson(
        name: string,
        userId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>,
    >

    Parameters

    • name: string

      Person name.
    • OptionaluserId: string

      Optional. Filter by user id, and attach user data.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>

    Throws

• getPersons: function

  • getPersons(
        limit?: number,
        searchTerm?: string,
        fields?: ItemFields[],
        filters?: ItemFilter[],
        isFavorite?: boolean,
        enableUserData?: boolean,
        imageTypeLimit?: number,
        enableImageTypes?: ImageType[],
        excludePersonTypes?: string[],
        personTypes?: string[],
        appearsInItemId?: string,
        userId?: string,
        enableImages?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Parameters

    • Optionallimit: number

      Optional. The maximum number of records to return.
    • OptionalsearchTerm: string

      The search term.
    • Optionalfields: ItemFields[]

      Optional. Specify additional fields of information to return in the output.
    • Optionalfilters: ItemFilter[]

      Optional. Specify additional filters to apply.
    • OptionalisFavorite: boolean

      Optional filter by items that are marked as favorite, or not. userId is required.
    • OptionalenableUserData: boolean

      Optional, include user data.
    • OptionalimageTypeLimit: number

      Optional, the max number of images to return, per image type.
    • OptionalenableImageTypes: ImageType[]

      Optional. The image types to include in the output.
    • OptionalexcludePersonTypes: string[]

      Optional. If specified results will be filtered to exclude those containing the specified PersonType. Allows multiple, comma-delimited.
    • OptionalpersonTypes: string[]

      Optional. If specified results will be filtered to include only those containing the specified PersonType. Allows multiple, comma-delimited.
    • OptionalappearsInItemId: string

      Optional. If specified, person results will be filtered on items related to said persons.
    • OptionaluserId: string

      User id.
    • OptionalenableImages: boolean

      Optional, include image information in output.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Throws