Function PersonsApiAxiosParamCreator

PersonsApi - axios parameter creator

Export

  • PersonsApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        getPerson: (
            name: string,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        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<RequestArgs>;
    }

  • Parameters

    Returns {
        getPerson: (
            name: string,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        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<RequestArgs>;
    }

    • getPerson: (
          name: string,
          userId?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • 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<RequestArgs>

      Throws

Settings

Member Visibility