Class HitsApi

HitsApi - object-oriented interface

export

Hierarchy

BaseAPI
- HitsApi

Index

Constructors

constructor

Methods

Constructors

constructor

new HitsApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): HitsApi

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns HitsApi

Methods

createSceneHit

createSceneHit(requestParameters: HitsApiCreateSceneHitRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Hit, any>>

- Defined in api.ts:9701
Create a hit for a scene.

throws
{RequiredError}

memberof
HitsApi

Parameters
- requestParameters: HitsApiCreateSceneHitRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<Hit, any>>

createSceneViewHit

createSceneViewHit(requestParameters: HitsApiCreateSceneViewHitRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Hit, any>>

- Defined in api.ts:9723
Create a hit for a scene-view.

throws
{RequiredError}

memberof
HitsApi

Parameters
- requestParameters: HitsApiCreateSceneViewHitRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<Hit, any>>