@revxui/api-clients-ts
Version:
swagger client for @revxui/api-clients-ts
169 lines (168 loc) • 12.7 kB
TypeScript
import { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { ApiResponseObjectBudgetStatsDTO } from '../model/apiResponseObjectBudgetStatsDTO';
import { ApiResponseObjectCampaignDTO } from '../model/apiResponseObjectCampaignDTO';
import { ApiResponseObjectCampaignDTOList } from '../model/apiResponseObjectCampaignDTOList';
import { ApiResponseObjectListCampaignDTO } from '../model/apiResponseObjectListCampaignDTO';
import { ApiResponseObjectMapintResponseMessage } from '../model/apiResponseObjectMapintResponseMessage';
import { ApiResponseObjectboolean } from '../model/apiResponseObjectboolean';
import { ApiResponseObjectstring } from '../model/apiResponseObjectstring';
import { CampaignDTO } from '../model/campaignDTO';
import { DuplicateCampaignStrategyRequestDTO } from '../model/duplicateCampaignStrategyRequestDTO';
import { IncrementalityReportDTO } from '../model/incrementalityReportDTO';
import { IncrementalityResponse } from '../model/incrementalityResponse';
import { Configuration } from '../configuration';
import * as i0 from "@angular/core";
export declare class CampaignControllerService {
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 activate Lists of Campaigns 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.
*/
activateCampaignUsingPOST(id: string, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectMapintResponseMessage>;
activateCampaignUsingPOST(id: string, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectMapintResponseMessage>>;
activateCampaignUsingPOST(id: string, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectMapintResponseMessage>>;
/**
* Api to create Campaign
*
* @param campaign campaign
* @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.
*/
createCampaignUsingPOST(campaign: CampaignDTO, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCampaignDTO>;
createCampaignUsingPOST(campaign: CampaignDTO, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCampaignDTO>>;
createCampaignUsingPOST(campaign: CampaignDTO, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCampaignDTO>>;
/**
* Api to deactivate Lists of Campaigns 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.
*/
deactivateCampaignUsingPOST(id: string, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectMapintResponseMessage>;
deactivateCampaignUsingPOST(id: string, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectMapintResponseMessage>>;
deactivateCampaignUsingPOST(id: string, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectMapintResponseMessage>>;
/**
* Api to Create duplicate Campaign
*
* @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.
*/
duplicateCampaignUsingPOST(dto: DuplicateCampaignStrategyRequestDTO, id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectstring>;
duplicateCampaignUsingPOST(dto: DuplicateCampaignStrategyRequestDTO, id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectstring>>;
duplicateCampaignUsingPOST(dto: DuplicateCampaignStrategyRequestDTO, id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectstring>>;
/**
* Api to get All Campaign for given Adv Id
*
* @param advertiser_id advertiser_id
* @param refresh refresh
* @param reqId request id
* @param search search
* @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.
*/
getAllCampaignUsingGET(advertiser_id: number, refresh?: boolean, reqId?: string, search?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectListCampaignDTO>;
getAllCampaignUsingGET(advertiser_id: number, refresh?: boolean, reqId?: string, search?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectListCampaignDTO>>;
getAllCampaignUsingGET(advertiser_id: number, refresh?: boolean, reqId?: string, search?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectListCampaignDTO>>;
/**
* API to get consumed budget statistics for a campaign
*
* @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.
*/
getCampaignBudgetStatsUsingGET(id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectBudgetStatsDTO>;
getCampaignBudgetStatsUsingGET(id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectBudgetStatsDTO>>;
getCampaignBudgetStatsUsingGET(id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectBudgetStatsDTO>>;
/**
* Api to get Campaign by Id
*
* @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.
*/
getCampaignByIdUsingGET(id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCampaignDTO>;
getCampaignByIdUsingGET(id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCampaignDTO>>;
getCampaignByIdUsingGET(id: number, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCampaignDTO>>;
/**
* Api to get Campaigns by Ids
*
* @param campaignIds campaignIds
* @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.
*/
getCampaignsByIdsUsingPOST(campaignIds: Array<number>, refresh?: boolean, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCampaignDTOList>;
getCampaignsByIdsUsingPOST(campaignIds: Array<number>, refresh?: boolean, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCampaignDTOList>>;
getCampaignsByIdsUsingPOST(campaignIds: Array<number>, refresh?: boolean, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCampaignDTOList>>;
/**
* Api to fetch incrementality report
*
* @param incrementalityReportDTO incrementalityReportDTO
* @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.
*/
incrementalityReportUsingPOST(incrementalityReportDTO: IncrementalityReportDTO, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<IncrementalityResponse>;
incrementalityReportUsingPOST(incrementalityReportDTO: IncrementalityReportDTO, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<IncrementalityResponse>>;
incrementalityReportUsingPOST(incrementalityReportDTO: IncrementalityReportDTO, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<IncrementalityResponse>>;
/**
* Api to update Campaign
*
* @param campaign campaign
* @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.
*/
updateCampaignUsingPOST(campaign: CampaignDTO, id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectCampaignDTO>;
updateCampaignUsingPOST(campaign: CampaignDTO, id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectCampaignDTO>>;
updateCampaignUsingPOST(campaign: CampaignDTO, id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectCampaignDTO>>;
/**
* Api to validate Campaign before Cloning
*
* @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.
*/
validateCloneCampaignUsingPOST(dto: DuplicateCampaignStrategyRequestDTO, id: number, reqId?: string, token?: string, observe?: 'body', reportProgress?: boolean): Observable<ApiResponseObjectboolean>;
validateCloneCampaignUsingPOST(dto: DuplicateCampaignStrategyRequestDTO, id: number, reqId?: string, token?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ApiResponseObjectboolean>>;
validateCloneCampaignUsingPOST(dto: DuplicateCampaignStrategyRequestDTO, id: number, reqId?: string, token?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ApiResponseObjectboolean>>;
static ɵfac: i0.ɵɵFactoryDeclaration<CampaignControllerService, [null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<CampaignControllerService>;
}