Function YearsApiAxiosParamCreator

YearsApi - axios parameter creator

Export

  • YearsApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        getYear: (
            year: number,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getYears: (
            startIndex?: number,
            limit?: number,
            sortOrder?: SortOrder[],
            parentId?: string,
            fields?: ItemFields[],
            excludeItemTypes?: BaseItemKind[],
            includeItemTypes?: BaseItemKind[],
            mediaTypes?: MediaType[],
            sortBy?: ItemSortBy[],
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            userId?: string,
            recursive?: boolean,
            enableImages?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    Returns {
        getYear: (
            year: number,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getYears: (
            startIndex?: number,
            limit?: number,
            sortOrder?: SortOrder[],
            parentId?: string,
            fields?: ItemFields[],
            excludeItemTypes?: BaseItemKind[],
            includeItemTypes?: BaseItemKind[],
            mediaTypes?: MediaType[],
            sortBy?: ItemSortBy[],
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            userId?: string,
            recursive?: boolean,
            enableImages?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • getYear: (
          year: number,
          userId?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • getYears: (
          startIndex?: number,
          limit?: number,
          sortOrder?: SortOrder[],
          parentId?: string,
          fields?: ItemFields[],
          excludeItemTypes?: BaseItemKind[],
          includeItemTypes?: BaseItemKind[],
          mediaTypes?: MediaType[],
          sortBy?: ItemSortBy[],
          enableUserData?: boolean,
          imageTypeLimit?: number,
          enableImageTypes?: ImageType[],
          userId?: string,
          recursive?: boolean,
          enableImages?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

Settings

Member Visibility