/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Access Model Metadata * 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'; /** * * @export * @interface AccessModelMetadataBulkUpdateResponse */ export interface AccessModelMetadataBulkUpdateResponse { /** * ID of the task which is executing the bulk update. * @type {string} * @memberof AccessModelMetadataBulkUpdateResponse */ 'id'?: string; /** * Type of the bulk update object. * @type {string} * @memberof AccessModelMetadataBulkUpdateResponse */ 'type'?: string; /** * The status of the bulk update request, only list unfinished request\'s status. * @type {string} * @memberof AccessModelMetadataBulkUpdateResponse */ 'status'?: AccessModelMetadataBulkUpdateResponseStatusEnum; /** * Time when the bulk update request was created * @type {string} * @memberof AccessModelMetadataBulkUpdateResponse */ 'created'?: string; } export const AccessModelMetadataBulkUpdateResponseStatusEnum = { Created: 'CREATED', PreProcess: 'PRE_PROCESS', PreProcessCompleted: 'PRE_PROCESS_COMPLETED', PostProcess: 'POST_PROCESS', Completed: 'COMPLETED', ChunkPending: 'CHUNK_PENDING', ChunkProcessing: 'CHUNK_PROCESSING', ReProcessing: 'RE_PROCESSING', PreProcessFailed: 'PRE_PROCESS_FAILED', Failed: 'FAILED' } as const; export type AccessModelMetadataBulkUpdateResponseStatusEnum = typeof AccessModelMetadataBulkUpdateResponseStatusEnum[keyof typeof AccessModelMetadataBulkUpdateResponseStatusEnum]; /** * Enum representing the currently available query languages for aggregations, which are used to perform calculations or groupings on search results. Additional values may be added in the future without notice. * @export * @enum {string} */ export const AggregationType = { Dsl: 'DSL', Sailpoint: 'SAILPOINT' } as const; export type AggregationType = typeof AggregationType[keyof typeof AggregationType]; /** * * @export * @interface Aggregations */ export interface Aggregations { /** * * @type {NestedAggregation} * @memberof Aggregations */ 'nested'?: NestedAggregation; /** * * @type {MetricAggregation} * @memberof Aggregations */ 'metric'?: MetricAggregation; /** * * @type {FilterAggregation} * @memberof Aggregations */ 'filter'?: FilterAggregation; /** * * @type {BucketAggregation} * @memberof Aggregations */ 'bucket'?: BucketAggregation; } /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface AttributeDTO */ export interface AttributeDTO { /** * Technical name of the Attribute. This is unique and cannot be changed after creation. * @type {string} * @memberof AttributeDTO */ 'key'?: string; /** * The display name of the key. * @type {string} * @memberof AttributeDTO */ 'name'?: string; /** * Indicates whether the attribute can have multiple values. * @type {boolean} * @memberof AttributeDTO */ 'multiselect'?: boolean; /** * The status of the Attribute. * @type {string} * @memberof AttributeDTO */ 'status'?: string; /** * The type of the Attribute. This can be either \"custom\" or \"governance\". * @type {string} * @memberof AttributeDTO */ 'type'?: string; /** * An array of object types this attributes values can be applied to. Possible values are \"all\" or \"entitlement\". Value \"all\" means this attribute can be used with all object types that are supported. * @type {Array} * @memberof AttributeDTO */ 'objectTypes'?: Array | null; /** * The description of the Attribute. * @type {string} * @memberof AttributeDTO */ 'description'?: string; /** * * @type {Array} * @memberof AttributeDTO */ 'values'?: Array | null; } /** * * @export * @interface AttributeValueDTO */ export interface AttributeValueDTO { /** * Technical name of the Attribute value. This is unique and cannot be changed after creation. * @type {string} * @memberof AttributeValueDTO */ 'value'?: string; /** * The display name of the Attribute value. * @type {string} * @memberof AttributeValueDTO */ 'name'?: string; /** * The status of the Attribute value. * @type {string} * @memberof AttributeValueDTO */ 'status'?: string; } /** * * @export * @interface Bound */ export interface Bound { /** * The value of the range\'s endpoint. * @type {string} * @memberof Bound */ 'value': string; /** * Indicates if the endpoint is included in the range. * @type {boolean} * @memberof Bound */ 'inclusive'?: boolean; } /** * The bucket to group the results of the aggregation query by. * @export * @interface BucketAggregation */ export interface BucketAggregation { /** * The name of the bucket aggregate to be included in the result. * @type {string} * @memberof BucketAggregation */ 'name': string; /** * * @type {BucketType} * @memberof BucketAggregation */ 'type'?: BucketType; /** * The field to bucket on. Prefix the field name with \'@\' to reference a nested object. * @type {string} * @memberof BucketAggregation */ 'field': string; /** * Maximum number of buckets to include. * @type {number} * @memberof BucketAggregation */ 'size'?: number; /** * Minimum number of documents a bucket should have. * @type {number} * @memberof BucketAggregation */ 'minDocCount'?: number; } /** * Enum representing the currently supported bucket aggregation types. Additional values may be added in the future without notice. * @export * @enum {string} */ export const BucketType = { Terms: 'TERMS' } as const; export type BucketType = typeof BucketType[keyof typeof BucketType]; /** * * @export * @interface BulkUpdateAMMKeyValueInner */ export interface BulkUpdateAMMKeyValueInner { /** * the key of metadata attribute * @type {string} * @memberof BulkUpdateAMMKeyValueInner */ 'attribute': string; /** * the values of attribute to be updated * @type {Array} * @memberof BulkUpdateAMMKeyValueInner */ 'values': Array | null; } /** * * @export * @interface EntitlementAttributeBulkUpdateFilterRequest */ export interface EntitlementAttributeBulkUpdateFilterRequest { /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* * @type {string} * @memberof EntitlementAttributeBulkUpdateFilterRequest */ 'filters'?: string; /** * Operation to perform on the attributes in the bulk update request. * @type {string} * @memberof EntitlementAttributeBulkUpdateFilterRequest */ 'operation'?: EntitlementAttributeBulkUpdateFilterRequestOperationEnum; /** * The choice of update scope. * @type {string} * @memberof EntitlementAttributeBulkUpdateFilterRequest */ 'replaceScope'?: EntitlementAttributeBulkUpdateFilterRequestReplaceScopeEnum; /** * The metadata to be updated, including attribute and values. * @type {Array} * @memberof EntitlementAttributeBulkUpdateFilterRequest */ 'values'?: Array; } export const EntitlementAttributeBulkUpdateFilterRequestOperationEnum = { Add: 'ADD', Remove: 'REMOVE', Replace: 'REPLACE' } as const; export type EntitlementAttributeBulkUpdateFilterRequestOperationEnum = typeof EntitlementAttributeBulkUpdateFilterRequestOperationEnum[keyof typeof EntitlementAttributeBulkUpdateFilterRequestOperationEnum]; export const EntitlementAttributeBulkUpdateFilterRequestReplaceScopeEnum = { All: 'ALL', Attribute: 'ATTRIBUTE' } as const; export type EntitlementAttributeBulkUpdateFilterRequestReplaceScopeEnum = typeof EntitlementAttributeBulkUpdateFilterRequestReplaceScopeEnum[keyof typeof EntitlementAttributeBulkUpdateFilterRequestReplaceScopeEnum]; /** * * @export * @interface EntitlementAttributeBulkUpdateIdsRequest */ export interface EntitlementAttributeBulkUpdateIdsRequest { /** * List of entitlement IDs to update. * @type {Array} * @memberof EntitlementAttributeBulkUpdateIdsRequest */ 'entitlements'?: Array; /** * Operation to perform on the attributes in the bulk update request. * @type {string} * @memberof EntitlementAttributeBulkUpdateIdsRequest */ 'operation'?: EntitlementAttributeBulkUpdateIdsRequestOperationEnum; /** * The choice of update scope. * @type {string} * @memberof EntitlementAttributeBulkUpdateIdsRequest */ 'replaceScope'?: EntitlementAttributeBulkUpdateIdsRequestReplaceScopeEnum; /** * The metadata to be updated, including attribute and values. * @type {Array} * @memberof EntitlementAttributeBulkUpdateIdsRequest */ 'values'?: Array; } export const EntitlementAttributeBulkUpdateIdsRequestOperationEnum = { Add: 'ADD', Remove: 'REMOVE', Replace: 'REPLACE' } as const; export type EntitlementAttributeBulkUpdateIdsRequestOperationEnum = typeof EntitlementAttributeBulkUpdateIdsRequestOperationEnum[keyof typeof EntitlementAttributeBulkUpdateIdsRequestOperationEnum]; export const EntitlementAttributeBulkUpdateIdsRequestReplaceScopeEnum = { All: 'ALL', Attribute: 'ATTRIBUTE' } as const; export type EntitlementAttributeBulkUpdateIdsRequestReplaceScopeEnum = typeof EntitlementAttributeBulkUpdateIdsRequestReplaceScopeEnum[keyof typeof EntitlementAttributeBulkUpdateIdsRequestReplaceScopeEnum]; /** * * @export * @interface EntitlementAttributeBulkUpdateQueryRequest */ export interface EntitlementAttributeBulkUpdateQueryRequest { /** * * @type {Search} * @memberof EntitlementAttributeBulkUpdateQueryRequest */ 'query'?: Search; /** * Operation to perform on the attributes in the bulk update request. * @type {string} * @memberof EntitlementAttributeBulkUpdateQueryRequest */ 'operation'?: EntitlementAttributeBulkUpdateQueryRequestOperationEnum; /** * The choice of update scope. * @type {string} * @memberof EntitlementAttributeBulkUpdateQueryRequest */ 'replaceScope'?: EntitlementAttributeBulkUpdateQueryRequestReplaceScopeEnum; /** * The metadata to be updated, including attribute and values. * @type {Array} * @memberof EntitlementAttributeBulkUpdateQueryRequest */ 'values'?: Array; } export const EntitlementAttributeBulkUpdateQueryRequestOperationEnum = { Add: 'ADD', Remove: 'REMOVE', Replace: 'REPLACE' } as const; export type EntitlementAttributeBulkUpdateQueryRequestOperationEnum = typeof EntitlementAttributeBulkUpdateQueryRequestOperationEnum[keyof typeof EntitlementAttributeBulkUpdateQueryRequestOperationEnum]; export const EntitlementAttributeBulkUpdateQueryRequestReplaceScopeEnum = { All: 'ALL', Attribute: 'ATTRIBUTE' } as const; export type EntitlementAttributeBulkUpdateQueryRequestReplaceScopeEnum = typeof EntitlementAttributeBulkUpdateQueryRequestReplaceScopeEnum[keyof typeof EntitlementAttributeBulkUpdateQueryRequestReplaceScopeEnum]; /** * * @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 Filter */ export interface Filter { /** * * @type {FilterType} * @memberof Filter */ 'type'?: FilterType; /** * * @type {Range} * @memberof Filter */ 'range'?: Range; /** * The terms to be filtered. * @type {Array} * @memberof Filter */ 'terms'?: Array; /** * Indicates if the filter excludes results. * @type {boolean} * @memberof Filter */ 'exclude'?: boolean; } /** * An additional filter to constrain the results of the search query. * @export * @interface FilterAggregation */ export interface FilterAggregation { /** * The name of the filter aggregate to be included in the result. * @type {string} * @memberof FilterAggregation */ 'name': string; /** * * @type {SearchFilterType} * @memberof FilterAggregation */ 'type'?: SearchFilterType; /** * The search field to apply the filter to. Prefix the field name with \'@\' to reference a nested object. * @type {string} * @memberof FilterAggregation */ 'field': string; /** * The value to filter on. * @type {string} * @memberof FilterAggregation */ 'value': string; } /** * Enum representing the currently supported filter types. Additional values may be added in the future without notice. * @export * @enum {string} */ export const FilterType = { Exists: 'EXISTS', Range: 'RANGE', Terms: 'TERMS' } as const; export type FilterType = typeof FilterType[keyof typeof FilterType]; /** * Enum representing the currently supported indices. Additional values may be added in the future without notice. * @export * @enum {string} */ export const Index = { Accessprofiles: 'accessprofiles', Accountactivities: 'accountactivities', Entitlements: 'entitlements', Events: 'events', Identities: 'identities', Roles: 'roles', Star: '*' } as const; export type Index = typeof Index[keyof typeof Index]; /** * Inner Hit query object that will cause the specified nested type to be returned as the result matching the supplied query. * @export * @interface InnerHit */ export interface InnerHit { /** * The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. * @type {string} * @memberof InnerHit */ 'query': string; /** * The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document \"nested\" within another document. For example, an identity can have nested documents for access, accounts, and apps. * @type {string} * @memberof InnerHit */ 'type': string; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export const JsonPatchOperationOpEnum = { Add: 'add', Remove: 'remove', Replace: 'replace', Move: 'move', Copy: 'copy', Test: 'test' } as const; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * * @export * @interface ListAccessModelMetadataAttributeV1401Response */ export interface ListAccessModelMetadataAttributeV1401Response { /** * A message describing the error * @type {any} * @memberof ListAccessModelMetadataAttributeV1401Response */ 'error'?: any; } /** * * @export * @interface ListAccessModelMetadataAttributeV1429Response */ export interface ListAccessModelMetadataAttributeV1429Response { /** * A message describing the error * @type {any} * @memberof ListAccessModelMetadataAttributeV1429Response */ '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]; /** * The calculation done on the results of the query * @export * @interface MetricAggregation */ export interface MetricAggregation { /** * The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. * @type {string} * @memberof MetricAggregation */ 'name': string; /** * * @type {MetricType} * @memberof MetricAggregation */ 'type'?: MetricType; /** * The field the calculation is performed on. Prefix the field name with \'@\' to reference a nested object. * @type {string} * @memberof MetricAggregation */ 'field': string; } /** * Enum representing the currently supported metric aggregation types. Additional values may be added in the future without notice. * @export * @enum {string} */ export const MetricType = { Count: 'COUNT', UniqueCount: 'UNIQUE_COUNT', Avg: 'AVG', Sum: 'SUM', Median: 'MEDIAN', Min: 'MIN', Max: 'MAX' } as const; export type MetricType = typeof MetricType[keyof typeof MetricType]; /** * The nested aggregation object. * @export * @interface NestedAggregation */ export interface NestedAggregation { /** * The name of the nested aggregate to be included in the result. * @type {string} * @memberof NestedAggregation */ 'name': string; /** * The type of the nested object. * @type {string} * @memberof NestedAggregation */ 'type': string; } /** * Query parameters used to construct an Elasticsearch query object. * @export * @interface Query */ export interface Query { /** * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. * @type {string} * @memberof Query */ 'query'?: string; /** * The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of \"a*\" to be applied to \"name\", \"firstName\", and the \"source.name\". The response will include all results matching the \"a*\" query found in those three fields. A field\'s availability depends on the indices being searched. For example, if you are searching \"identities\", you can apply your search to the \"firstName\" field, but you couldn\'t use \"firstName\" with a search on \"access profiles\". Refer to the response schema for the respective lists of available fields. * @type {string} * @memberof Query */ 'fields'?: string; /** * The time zone to be applied to any range query related to dates. * @type {string} * @memberof Query */ 'timeZone'?: string; /** * * @type {InnerHit} * @memberof Query */ 'innerHit'?: InnerHit; } /** * Allows the query results to be filtered by specifying a list of fields to include and/or exclude from the result documents. * @export * @interface QueryResultFilter */ export interface QueryResultFilter { /** * The list of field names to include in the result documents. * @type {Array} * @memberof QueryResultFilter */ 'includes'?: Array; /** * The list of field names to exclude from the result documents. * @type {Array} * @memberof QueryResultFilter */ 'excludes'?: Array; } /** * The type of query to use. By default, the `SAILPOINT` query type is used, which requires the `query` object to be defined in the request body. To use the `queryDsl` or `typeAheadQuery` objects in the request, you must set the type to `DSL` or `TYPEAHEAD` accordingly. Additional values may be added in the future without notice. * @export * @enum {string} */ export const QueryType = { Dsl: 'DSL', Sailpoint: 'SAILPOINT', Text: 'TEXT', Typeahead: 'TYPEAHEAD' } as const; export type QueryType = typeof QueryType[keyof typeof QueryType]; /** * The range of values to be filtered. * @export * @interface Range */ export interface Range { /** * * @type {Bound} * @memberof Range */ 'lower'?: Bound; /** * * @type {Bound} * @memberof Range */ 'upper'?: Bound; } /** * * @export * @interface Search */ export interface Search { /** * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. * @type {Array} * @memberof Search */ 'indices'?: Array; /** * * @type {QueryType} * @memberof Search */ 'queryType'?: QueryType; /** * * @type {string} * @memberof Search */ 'queryVersion'?: string; /** * * @type {Query} * @memberof Search */ 'query'?: Query; /** * The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. * @type {object} * @memberof Search */ 'queryDsl'?: object; /** * * @type {TextQuery} * @memberof Search */ 'textQuery'?: TextQuery; /** * * @type {TypeAheadQuery} * @memberof Search */ 'typeAheadQuery'?: TypeAheadQuery; /** * Indicates whether nested objects from returned search results should be included. * @type {boolean} * @memberof Search */ 'includeNested'?: boolean; /** * * @type {QueryResultFilter} * @memberof Search */ 'queryResultFilter'?: QueryResultFilter; /** * * @type {AggregationType} * @memberof Search */ 'aggregationType'?: AggregationType; /** * * @type {string} * @memberof Search */ 'aggregationsVersion'?: string; /** * The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. * @type {object} * @memberof Search */ 'aggregationsDsl'?: object; /** * * @type {SearchAggregationSpecification} * @memberof Search */ 'aggregations'?: SearchAggregationSpecification; /** * The fields to be used to sort the search results. Use + or - to specify the sort direction. * @type {Array} * @memberof Search */ 'sort'?: Array; /** * Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [\"displayName\", \"id\"]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is \"John Doe\", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [\"John Doe\",\"2c91808375d8e80a0175e1f88a575221\"] * @type {Array} * @memberof Search */ 'searchAfter'?: Array; /** * The filters to be applied for each filtered field name. * @type {{ [key: string]: Filter; }} * @memberof Search */ 'filters'?: { [key: string]: Filter; }; } /** * * @export * @interface SearchAggregationSpecification */ export interface SearchAggregationSpecification { /** * * @type {NestedAggregation} * @memberof SearchAggregationSpecification */ 'nested'?: NestedAggregation; /** * * @type {MetricAggregation} * @memberof SearchAggregationSpecification */ 'metric'?: MetricAggregation; /** * * @type {FilterAggregation} * @memberof SearchAggregationSpecification */ 'filter'?: FilterAggregation; /** * * @type {BucketAggregation} * @memberof SearchAggregationSpecification */ 'bucket'?: BucketAggregation; /** * * @type {SubSearchAggregationSpecification} * @memberof SearchAggregationSpecification */ 'subAggregation'?: SubSearchAggregationSpecification; } /** * Enum representing the currently supported filter aggregation types. Additional values may be added in the future without notice. * @export * @enum {string} */ export const SearchFilterType = { Term: 'TERM' } as const; export type SearchFilterType = typeof SearchFilterType[keyof typeof SearchFilterType]; /** * * @export * @interface SubSearchAggregationSpecification */ export interface SubSearchAggregationSpecification { /** * * @type {NestedAggregation} * @memberof SubSearchAggregationSpecification */ 'nested'?: NestedAggregation; /** * * @type {MetricAggregation} * @memberof SubSearchAggregationSpecification */ 'metric'?: MetricAggregation; /** * * @type {FilterAggregation} * @memberof SubSearchAggregationSpecification */ 'filter'?: FilterAggregation; /** * * @type {BucketAggregation} * @memberof SubSearchAggregationSpecification */ 'bucket'?: BucketAggregation; /** * * @type {Aggregations} * @memberof SubSearchAggregationSpecification */ 'subAggregation'?: Aggregations; } /** * Query parameters used to construct an Elasticsearch text query object. * @export * @interface TextQuery */ export interface TextQuery { /** * Words or characters that specify a particular thing to be searched for. * @type {Array} * @memberof TextQuery */ 'terms': Array; /** * The fields to be searched. * @type {Array} * @memberof TextQuery */ 'fields': Array; /** * Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. * @type {boolean} * @memberof TextQuery */ 'matchAny'?: boolean; /** * Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. * @type {boolean} * @memberof TextQuery */ 'contains'?: boolean; } /** * Query parameters used to construct an Elasticsearch type ahead query object. The typeAheadQuery performs a search for top values beginning with the typed values. For example, typing \"Jo\" results in top hits matching \"Jo.\" Typing \"Job\" results in top hits matching \"Job.\" * @export * @interface TypeAheadQuery */ export interface TypeAheadQuery { /** * The type ahead query string used to construct a phrase prefix match query. * @type {string} * @memberof TypeAheadQuery */ 'query': string; /** * The field on which to perform the type ahead search. * @type {string} * @memberof TypeAheadQuery */ 'field': string; /** * The nested type. * @type {string} * @memberof TypeAheadQuery */ 'nestedType'?: string; /** * The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. * @type {number} * @memberof TypeAheadQuery */ 'maxExpansions'?: number; /** * The max amount of records the search will return. * @type {number} * @memberof TypeAheadQuery */ 'size'?: number; /** * The sort order of the returned records. * @type {string} * @memberof TypeAheadQuery */ 'sort'?: string; /** * The flag that defines the sort type, by count or value. * @type {boolean} * @memberof TypeAheadQuery */ 'sortByValue'?: boolean; } /** * AccessModelMetadataApi - axios parameter creator * @export */ export const AccessModelMetadataApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * Create a new Access Model Metadata Attribute. * @summary Create access model metadata attribute * @param {AttributeDTO} attributeDTO Attribute to create * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAccessModelMetadataAttributeV1: async (attributeDTO: AttributeDTO, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'attributeDTO' is not null or undefined assertParamExists('createAccessModelMetadataAttributeV1', 'attributeDTO', attributeDTO) const localVarPath = `/access-model-metadata/v1/attributes`; // 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(attributeDTO, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Create a new value for an existing Access Model Metadata Attribute. * @summary Create access model metadata value * @param {string} key Technical name of the Attribute. * @param {AttributeValueDTO} attributeValueDTO Attribute value to create * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAccessModelMetadataAttributeValueV1: async (key: string, attributeValueDTO: AttributeValueDTO, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('createAccessModelMetadataAttributeValueV1', 'key', key) // verify required parameter 'attributeValueDTO' is not null or undefined assertParamExists('createAccessModelMetadataAttributeValueV1', 'attributeValueDTO', attributeValueDTO) const localVarPath = `/access-model-metadata/v1/attributes/{key}/values` .replace(`{${"key"}}`, encodeURIComponent(String(key))); // 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(attributeValueDTO, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get single Access Model Metadata Attribute * @summary Get access model metadata attribute * @param {string} key Technical name of the Attribute. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccessModelMetadataAttributeV1: async (key: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('getAccessModelMetadataAttributeV1', 'key', key) const localVarPath = `/access-model-metadata/v1/attributes/{key}` .replace(`{${"key"}}`, encodeURIComponent(String(key))); // 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, }; }, /** * Get single Access Model Metadata Attribute Value * @summary Get access model metadata value * @param {string} key Technical name of the Attribute. * @param {string} value Technical name of the Attribute value. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccessModelMetadataAttributeValueV1: async (key: string, value: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('getAccessModelMetadataAttributeValueV1', 'key', key) // verify required parameter 'value' is not null or undefined assertParamExists('getAccessModelMetadataAttributeValueV1', 'value', value) const localVarPath = `/access-model-metadata/v1/attributes/{key}/values/{value}` .replace(`{${"key"}}`, encodeURIComponent(String(key))) .replace(`{${"value"}}`, encodeURIComponent(String(value))); // 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, }; }, /** * Get a list of Access Model Metadata Attributes * @summary List access model metadata attributes * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** * @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 {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAccessModelMetadataAttributeV1: async (filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/access-model-metadata/v1/attributes`; // 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 (filters !== undefined) { localVarQueryParameter['filters'] = filters; } if (sorters !== undefined) { localVarQueryParameter['sorters'] = sorters; } if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } if (count !== undefined) { localVarQueryParameter['count'] = count; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Get a list of Access Model Metadata Attribute Values * @summary List access model metadata values * @param {string} key Technical name of the Attribute. * @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 {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAccessModelMetadataAttributeValueV1: async (key: string, limit?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('listAccessModelMetadataAttributeValueV1', 'key', key) const localVarPath = `/access-model-metadata/v1/attributes/{key}/values` .replace(`{${"key"}}`, encodeURIComponent(String(key))); // 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 (count !== undefined) { localVarQueryParameter['count'] = count; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** * @summary Update access model metadata attribute * @param {string} key Technical name of the Attribute. * @param {Array} jsonPatchOperation JSON Patch array to apply * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAccessModelMetadataAttributeV1: async (key: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('updateAccessModelMetadataAttributeV1', 'key', key) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('updateAccessModelMetadataAttributeV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/access-model-metadata/v1/attributes/{key}` .replace(`{${"key"}}`, encodeURIComponent(String(key))); // 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: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** * @summary Update access model metadata value * @param {string} key Technical name of the Attribute. * @param {string} value Technical name of the Attribute value. * @param {Array} jsonPatchOperation JSON Patch array to apply * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAccessModelMetadataAttributeValueV1: async (key: string, value: string, jsonPatchOperation: Array, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'key' is not null or undefined assertParamExists('updateAccessModelMetadataAttributeValueV1', 'key', key) // verify required parameter 'value' is not null or undefined assertParamExists('updateAccessModelMetadataAttributeValueV1', 'value', value) // verify required parameter 'jsonPatchOperation' is not null or undefined assertParamExists('updateAccessModelMetadataAttributeValueV1', 'jsonPatchOperation', jsonPatchOperation) const localVarPath = `/access-model-metadata/v1/attributes/{key}/values/{value}` .replace(`{${"key"}}`, encodeURIComponent(String(key))) .replace(`{${"value"}}`, encodeURIComponent(String(value))); // 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: 'PATCH', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; localVarHeaderParameter['Content-Type'] = 'application/json-patch+json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperation, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Bulk update Access Model Metadata Attribute Values using a filter * @summary Metadata Attribute update by filter * @param {EntitlementAttributeBulkUpdateFilterRequest} entitlementAttributeBulkUpdateFilterRequest Attribute metadata bulk update request body. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ updateAccessModelMetadataByFilterV1: async (entitlementAttributeBulkUpdateFilterRequest: EntitlementAttributeBulkUpdateFilterRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'entitlementAttributeBulkUpdateFilterRequest' is not null or undefined assertParamExists('updateAccessModelMetadataByFilterV1', 'entitlementAttributeBulkUpdateFilterRequest', entitlementAttributeBulkUpdateFilterRequest) const localVarPath = `/access-model-metadata/v1/bulk-update/filter`; // 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(entitlementAttributeBulkUpdateFilterRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Bulk update Access Model Metadata Attribute Values using ids. * @summary Metadata Attribute update by ids * @param {EntitlementAttributeBulkUpdateIdsRequest} entitlementAttributeBulkUpdateIdsRequest Attribute metadata bulk update request body. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ updateAccessModelMetadataByIdsV1: async (entitlementAttributeBulkUpdateIdsRequest: EntitlementAttributeBulkUpdateIdsRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'entitlementAttributeBulkUpdateIdsRequest' is not null or undefined assertParamExists('updateAccessModelMetadataByIdsV1', 'entitlementAttributeBulkUpdateIdsRequest', entitlementAttributeBulkUpdateIdsRequest) const localVarPath = `/access-model-metadata/v1/bulk-update/ids`; // 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(entitlementAttributeBulkUpdateIdsRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * Bulk update Access Model Metadata Attribute Values using a query * @summary Metadata Attribute update by query * @param {EntitlementAttributeBulkUpdateQueryRequest} entitlementAttributeBulkUpdateQueryRequest Attribute metadata bulk update request body. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ updateAccessModelMetadataByQueryV1: async (entitlementAttributeBulkUpdateQueryRequest: EntitlementAttributeBulkUpdateQueryRequest, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'entitlementAttributeBulkUpdateQueryRequest' is not null or undefined assertParamExists('updateAccessModelMetadataByQueryV1', 'entitlementAttributeBulkUpdateQueryRequest', entitlementAttributeBulkUpdateQueryRequest) const localVarPath = `/access-model-metadata/v1/bulk-update/query`; // 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(entitlementAttributeBulkUpdateQueryRequest, localVarRequestOptions, configuration) return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * AccessModelMetadataApi - functional programming interface * @export */ export const AccessModelMetadataApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AccessModelMetadataApiAxiosParamCreator(configuration) return { /** * Create a new Access Model Metadata Attribute. * @summary Create access model metadata attribute * @param {AttributeDTO} attributeDTO Attribute to create * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createAccessModelMetadataAttributeV1(attributeDTO: AttributeDTO, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeV1(attributeDTO, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.createAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Create a new value for an existing Access Model Metadata Attribute. * @summary Create access model metadata value * @param {string} key Technical name of the Attribute. * @param {AttributeValueDTO} attributeValueDTO Attribute value to create * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createAccessModelMetadataAttributeValueV1(key: string, attributeValueDTO: AttributeValueDTO, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createAccessModelMetadataAttributeValueV1(key, attributeValueDTO, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.createAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get single Access Model Metadata Attribute * @summary Get access model metadata attribute * @param {string} key Technical name of the Attribute. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getAccessModelMetadataAttributeV1(key: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeV1(key, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.getAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get single Access Model Metadata Attribute Value * @summary Get access model metadata value * @param {string} key Technical name of the Attribute. * @param {string} value Technical name of the Attribute value. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getAccessModelMetadataAttributeValueV1(key: string, value: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getAccessModelMetadataAttributeValueV1(key, value, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.getAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a list of Access Model Metadata Attributes * @summary List access model metadata attributes * @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* * @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** * @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 {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listAccessModelMetadataAttributeV1(filters?: string, sorters?: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeV1(filters, sorters, limit, count, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.listAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Get a list of Access Model Metadata Attribute Values * @summary List access model metadata values * @param {string} key Technical name of the Attribute. * @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 {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async listAccessModelMetadataAttributeValueV1(key: string, limit?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.listAccessModelMetadataAttributeValueV1(key, limit, count, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.listAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** * @summary Update access model metadata attribute * @param {string} key Technical name of the Attribute. * @param {Array} jsonPatchOperation JSON Patch array to apply * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateAccessModelMetadataAttributeV1(key: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeV1(key, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.updateAccessModelMetadataAttributeV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** * @summary Update access model metadata value * @param {string} key Technical name of the Attribute. * @param {string} value Technical name of the Attribute value. * @param {Array} jsonPatchOperation JSON Patch array to apply * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async updateAccessModelMetadataAttributeValueV1(key: string, value: string, jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataAttributeValueV1(key, value, jsonPatchOperation, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.updateAccessModelMetadataAttributeValueV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Bulk update Access Model Metadata Attribute Values using a filter * @summary Metadata Attribute update by filter * @param {EntitlementAttributeBulkUpdateFilterRequest} entitlementAttributeBulkUpdateFilterRequest Attribute metadata bulk update request body. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ async updateAccessModelMetadataByFilterV1(entitlementAttributeBulkUpdateFilterRequest: EntitlementAttributeBulkUpdateFilterRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByFilterV1(entitlementAttributeBulkUpdateFilterRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.updateAccessModelMetadataByFilterV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Bulk update Access Model Metadata Attribute Values using ids. * @summary Metadata Attribute update by ids * @param {EntitlementAttributeBulkUpdateIdsRequest} entitlementAttributeBulkUpdateIdsRequest Attribute metadata bulk update request body. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ async updateAccessModelMetadataByIdsV1(entitlementAttributeBulkUpdateIdsRequest: EntitlementAttributeBulkUpdateIdsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByIdsV1(entitlementAttributeBulkUpdateIdsRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.updateAccessModelMetadataByIdsV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * Bulk update Access Model Metadata Attribute Values using a query * @summary Metadata Attribute update by query * @param {EntitlementAttributeBulkUpdateQueryRequest} entitlementAttributeBulkUpdateQueryRequest Attribute metadata bulk update request body. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ async updateAccessModelMetadataByQueryV1(entitlementAttributeBulkUpdateQueryRequest: EntitlementAttributeBulkUpdateQueryRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.updateAccessModelMetadataByQueryV1(entitlementAttributeBulkUpdateQueryRequest, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['AccessModelMetadataApi.updateAccessModelMetadataByQueryV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * AccessModelMetadataApi - factory interface * @export */ export const AccessModelMetadataApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = AccessModelMetadataApiFp(configuration) return { /** * Create a new Access Model Metadata Attribute. * @summary Create access model metadata attribute * @param {AccessModelMetadataApiCreateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiCreateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createAccessModelMetadataAttributeV1(requestParameters.attributeDTO, axiosOptions).then((request) => request(axios, basePath)); }, /** * Create a new value for an existing Access Model Metadata Attribute. * @summary Create access model metadata value * @param {AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.attributeValueDTO, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get single Access Model Metadata Attribute * @summary Get access model metadata attribute * @param {AccessModelMetadataApiGetAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiGetAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getAccessModelMetadataAttributeV1(requestParameters.key, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get single Access Model Metadata Attribute Value * @summary Get access model metadata value * @param {AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a list of Access Model Metadata Attributes * @summary List access model metadata attributes * @param {AccessModelMetadataApiListAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiListAccessModelMetadataAttributeV1Request = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listAccessModelMetadataAttributeV1(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); }, /** * Get a list of Access Model Metadata Attribute Values * @summary List access model metadata values * @param {AccessModelMetadataApiListAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ listAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiListAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.listAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(axios, basePath)); }, /** * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** * @summary Update access model metadata attribute * @param {AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateAccessModelMetadataAttributeV1(requestParameters.key, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** * @summary Update access model metadata value * @param {AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ updateAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(axios, basePath)); }, /** * Bulk update Access Model Metadata Attribute Values using a filter * @summary Metadata Attribute update by filter * @param {AccessModelMetadataApiUpdateAccessModelMetadataByFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ updateAccessModelMetadataByFilterV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateAccessModelMetadataByFilterV1(requestParameters.entitlementAttributeBulkUpdateFilterRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * Bulk update Access Model Metadata Attribute Values using ids. * @summary Metadata Attribute update by ids * @param {AccessModelMetadataApiUpdateAccessModelMetadataByIdsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ updateAccessModelMetadataByIdsV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateAccessModelMetadataByIdsV1(requestParameters.entitlementAttributeBulkUpdateIdsRequest, axiosOptions).then((request) => request(axios, basePath)); }, /** * Bulk update Access Model Metadata Attribute Values using a query * @summary Metadata Attribute update by query * @param {AccessModelMetadataApiUpdateAccessModelMetadataByQueryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} */ updateAccessModelMetadataByQueryV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.updateAccessModelMetadataByQueryV1(requestParameters.entitlementAttributeBulkUpdateQueryRequest, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createAccessModelMetadataAttributeV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiCreateAccessModelMetadataAttributeV1Request */ export interface AccessModelMetadataApiCreateAccessModelMetadataAttributeV1Request { /** * Attribute to create * @type {AttributeDTO} * @memberof AccessModelMetadataApiCreateAccessModelMetadataAttributeV1 */ readonly attributeDTO: AttributeDTO } /** * Request parameters for createAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1Request */ export interface AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1Request { /** * Technical name of the Attribute. * @type {string} * @memberof AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1 */ readonly key: string /** * Attribute value to create * @type {AttributeValueDTO} * @memberof AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1 */ readonly attributeValueDTO: AttributeValueDTO } /** * Request parameters for getAccessModelMetadataAttributeV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiGetAccessModelMetadataAttributeV1Request */ export interface AccessModelMetadataApiGetAccessModelMetadataAttributeV1Request { /** * Technical name of the Attribute. * @type {string} * @memberof AccessModelMetadataApiGetAccessModelMetadataAttributeV1 */ readonly key: string } /** * Request parameters for getAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1Request */ export interface AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1Request { /** * Technical name of the Attribute. * @type {string} * @memberof AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1 */ readonly key: string /** * Technical name of the Attribute value. * @type {string} * @memberof AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1 */ readonly value: string } /** * Request parameters for listAccessModelMetadataAttributeV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiListAccessModelMetadataAttributeV1Request */ export interface AccessModelMetadataApiListAccessModelMetadataAttributeV1Request { /** * Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators are *and, or* * @type {string} * @memberof AccessModelMetadataApiListAccessModelMetadataAttributeV1 */ readonly filters?: string /** * Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** * @type {string} * @memberof AccessModelMetadataApiListAccessModelMetadataAttributeV1 */ readonly sorters?: string /** * 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 AccessModelMetadataApiListAccessModelMetadataAttributeV1 */ readonly limit?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof AccessModelMetadataApiListAccessModelMetadataAttributeV1 */ readonly count?: boolean } /** * Request parameters for listAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiListAccessModelMetadataAttributeValueV1Request */ export interface AccessModelMetadataApiListAccessModelMetadataAttributeValueV1Request { /** * Technical name of the Attribute. * @type {string} * @memberof AccessModelMetadataApiListAccessModelMetadataAttributeValueV1 */ readonly key: string /** * 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 AccessModelMetadataApiListAccessModelMetadataAttributeValueV1 */ readonly limit?: number /** * If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. * @type {boolean} * @memberof AccessModelMetadataApiListAccessModelMetadataAttributeValueV1 */ readonly count?: boolean } /** * Request parameters for updateAccessModelMetadataAttributeV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1Request */ export interface AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1Request { /** * Technical name of the Attribute. * @type {string} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1 */ readonly key: string /** * JSON Patch array to apply * @type {Array} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for updateAccessModelMetadataAttributeValueV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1Request */ export interface AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1Request { /** * Technical name of the Attribute. * @type {string} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1 */ readonly key: string /** * Technical name of the Attribute value. * @type {string} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1 */ readonly value: string /** * JSON Patch array to apply * @type {Array} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1 */ readonly jsonPatchOperation: Array } /** * Request parameters for updateAccessModelMetadataByFilterV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiUpdateAccessModelMetadataByFilterV1Request */ export interface AccessModelMetadataApiUpdateAccessModelMetadataByFilterV1Request { /** * Attribute metadata bulk update request body. * @type {EntitlementAttributeBulkUpdateFilterRequest} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataByFilterV1 */ readonly entitlementAttributeBulkUpdateFilterRequest: EntitlementAttributeBulkUpdateFilterRequest } /** * Request parameters for updateAccessModelMetadataByIdsV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiUpdateAccessModelMetadataByIdsV1Request */ export interface AccessModelMetadataApiUpdateAccessModelMetadataByIdsV1Request { /** * Attribute metadata bulk update request body. * @type {EntitlementAttributeBulkUpdateIdsRequest} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataByIdsV1 */ readonly entitlementAttributeBulkUpdateIdsRequest: EntitlementAttributeBulkUpdateIdsRequest } /** * Request parameters for updateAccessModelMetadataByQueryV1 operation in AccessModelMetadataApi. * @export * @interface AccessModelMetadataApiUpdateAccessModelMetadataByQueryV1Request */ export interface AccessModelMetadataApiUpdateAccessModelMetadataByQueryV1Request { /** * Attribute metadata bulk update request body. * @type {EntitlementAttributeBulkUpdateQueryRequest} * @memberof AccessModelMetadataApiUpdateAccessModelMetadataByQueryV1 */ readonly entitlementAttributeBulkUpdateQueryRequest: EntitlementAttributeBulkUpdateQueryRequest } /** * AccessModelMetadataApi - object-oriented interface * @export * @class AccessModelMetadataApi * @extends {BaseAPI} */ export class AccessModelMetadataApi extends BaseAPI { /** * Create a new Access Model Metadata Attribute. * @summary Create access model metadata attribute * @param {AccessModelMetadataApiCreateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public createAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiCreateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).createAccessModelMetadataAttributeV1(requestParameters.attributeDTO, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Create a new value for an existing Access Model Metadata Attribute. * @summary Create access model metadata value * @param {AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public createAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiCreateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).createAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.attributeValueDTO, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get single Access Model Metadata Attribute * @summary Get access model metadata attribute * @param {AccessModelMetadataApiGetAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public getAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiGetAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).getAccessModelMetadataAttributeV1(requestParameters.key, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get single Access Model Metadata Attribute Value * @summary Get access model metadata value * @param {AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public getAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiGetAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).getAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a list of Access Model Metadata Attributes * @summary List access model metadata attributes * @param {AccessModelMetadataApiListAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public listAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiListAccessModelMetadataAttributeV1Request = {}, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).listAccessModelMetadataAttributeV1(requestParameters.filters, requestParameters.sorters, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Get a list of Access Model Metadata Attribute Values * @summary List access model metadata values * @param {AccessModelMetadataApiListAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public listAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiListAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).listAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.limit, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update an existing Access Model Metadata Attribute. The following fields are patchable: **name**, **description**, **multiselect**, **values** * @summary Update access model metadata attribute * @param {AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public updateAccessModelMetadataAttributeV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataAttributeV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).updateAccessModelMetadataAttributeV1(requestParameters.key, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Update an existing Access Model Metadata Attribute Value. The following fields are patchable: **name** * @summary Update access model metadata value * @param {AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public updateAccessModelMetadataAttributeValueV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataAttributeValueV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).updateAccessModelMetadataAttributeValueV1(requestParameters.key, requestParameters.value, requestParameters.jsonPatchOperation, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Bulk update Access Model Metadata Attribute Values using a filter * @summary Metadata Attribute update by filter * @param {AccessModelMetadataApiUpdateAccessModelMetadataByFilterV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public updateAccessModelMetadataByFilterV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).updateAccessModelMetadataByFilterV1(requestParameters.entitlementAttributeBulkUpdateFilterRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Bulk update Access Model Metadata Attribute Values using ids. * @summary Metadata Attribute update by ids * @param {AccessModelMetadataApiUpdateAccessModelMetadataByIdsV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public updateAccessModelMetadataByIdsV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).updateAccessModelMetadataByIdsV1(requestParameters.entitlementAttributeBulkUpdateIdsRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * Bulk update Access Model Metadata Attribute Values using a query * @summary Metadata Attribute update by query * @param {AccessModelMetadataApiUpdateAccessModelMetadataByQueryV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @deprecated * @throws {RequiredError} * @memberof AccessModelMetadataApi */ public updateAccessModelMetadataByQueryV1(requestParameters: AccessModelMetadataApiUpdateAccessModelMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig) { return AccessModelMetadataApiFp(this.configuration).updateAccessModelMetadataByQueryV1(requestParameters.entitlementAttributeBulkUpdateQueryRequest, axiosOptions).then((request) => request(this.axios, this.basePath)); } }