@revxui/api-clients-ts
Version:
swagger client for @revxui/api-clients-ts
248 lines (247 loc) • 20.9 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { ApiListResponseCreativeTemplateDTO } from '../model/apiListResponseCreativeTemplateDTO';
import { ApiResponseObjectAdvertiserDynamicDetails } from '../model/apiResponseObjectAdvertiserDynamicDetails';
import { ApiResponseObjectApiListResponseActivityLogsCreativeSetsBulkUpdateDTO } from '../model/apiResponseObjectApiListResponseActivityLogsCreativeSetsBulkUpdateDTO';
import { ApiResponseObjectApiListResponseCreativePerformanceList } from '../model/apiResponseObjectApiListResponseCreativePerformanceList';
import { ApiResponseObjectApiListResponseCreativeSetDashboardMetric } from '../model/apiResponseObjectApiListResponseCreativeSetDashboardMetric';
import { ApiResponseObjectApiListResponseCreativeSetPerformanceList } from '../model/apiResponseObjectApiListResponseCreativeSetPerformanceList';
import { ApiResponseObjectBulkEditCreativeSetsResponse } from '../model/apiResponseObjectBulkEditCreativeSetsResponse';
import { ApiResponseObjectCreativePreviewDTO } from '../model/apiResponseObjectCreativePreviewDTO';
import { ApiResponseObjectCreativeSetDetails } from '../model/apiResponseObjectCreativeSetDetails';
import { ApiResponseObjectCreativeSetResponse } from '../model/apiResponseObjectCreativeSetResponse';
import { ApiResponseObjectDashboardMetrics } from '../model/apiResponseObjectDashboardMetrics';
import { ApiResponseObjectDashboardResponse } from '../model/apiResponseObjectDashboardResponse';
import { ApiResponseObjectDuplicateCreativeSetResponse } from '../model/apiResponseObjectDuplicateCreativeSetResponse';
import { ApiResponseObjectListCreativeEntity } from '../model/apiResponseObjectListCreativeEntity';
import { ApiResponseObjectResponseMessage } from '../model/apiResponseObjectResponseMessage';
import { BulkEditCreativeSetsDTO } from '../model/bulkEditCreativeSetsDTO';
import { CreativeSetRequest } from '../model/creativeSetRequest';
import { CreativeSetRescheduleRequest } from '../model/creativeSetRescheduleRequest';
import { DashboardRequest } from '../model/dashboardRequest';
import { DuplicateCreativeSetsRequestDTO } from '../model/duplicateCreativeSetsRequestDTO';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class CreativeSetsControllerService {
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 get Creative Sets Bulk Edit Activity Log
*
* @param pageNumber pageNumber
* @param pageSize pageSize
* @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.
*/
bulkEditActivityLogUsingGET1(pageNumber?: number, pageSize?: number, reqId?: string, sort?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectApiListResponseActivityLogsCreativeSetsBulkUpdateDTO>;
bulkEditActivityLogUsingGET1(pageNumber?: number, pageSize?: number, reqId?: string, sort?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectApiListResponseActivityLogsCreativeSetsBulkUpdateDTO>>;
bulkEditActivityLogUsingGET1(pageNumber?: number, pageSize?: number, reqId?: string, sort?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectApiListResponseActivityLogsCreativeSetsBulkUpdateDTO>>;
/**
* Api to bulk edit creative sets
*
* @param dto dto
* @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.
*/
bulkEditCreativeSetsUsingPOST(dto: BulkEditCreativeSetsDTO, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectBulkEditCreativeSetsResponse>;
bulkEditCreativeSetsUsingPOST(dto: BulkEditCreativeSetsDTO, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectBulkEditCreativeSetsResponse>>;
bulkEditCreativeSetsUsingPOST(dto: BulkEditCreativeSetsDTO, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectBulkEditCreativeSetsResponse>>;
/**
* Api to create creative sets
*
* @param creativeSetRequest creativeSetRequest
* @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.
*/
createUsingPOST(creativeSetRequest: CreativeSetRequest, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativeSetResponse>;
createUsingPOST(creativeSetRequest: CreativeSetRequest, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativeSetResponse>>;
createUsingPOST(creativeSetRequest: CreativeSetRequest, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativeSetResponse>>;
/**
* Api to duplicate creative sets
*
* @param dto dto
* @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.
*/
duplicateCreativeSetsUsingPOST(dto: DuplicateCreativeSetsRequestDTO, id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectDuplicateCreativeSetResponse>;
duplicateCreativeSetsUsingPOST(dto: DuplicateCreativeSetsRequestDTO, id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectDuplicateCreativeSetResponse>>;
duplicateCreativeSetsUsingPOST(dto: DuplicateCreativeSetsRequestDTO, id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectDuplicateCreativeSetResponse>>;
/**
* Api to get creative sets dimension details
*
* @param advertiserId advertiserId
* @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.
*/
getAdvertiserDynamicDetailsUsingGET(advertiserId: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectAdvertiserDynamicDetails>;
getAdvertiserDynamicDetailsUsingGET(advertiserId: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectAdvertiserDynamicDetails>>;
getAdvertiserDynamicDetailsUsingGET(advertiserId: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectAdvertiserDynamicDetails>>;
/**
* Api to get creative sets
*
* @param id id
* @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.
*/
getByIdUsingGET3(id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativeSetDetails>;
getByIdUsingGET3(id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativeSetDetails>>;
getByIdUsingGET3(id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativeSetDetails>>;
/**
* Api to get list of creatives with performance data
*
* @param dashboardRequest dashboardRequest
* @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.
*/
getCreativePerformanceDataUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectApiListResponseCreativePerformanceList>;
getCreativePerformanceDataUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectApiListResponseCreativePerformanceList>>;
getCreativePerformanceDataUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectApiListResponseCreativePerformanceList>>;
/**
* Api to get creative preview modal details
*
* @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.
*/
getCreativePreviewModalDataUsingGET(id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativePreviewDTO>;
getCreativePreviewModalDataUsingGET(id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativePreviewDTO>>;
getCreativePreviewModalDataUsingGET(id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativePreviewDTO>>;
/**
* Api to get list of creative sets with performance data
*
* @param dashboardRequest dashboardRequest
* @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.
*/
getCreativeSetsPerformanceDataUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectApiListResponseCreativeSetPerformanceList>;
getCreativeSetsPerformanceDataUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectApiListResponseCreativeSetPerformanceList>>;
getCreativeSetsPerformanceDataUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectApiListResponseCreativeSetPerformanceList>>;
/**
* Api to get list of creative sets with performance
*
* @param dashboardRequest dashboardRequest
* @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.
*/
getCreativeSetsPerformanceUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectApiListResponseCreativeSetDashboardMetric>;
getCreativeSetsPerformanceUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectApiListResponseCreativeSetDashboardMetric>>;
getCreativeSetsPerformanceUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectApiListResponseCreativeSetDashboardMetric>>;
/**
* Api to get individual creative performance
*
* @param dashboardRequest dashboardRequest
* @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.
*/
getCreativesPerformanceUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectDashboardResponse>;
getCreativesPerformanceUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectDashboardResponse>>;
getCreativesPerformanceUsingPOST(dashboardRequest: DashboardRequest, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectDashboardResponse>>;
/**
* Api to get individual creative set performance
*
* @param dashboardRequest dashboardRequest
* @param id id
* @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.
*/
getPerformanceByIdUsingPOST(dashboardRequest: DashboardRequest, id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectDashboardMetrics>;
getPerformanceByIdUsingPOST(dashboardRequest: DashboardRequest, id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectDashboardMetrics>>;
getPerformanceByIdUsingPOST(dashboardRequest: DashboardRequest, id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectDashboardMetrics>>;
/**
* Api to get available hybrid ad templates for the uploaded videos
*
* @param advertiserId advertiserId
* @param type type
* @param filters filters
* @param hybridSupportType hybridSupportType
* @param isPlacebo isPlacebo
* @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.
*/
getTemplateListUsingGET(advertiserId: number, type: 'DCO' | 'HYBRID_STATIC_AD' | 'HYBRID_DYNAMIC_AD', filters?: string, hybridSupportType?: 'IMAGE' | 'VIDEO', isPlacebo?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiListResponseCreativeTemplateDTO>;
getTemplateListUsingGET(advertiserId: number, type: 'DCO' | 'HYBRID_STATIC_AD' | 'HYBRID_DYNAMIC_AD', filters?: string, hybridSupportType?: 'IMAGE' | 'VIDEO', isPlacebo?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiListResponseCreativeTemplateDTO>>;
getTemplateListUsingGET(advertiserId: number, type: 'DCO' | 'HYBRID_STATIC_AD' | 'HYBRID_DYNAMIC_AD', filters?: string, hybridSupportType?: 'IMAGE' | 'VIDEO', isPlacebo?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiListResponseCreativeTemplateDTO>>;
/**
* Api to reschedule a creative sets
*
* @param creativeSetRescheduleRequest creativeSetRescheduleRequest
* @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.
*/
rescheduleUsingPOST(creativeSetRescheduleRequest: CreativeSetRescheduleRequest, id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectResponseMessage>;
rescheduleUsingPOST(creativeSetRescheduleRequest: CreativeSetRescheduleRequest, id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectResponseMessage>>;
rescheduleUsingPOST(creativeSetRescheduleRequest: CreativeSetRescheduleRequest, id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectResponseMessage>>;
/**
* Bulk update creatives under a Creative Set to test mode
*
* @param creativeSetId creativeSetId
* @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.
*/
updateCreativeSetTestModeUsingPOST(creativeSetId: number, enabled: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectListCreativeEntity>;
updateCreativeSetTestModeUsingPOST(creativeSetId: number, enabled: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectListCreativeEntity>>;
updateCreativeSetTestModeUsingPOST(creativeSetId: number, enabled: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectListCreativeEntity>>;
/**
* Api to update creative sets
*
* @param creativeSetRequest creativeSetRequest
* @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.
*/
updateUsingPOST1(creativeSetRequest: CreativeSetRequest, id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCreativeSetResponse>;
updateUsingPOST1(creativeSetRequest: CreativeSetRequest, id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCreativeSetResponse>>;
updateUsingPOST1(creativeSetRequest: CreativeSetRequest, id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCreativeSetResponse>>;
static ɵfac: i0.ɵɵFactoryDeclaration<CreativeSetsControllerService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<CreativeSetsControllerService>;
}