Class CountriesApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

getCountries getCountriesRaw getCountry getCountryRaw isJsonMime request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protectedconfiguration

configuration: Configuration = DefaultConfig

Methods

getCountries

  • getCountries(requestParameters?, initOverrides?): Promise<{
        [key: string]: Country;
    }>

  • Get all the supported countries and the list of the supported services and their details for each country. Details of services include names, logos, supported streaming types (subscription, rent, buy, free etc.) and list of available addons/channels. Get all Countries

    Parameters

    Returns Promise<{
        [key: string]: Country;
    }>

getCountriesRaw

  • getCountriesRaw(requestParameters, initOverrides?): Promise<ApiResponse<{
        [key: string]: Country;
    }>>

  • Get all the supported countries and the list of the supported services and their details for each country. Details of services include names, logos, supported streaming types (subscription, rent, buy, free etc.) and list of available addons/channels. Get all Countries

    Parameters

    Returns Promise<ApiResponse<{
        [key: string]: Country;
    }>>

getCountry

  • getCountry(requestParameters, initOverrides?): Promise<Country>

  • Get a country and the list of the supported services and their details. Details of services include names, logos, supported streaming types (subscription, rent, buy, free etc.) and list of available addons/channels. Get a Country

    Parameters

    Returns Promise<Country>

getCountryRaw

  • getCountryRaw(requestParameters, initOverrides?): Promise<ApiResponse<Country>>

  • Get a country and the list of the supported services and their details. Details of services include names, logos, supported streaming types (subscription, rent, buy, free etc.) and list of available addons/channels. Get a Country

    Parameters

    Returns Promise<ApiResponse<Country>>

ProtectedisJsonMime

  • isJsonMime(mime): boolean

  • Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

    Parameters

    • mime: string

      MIME (Multipurpose Internet Mail Extensions)

    Returns boolean

    True if the given MIME is JSON, false otherwise.

Protectedrequest

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

Settings

Member Visibility

On This Page

Constructors
Properties
Methods