/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Certification Campaign Filters * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * Campaign Filter Details * @export * @interface CampaignFilterDetails */ export interface CampaignFilterDetails { /** * The unique ID of the campaign filter * @type {string} * @memberof CampaignFilterDetails */ 'id': string; /** * Campaign filter name. * @type {string} * @memberof CampaignFilterDetails */ 'name': string; /** * Campaign filter description. * @type {string} * @memberof CampaignFilterDetails */ 'description'?: string; /** * Owner of the filter. This field automatically populates at creation time with the current user. * @type {string} * @memberof CampaignFilterDetails */ 'owner': string | null; /** * Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. * @type {string} * @memberof CampaignFilterDetails */ 'mode': CampaignFilterDetailsModeEnum; /** * List of criteria. * @type {Array} * @memberof CampaignFilterDetails */ 'criteriaList'?: Array; /** * If true, the filter is created by the system. If false, the filter is created by a user. * @type {boolean} * @memberof CampaignFilterDetails */ 'isSystemFilter': boolean; } export const CampaignFilterDetailsModeEnum = { Inclusion: 'INCLUSION', Exclusion: 'EXCLUSION' } as const; export type CampaignFilterDetailsModeEnum = typeof CampaignFilterDetailsModeEnum[keyof typeof CampaignFilterDetailsModeEnum]; /** * * @export * @interface CampaignFilterDetailsCriteriaListInner */ export interface CampaignFilterDetailsCriteriaListInner { /** * * @type {CriteriaType} * @memberof CampaignFilterDetailsCriteriaListInner */ 'type': CriteriaType; /** * * @type {Operation} * @memberof CampaignFilterDetailsCriteriaListInner */ 'operation'?: Operation | null; /** * Specified key from the type of criteria. * @type {string} * @memberof CampaignFilterDetailsCriteriaListInner */ 'property': string | null; /** * Value for the specified key from the type of criteria. * @type {string} * @memberof CampaignFilterDetailsCriteriaListInner */ 'value': string | null; /** * If true, the filter will negate the result of the criteria. * @type {boolean} * @memberof CampaignFilterDetailsCriteriaListInner */ 'negateResult'?: boolean; /** * If true, the filter will short circuit the evaluation of the criteria. * @type {boolean} * @memberof CampaignFilterDetailsCriteriaListInner */ 'shortCircuit'?: boolean; /** * If true, the filter will record child matches for the criteria. * @type {boolean} * @memberof CampaignFilterDetailsCriteriaListInner */ 'recordChildMatches'?: boolean; /** * The unique ID of the criteria. * @type {string} * @memberof CampaignFilterDetailsCriteriaListInner */ 'id'?: string | null; /** * If this value is true, then matched items will not only be excluded from the campaign, they will also not have archived certification items created. Such items will not appear in the exclusion report. * @type {boolean} * @memberof CampaignFilterDetailsCriteriaListInner */ 'suppressMatchedItems'?: boolean; /** * List of child criteria. * @type {Array} * @memberof CampaignFilterDetailsCriteriaListInner */ 'children'?: Array; } /** * Type of the criteria in the filter. The `COMPOSITE` filter can contain multiple filters in an AND/OR relationship. * @export * @enum {string} */ export const CriteriaType = { Composite: 'COMPOSITE', Role: 'ROLE', Identity: 'IDENTITY', IdentityAttribute: 'IDENTITY_ATTRIBUTE', Entitlement: 'ENTITLEMENT', AccessProfile: 'ACCESS_PROFILE', Source: 'SOURCE', Account: 'ACCOUNT', AggregatedEntitlement: 'AGGREGATED_ENTITLEMENT', InvalidCertifiableEntity: 'INVALID_CERTIFIABLE_ENTITY', InvalidCertifiableBundle: 'INVALID_CERTIFIABLE_BUNDLE' } as const; export type CriteriaType = typeof CriteriaType[keyof typeof CriteriaType]; /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface ListCampaignFiltersV1200Response */ export interface ListCampaignFiltersV1200Response { /** * List of campaign filters. * @type {Array} * @memberof ListCampaignFiltersV1200Response */ 'items'?: Array; /** * Number of filters returned. * @type {number} * @memberof ListCampaignFiltersV1200Response */ 'count'?: number; } /** * * @export * @interface ListCampaignFiltersV1401Response */ export interface ListCampaignFiltersV1401Response { /** * A message describing the error * @type {any} * @memberof ListCampaignFiltersV1401Response */ 'error'?: any; } /** * * @export * @interface ListCampaignFiltersV1429Response */ export interface ListCampaignFiltersV1429Response { /** * A message describing the error * @type {any} * @memberof ListCampaignFiltersV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * Operation on a specific criteria * @export * @enum {string} */ export const Operation = { Equals: 'EQUALS', NotEquals: 'NOT_EQUALS', Contains: 'CONTAINS', StartsWith: 'STARTS_WITH', EndsWith: 'ENDS_WITH', And: 'AND', Or: 'OR' } as const; export type Operation = typeof Operation[keyof typeof Operation]; /** * CertificationCampaignFiltersApi - axios parameter creator * @export */ export const CertificationCampaignFiltersApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Use this API to create a campaign filter based on filter details and criteria. * @summary Create campaign filter * @param {CampaignFilterDetails} campaignFilterDetails * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCampaignFilterV1: async (campaignFilterDetails: CampaignFilterDetails, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'campaignFilterDetails' is not null or undefined assertParamExists('createCampaignFilterV1', 'campaignFilterDetails', campaignFilterDetails) const localVarPath = `/campaign-filters/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetails, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. * @summary Deletes campaign filters * @param {Array} requestBody A json list of IDs of campaign filters to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteCampaignFiltersV1: async (requestBody: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'requestBody' is not null or undefined assertParamExists('deleteCampaignFiltersV1', 'requestBody', requestBody) const localVarPath = `/campaign-filters/v1/delete`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(requestBody, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Retrieves information for an existing campaign filter using the filter\'s ID. * @summary Get campaign filter by id * @param {string} id The ID of the campaign filter to be retrieved. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCampaignFilterByIdV1: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('getCampaignFilterByIdV1', 'id', id) const localVarPath = `/campaign-filters/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. * @summary List campaign filters * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listCampaignFiltersV1: async (limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/campaign-filters/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (start !== undefined) { localVarQueryParameter['start'] = start; } if (includeSystemFilters !== undefined) { localVarQueryParameter['includeSystemFilters'] = includeSystemFilters; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Updates an existing campaign filter using the filter\'s ID. * @summary Updates a campaign filter * @param {string} id The ID of the campaign filter being modified. * @param {CampaignFilterDetails} campaignFilterDetails A campaign filter details with updated field values. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateCampaignFilterV1: async (id: string, campaignFilterDetails: CampaignFilterDetails, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'id' is not null or undefined assertParamExists('updateCampaignFilterV1', 'id', id) // verify required parameter 'campaignFilterDetails' is not null or undefined assertParamExists('updateCampaignFilterV1', 'campaignFilterDetails', campaignFilterDetails) const localVarPath = `/campaign-filters/v1/{id}` .replace(`{${"id"}}`, encodeURIComponent(String(id))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(campaignFilterDetails, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * CertificationCampaignFiltersApi - functional programming interface * @export */ export const CertificationCampaignFiltersApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = CertificationCampaignFiltersApiAxiosParamCreator(configuration) return { /** * Use this API to create a campaign filter based on filter details and criteria. * @summary Create campaign filter * @param {CampaignFilterDetails} campaignFilterDetails * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createCampaignFilterV1(campaignFilterDetails: CampaignFilterDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createCampaignFilterV1(campaignFilterDetails, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.createCampaignFilterV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. * @summary Deletes campaign filters * @param {Array} requestBody A json list of IDs of campaign filters to delete. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteCampaignFiltersV1(requestBody: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCampaignFiltersV1(requestBody, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.deleteCampaignFiltersV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Retrieves information for an existing campaign filter using the filter\'s ID. * @summary Get campaign filter by id * @param {string} id The ID of the campaign filter to be retrieved. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getCampaignFilterByIdV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getCampaignFilterByIdV1(id, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.getCampaignFilterByIdV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. * @summary List campaign filters * @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {number} [start] Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listCampaignFiltersV1(limit?: number, start?: number, includeSystemFilters?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.listCampaignFiltersV1(limit, start, includeSystemFilters, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.listCampaignFiltersV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Updates an existing campaign filter using the filter\'s ID. * @summary Updates a campaign filter * @param {string} id The ID of the campaign filter being modified. * @param {CampaignFilterDetails} campaignFilterDetails A campaign filter details with updated field values. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateCampaignFilterV1(id: string, campaignFilterDetails: CampaignFilterDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateCampaignFilterV1(id, campaignFilterDetails, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CertificationCampaignFiltersApi.updateCampaignFilterV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * CertificationCampaignFiltersApi - factory interface * @export */ export const CertificationCampaignFiltersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = CertificationCampaignFiltersApiFp(configuration) return { /** * Use this API to create a campaign filter based on filter details and criteria. * @summary Create campaign filter * @param {CertificationCampaignFiltersApiCreateCampaignFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createCampaignFilterV1(requestParameters: CertificationCampaignFiltersApiCreateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createCampaignFilterV1(requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(axios, basePath)); }, /** * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. * @summary Deletes campaign filters * @param {CertificationCampaignFiltersApiDeleteCampaignFiltersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteCampaignFiltersV1(requestParameters: CertificationCampaignFiltersApiDeleteCampaignFiltersV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteCampaignFiltersV1(requestParameters.requestBody, axiosOptions).then((request) => request(axios, basePath)); }, /** * Retrieves information for an existing campaign filter using the filter\'s ID. * @summary Get campaign filter by id * @param {CertificationCampaignFiltersApiGetCampaignFilterByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getCampaignFilterByIdV1(requestParameters: CertificationCampaignFiltersApiGetCampaignFilterByIdV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getCampaignFilterByIdV1(requestParameters.id, axiosOptions).then((request) => request(axios, basePath)); }, /** * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. * @summary List campaign filters * @param {CertificationCampaignFiltersApiListCampaignFiltersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listCampaignFiltersV1(requestParameters: CertificationCampaignFiltersApiListCampaignFiltersV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.listCampaignFiltersV1(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(axios, basePath)); }, /** * Updates an existing campaign filter using the filter\'s ID. * @summary Updates a campaign filter * @param {CertificationCampaignFiltersApiUpdateCampaignFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateCampaignFilterV1(requestParameters: CertificationCampaignFiltersApiUpdateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateCampaignFilterV1(requestParameters.id, requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createCampaignFilterV1 operation in CertificationCampaignFiltersApi. * @export * @interface CertificationCampaignFiltersApiCreateCampaignFilterV1Request */ export interface CertificationCampaignFiltersApiCreateCampaignFilterV1Request { /** * * @type {CampaignFilterDetails} * @memberof CertificationCampaignFiltersApiCreateCampaignFilterV1 */ readonly campaignFilterDetails: CampaignFilterDetails } /** * Request parameters for deleteCampaignFiltersV1 operation in CertificationCampaignFiltersApi. * @export * @interface CertificationCampaignFiltersApiDeleteCampaignFiltersV1Request */ export interface CertificationCampaignFiltersApiDeleteCampaignFiltersV1Request { /** * A json list of IDs of campaign filters to delete. * @type {Array} * @memberof CertificationCampaignFiltersApiDeleteCampaignFiltersV1 */ readonly requestBody: Array } /** * Request parameters for getCampaignFilterByIdV1 operation in CertificationCampaignFiltersApi. * @export * @interface CertificationCampaignFiltersApiGetCampaignFilterByIdV1Request */ export interface CertificationCampaignFiltersApiGetCampaignFilterByIdV1Request { /** * The ID of the campaign filter to be retrieved. * @type {string} * @memberof CertificationCampaignFiltersApiGetCampaignFilterByIdV1 */ readonly id: string } /** * Request parameters for listCampaignFiltersV1 operation in CertificationCampaignFiltersApi. * @export * @interface CertificationCampaignFiltersApiListCampaignFiltersV1Request */ export interface CertificationCampaignFiltersApiListCampaignFiltersV1Request { /** * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CertificationCampaignFiltersApiListCampaignFiltersV1 */ readonly limit?: number /** * Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {number} * @memberof CertificationCampaignFiltersApiListCampaignFiltersV1 */ readonly start?: number /** * If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. * @type {boolean} * @memberof CertificationCampaignFiltersApiListCampaignFiltersV1 */ readonly includeSystemFilters?: boolean } /** * Request parameters for updateCampaignFilterV1 operation in CertificationCampaignFiltersApi. * @export * @interface CertificationCampaignFiltersApiUpdateCampaignFilterV1Request */ export interface CertificationCampaignFiltersApiUpdateCampaignFilterV1Request { /** * The ID of the campaign filter being modified. * @type {string} * @memberof CertificationCampaignFiltersApiUpdateCampaignFilterV1 */ readonly id: string /** * A campaign filter details with updated field values. * @type {CampaignFilterDetails} * @memberof CertificationCampaignFiltersApiUpdateCampaignFilterV1 */ readonly campaignFilterDetails: CampaignFilterDetails } /** * CertificationCampaignFiltersApi - object-oriented interface * @export * @class CertificationCampaignFiltersApi * @extends {BaseAPI} */ export class CertificationCampaignFiltersApi extends BaseAPI { /** * Use this API to create a campaign filter based on filter details and criteria. * @summary Create campaign filter * @param {CertificationCampaignFiltersApiCreateCampaignFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationCampaignFiltersApi */ public createCampaignFilterV1(requestParameters: CertificationCampaignFiltersApiCreateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationCampaignFiltersApiFp(this.configuration).createCampaignFilterV1(requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. * @summary Deletes campaign filters * @param {CertificationCampaignFiltersApiDeleteCampaignFiltersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationCampaignFiltersApi */ public deleteCampaignFiltersV1(requestParameters: CertificationCampaignFiltersApiDeleteCampaignFiltersV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationCampaignFiltersApiFp(this.configuration).deleteCampaignFiltersV1(requestParameters.requestBody, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Retrieves information for an existing campaign filter using the filter\'s ID. * @summary Get campaign filter by id * @param {CertificationCampaignFiltersApiGetCampaignFilterByIdV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationCampaignFiltersApi */ public getCampaignFilterByIdV1(requestParameters: CertificationCampaignFiltersApiGetCampaignFilterByIdV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationCampaignFiltersApiFp(this.configuration).getCampaignFilterByIdV1(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. * @summary List campaign filters * @param {CertificationCampaignFiltersApiListCampaignFiltersV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationCampaignFiltersApi */ public listCampaignFiltersV1(requestParameters: CertificationCampaignFiltersApiListCampaignFiltersV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return CertificationCampaignFiltersApiFp(this.configuration).listCampaignFiltersV1(requestParameters.limit, requestParameters.start, requestParameters.includeSystemFilters, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Updates an existing campaign filter using the filter\'s ID. * @summary Updates a campaign filter * @param {CertificationCampaignFiltersApiUpdateCampaignFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof CertificationCampaignFiltersApi */ public updateCampaignFilterV1(requestParameters: CertificationCampaignFiltersApiUpdateCampaignFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { return CertificationCampaignFiltersApiFp(this.configuration).updateCampaignFilterV1(requestParameters.id, requestParameters.campaignFilterDetails, axiosOptions).then((request) => request(this.axios, this.basePath)); } }