UNPKG

@revxui/api-clients-ts

Version:

swagger client for @revxui/api-clients-ts

149 lines (148 loc) 16.1 kB
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http'; import { Observable } from 'rxjs'; import { ApiResponseObjectListSliceXBudgetUtilisationResponse } from '../model/apiResponseObjectListSliceXBudgetUtilisationResponse'; import { ApiResponseObjectListSliceXStaticMetaDataResponse } from '../model/apiResponseObjectListSliceXStaticMetaDataResponse'; import { ApiResponseObjectListSliceXWinReachResponse } from '../model/apiResponseObjectListSliceXWinReachResponse'; import { ApiResponseObjectSlicexChartResponse } from '../model/apiResponseObjectSlicexChartResponse'; import { ApiResponseObjectSlicexListResponse } from '../model/apiResponseObjectSlicexListResponse'; import { FileDownloadResponse } from '../model/fileDownloadResponse'; import { SliceXBudgetUtilisationRequest } from '../model/sliceXBudgetUtilisationRequest'; import { SliceXStaticMetaDataRequest } from '../model/sliceXStaticMetaDataRequest'; import { SliceXWinReachRequest } from '../model/sliceXWinReachRequest'; import { SlicexRequest } from '../model/slicexRequest'; import { SlicexRequestExtended } from '../model/slicexRequestExtended'; import { Configuration } from '../configuration'; import * as i0 from "@angular/core"; export declare class SliceXControllerService { protected httpClient: HttpClient; protected basePath: string; defaultHeaders: HttpHeaders; configuration: Configuration; constructor(httpClient: HttpClient, basePath: string, configuration: Configuration); /** * @param consumes string[] mime-types * @return true: consumes contains 'multipart/form-data', false: otherwise */ private canConsumeForm; /** * API to fetch Budget Utilisation for any entity type (licensee, advertiser, campaign, strategy). * * @param request request * @param reqId request id * @param sort sort * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getBudgetUtilisationUsingPOST(request: SliceXBudgetUtilisationRequest, reqId?: string, sort?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectListSliceXBudgetUtilisationResponse>; getBudgetUtilisationUsingPOST(request: SliceXBudgetUtilisationRequest, reqId?: string, sort?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectListSliceXBudgetUtilisationResponse>>; getBudgetUtilisationUsingPOST(request: SliceXBudgetUtilisationRequest, reqId?: string, sort?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectListSliceXBudgetUtilisationResponse>>; /** * Slicex API for graph. * * @param slicexRequest slicexRequest * @param reqId request id * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getSlicexDataChartUsingPOST(slicexRequest: SlicexRequest, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectSlicexChartResponse>; getSlicexDataChartUsingPOST(slicexRequest: SlicexRequest, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectSlicexChartResponse>>; getSlicexDataChartUsingPOST(slicexRequest: SlicexRequest, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectSlicexChartResponse>>; /** * Slicex new Grid API for Licensee, Advertiser, Campaign and Strategy only. * * @param entity entity * @param slicexRequest slicexRequest * @param reqId request id * @param sort sort * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getSlicexDataListNewUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectSlicexListResponse>; getSlicexDataListNewUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectSlicexListResponse>>; getSlicexDataListNewUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectSlicexListResponse>>; /** * Slicex API for grid. * * @param entity entity * @param slicexRequest slicexRequest * @param reqId request id * @param sort sort * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getSlicexDataListUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectSlicexListResponse>; getSlicexDataListUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectSlicexListResponse>>; getSlicexDataListUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectSlicexListResponse>>; /** * Slicex API for grid with compare. * * @param entity entity * @param slicexRequest slicexRequest * @param reqId request id * @param sort sort * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getSlicexDataListWithCompareUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectSlicexListResponse>; getSlicexDataListWithCompareUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectSlicexListResponse>>; getSlicexDataListWithCompareUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectSlicexListResponse>>; /** * Slicex API for grid details. * * @param entity entity * @param slicexRequestExt slicexRequestExt * @param reqId request id * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getSlicexGridDetailsUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequestExt: SlicexRequestExtended, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectSlicexListResponse>; getSlicexGridDetailsUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequestExt: SlicexRequestExtended, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectSlicexListResponse>>; getSlicexGridDetailsUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequestExt: SlicexRequestExtended, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectSlicexListResponse>>; /** * Slicex API for List Export. * * @param entity entity * @param slicexRequest slicexRequest * @param reqId request id * @param sort sort * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getSlicexListDataForExportUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<FileDownloadResponse>; getSlicexListDataForExportUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<FileDownloadResponse>>; getSlicexListDataForExportUsingPOST(entity: 'licensee' | 'advertiser' | 'campaign' | 'strategy' | 'creativeSize' | 'aggregator' | 'app' | 'os' | 'creative' | 'country' | 'city' | 'pricing' | 'pixel' | 'campaignObjective' | 'advregions' | 'creativeSets' | 'creativeSetsType' | 'videoPlacement' | 'sourceType' | 'deal' | 'lat', slicexRequest: SlicexRequest, reqId?: string, sort?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<FileDownloadResponse>>; /** * API to fetch static metadata (Budget &amp; KPI) for any entity type (licensee, advertiser, campaign, strategy). * * @param request request * @param reqId request id * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getStaticMetaDataUsingPOST(request: SliceXStaticMetaDataRequest, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectListSliceXStaticMetaDataResponse>; getStaticMetaDataUsingPOST(request: SliceXStaticMetaDataRequest, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectListSliceXStaticMetaDataResponse>>; getStaticMetaDataUsingPOST(request: SliceXStaticMetaDataRequest, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectListSliceXStaticMetaDataResponse>>; /** * API to fetch win-rate and reach for entities licensee, advertiser, campaign, strategy * * @param request request * @param reqId request id * @param sort sort * @param token Auth Token * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. * @param reportProgress flag to report request and response progress. */ getWinRateAndReachUsingPOST(request: SliceXWinReachRequest, reqId?: string, sort?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectListSliceXWinReachResponse>; getWinRateAndReachUsingPOST(request: SliceXWinReachRequest, reqId?: string, sort?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectListSliceXWinReachResponse>>; getWinRateAndReachUsingPOST(request: SliceXWinReachRequest, reqId?: string, sort?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectListSliceXWinReachResponse>>; static ɵfac: i0.ɵɵFactoryDeclaration<SliceXControllerService, [null, { optional: true; }, { optional: true; }]>; static ɵprov: i0.ɵɵInjectableDeclaration<SliceXControllerService>; }