@revxui/api-clients-ts
Version:
swagger client for @revxui/api-clients-ts
225 lines (224 loc) • 17.5 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { ApiListResponseCreativeDTO } from '../model/apiListResponseCreativeDTO';
import { ApiListResponseHotstarNativeFileRequest } from '../model/apiListResponseHotstarNativeFileRequest';
import { ApiListResponseSizeWithPreview } from '../model/apiListResponseSizeWithPreview';
import { ApiResponseObjectApiListResponseCreativeCompactDTO } from '../model/apiResponseObjectApiListResponseCreativeCompactDTO';
import { ApiResponseObjectApiListResponseCreativeDTO } from '../model/apiResponseObjectApiListResponseCreativeDTO';
import { ApiResponseObjectCreativeDTO } from '../model/apiResponseObjectCreativeDTO';
import { ApiResponseObjectCreativePerformanceData } from '../model/apiResponseObjectCreativePerformanceData';
import { ApiResponseObjectJsonNode } from '../model/apiResponseObjectJsonNode';
import { ApiResponseObjectListCreativeEntity } from '../model/apiResponseObjectListCreativeEntity';
import { ApiResponseObjectMaplongResponseMessage } from '../model/apiResponseObjectMaplongResponseMessage';
import { CreativeDTO } from '../model/creativeDTO';
import { CreativeHtmlMockupDTO } from '../model/creativeHtmlMockupDTO';
import { CreativeMockUpsDTO } from '../model/creativeMockUpsDTO';
import { CreativeThirdPartyAdTag } from '../model/creativeThirdPartyAdTag';
import { DashboardRequest } from '../model/dashboardRequest';
import { HotstarFileRequest } from '../model/hotstarFileRequest';
import { SearchRequest } from '../model/searchRequest';
import { VideoAdTagVerifyRequest } from '../model/videoAdTagVerifyRequest';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class CreativeControllerService {
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;
/**
* activate Lists of creative id
*
* @param commaSepratedIds commaSepratedIds
* @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.
*/
activateCreativeUsingPOST(commaSepratedIds: string, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectMaplongResponseMessage>;
activateCreativeUsingPOST(commaSepratedIds: string, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectMaplongResponseMessage>>;
activateCreativeUsingPOST(commaSepratedIds: string, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectMaplongResponseMessage>>;
/**
* Api to batch create creatives
*
* @param creativeDTOs creativeDTOs
* @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.
*/
createCreativeUsingPOST(creativeDTOs: Array<CreativeDTO>, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiListResponseCreativeDTO>;
createCreativeUsingPOST(creativeDTOs: Array<CreativeDTO>, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiListResponseCreativeDTO>>;
createCreativeUsingPOST(creativeDTOs: Array<CreativeDTO>, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiListResponseCreativeDTO>>;
/**
* Api to create creatives mockups
*
* @param mockupDTO mockupDTO
* @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.
*/
createHtmlMockupsUsingPOST(mockupDTO: CreativeHtmlMockupDTO, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiListResponseCreativeDTO>;
createHtmlMockupsUsingPOST(mockupDTO: CreativeHtmlMockupDTO, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiListResponseCreativeDTO>>;
createHtmlMockupsUsingPOST(mockupDTO: CreativeHtmlMockupDTO, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiListResponseCreativeDTO>>;
/**
* Api to create creatives mockups
*
* @param mockupDTO mockupDTO
* @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.
*/
createMockupsUsingPOST(mockupDTO: CreativeMockUpsDTO, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiListResponseCreativeDTO>;
createMockupsUsingPOST(mockupDTO: CreativeMockUpsDTO, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiListResponseCreativeDTO>>;
createMockupsUsingPOST(mockupDTO: CreativeMockUpsDTO, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiListResponseCreativeDTO>>;
/**
* deactivate Lists of creative id
*
* @param commaSepratedIds commaSepratedIds
* @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.
*/
deactivateCreativeUsingPOST(commaSepratedIds: string, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectMaplongResponseMessage>;
deactivateCreativeUsingPOST(commaSepratedIds: string, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectMaplongResponseMessage>>;
deactivateCreativeUsingPOST(commaSepratedIds: string, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectMaplongResponseMessage>>;
/**
* Api to get Third party adtag creatives
*
* @param adTag adTag
* @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.
*/
getAdTagCreativeUsingPOST(adTag: CreativeThirdPartyAdTag, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativeDTO>;
getAdTagCreativeUsingPOST(adTag: CreativeThirdPartyAdTag, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativeDTO>>;
getAdTagCreativeUsingPOST(adTag: CreativeThirdPartyAdTag, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativeDTO>>;
/**
* get Creative by Id
*
* @param id id
* @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.
*/
getCreativeByIdUsingGET(id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativeDTO>;
getCreativeByIdUsingGET(id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativeDTO>>;
getCreativeByIdUsingGET(id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativeDTO>>;
/**
* Api to to fetch creative simulation response.
*
* @param creativeId creativeId
* @param osId osId
* @param sspName sspName
* @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.
*/
getCreativeSimulationUsingGET(creativeId: number, osId: number, sspName: 'VUNGLE' | 'APPLOVIN', reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectJsonNode>;
getCreativeSimulationUsingGET(creativeId: number, osId: number, sspName: 'VUNGLE' | 'APPLOVIN', reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectJsonNode>>;
getCreativeSimulationUsingGET(creativeId: number, osId: number, sspName: 'VUNGLE' | 'APPLOVIN', reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectJsonNode>>;
/**
* get Performance Data by Creative by Id
*
* @param id id
* @param search search
* @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.
*/
getPerformanceForCreativeByIdUsingPOST(id: number, search: DashboardRequest, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativePerformanceData>;
getPerformanceForCreativeByIdUsingPOST(id: number, search: DashboardRequest, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativePerformanceData>>;
getPerformanceForCreativeByIdUsingPOST(id: number, search: DashboardRequest, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativePerformanceData>>;
/**
* get/search creatives compacts
*
* @param search search
* @param refresh refresh
* @param reqId request id
* @param skadtarget skadtarget
* @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.
*/
searchCreativesCompactUsingPOST(search: SearchRequest, refresh?: boolean, reqId?: string, skadtarget?: boolean, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectApiListResponseCreativeCompactDTO>;
searchCreativesCompactUsingPOST(search: SearchRequest, refresh?: boolean, reqId?: string, skadtarget?: boolean, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectApiListResponseCreativeCompactDTO>>;
searchCreativesCompactUsingPOST(search: SearchRequest, refresh?: boolean, reqId?: string, skadtarget?: boolean, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectApiListResponseCreativeCompactDTO>>;
/**
* get/search creatives
*
* @param search search
* @param refresh refresh
* @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.
*/
searchCreativesUsingPOST(search: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectApiListResponseCreativeDTO>;
searchCreativesUsingPOST(search: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectApiListResponseCreativeDTO>>;
searchCreativesUsingPOST(search: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectApiListResponseCreativeDTO>>;
/**
* API to update Creative Test Mode flag for multiple creatives.
*
* @param creativeIds creativeIds
* @param enabled enabled
* @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.
*/
updateCreativeTestModeUsingPOST(creativeIds: Array<number>, enabled: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectListCreativeEntity>;
updateCreativeTestModeUsingPOST(creativeIds: Array<number>, enabled: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectListCreativeEntity>>;
updateCreativeTestModeUsingPOST(creativeIds: Array<number>, enabled: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectListCreativeEntity>>;
/**
* update Creative
*
* @param creative creative
* @param id id
* @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.
*/
updateCreativeUsingPOST(creative: CreativeDTO, id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativeDTO>;
updateCreativeUsingPOST(creative: CreativeDTO, id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativeDTO>>;
updateCreativeUsingPOST(creative: CreativeDTO, id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativeDTO>>;
/**
* Api to get mp4 files for Hotstar Native Video.
*
* @param hotstarFileRequest hotstarFileRequest
* @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.
*/
uploadHotstarNativeVideoFilesUsingPOST(hotstarFileRequest: HotstarFileRequest, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiListResponseHotstarNativeFileRequest>;
uploadHotstarNativeVideoFilesUsingPOST(hotstarFileRequest: HotstarFileRequest, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiListResponseHotstarNativeFileRequest>>;
uploadHotstarNativeVideoFilesUsingPOST(hotstarFileRequest: HotstarFileRequest, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiListResponseHotstarNativeFileRequest>>;
/**
* Api to verify and get Third party video adtag creative details
*
* @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.
*/
verifyAndGetVideoAdTagCreativeDetailsUsingPOST(request: VideoAdTagVerifyRequest, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiListResponseSizeWithPreview>;
verifyAndGetVideoAdTagCreativeDetailsUsingPOST(request: VideoAdTagVerifyRequest, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiListResponseSizeWithPreview>>;
verifyAndGetVideoAdTagCreativeDetailsUsingPOST(request: VideoAdTagVerifyRequest, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiListResponseSizeWithPreview>>;
static ɵfac: i0.ɵɵFactoryDeclaration<CreativeControllerService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<CreativeControllerService>;
}