FeaturedSectionApi - object-oriented interface

Export

Hierarchy

  • BaseAPI
    • FeaturedSectionApi

Constructors

Properties

axios: AxiosInstance = globalAxios
basePath: string = BASE_PATH
configuration: Configuration

Methods

  • Fetch featured sections of registry OR if you provide storeKey in query it will fetch featured sections from store.

    Summary

    Get Featured Sections

    Throws

    Memberof

    FeaturedSectionApi

    Parameters

    • Optional storeKey: string

      Unique Id of a particular store. provide only if you want to fetch feature section form a particular store.

    • Optional featuredSectionKey: string

      Unique Id of a particular featured section of the store. provide only if you want to fetch a perticular feature section of a store.

    • Optional options: AxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FeaturedSection[]>>

  • Returns the store title

    Summary

    Registry title

    Throws

    Memberof

    FeaturedSectionApi

    Parameters

    • Optional options: AxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<string>>

Generated using TypeDoc