sailpoint-api-client 1.7.8 → 1.7.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v2026/api.ts CHANGED
@@ -23,6 +23,86 @@ import type { RequestArgs } from './base';
23
23
  // @ts-ignore
24
24
  import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base';
25
25
 
26
+ /**
27
+ * Metadata that describes an access item
28
+ * @export
29
+ * @interface AccessModelMetadataV2026
30
+ */
31
+ export interface AccessModelMetadataV2026 {
32
+ /**
33
+ * Unique identifier for the metadata type
34
+ * @type {string}
35
+ * @memberof AccessModelMetadataV2026
36
+ */
37
+ 'key'?: string;
38
+ /**
39
+ * Human readable name of the metadata type
40
+ * @type {string}
41
+ * @memberof AccessModelMetadataV2026
42
+ */
43
+ 'name'?: string;
44
+ /**
45
+ * Allows selecting multiple values
46
+ * @type {boolean}
47
+ * @memberof AccessModelMetadataV2026
48
+ */
49
+ 'multiselect'?: boolean;
50
+ /**
51
+ * The state of the metadata item
52
+ * @type {string}
53
+ * @memberof AccessModelMetadataV2026
54
+ */
55
+ 'status'?: string;
56
+ /**
57
+ * The type of the metadata item
58
+ * @type {string}
59
+ * @memberof AccessModelMetadataV2026
60
+ */
61
+ 'type'?: string;
62
+ /**
63
+ * The types of objects
64
+ * @type {Array<string>}
65
+ * @memberof AccessModelMetadataV2026
66
+ */
67
+ 'objectTypes'?: Array<string>;
68
+ /**
69
+ * Describes the metadata item
70
+ * @type {string}
71
+ * @memberof AccessModelMetadataV2026
72
+ */
73
+ 'description'?: string;
74
+ /**
75
+ * The value to assign to the metadata item
76
+ * @type {Array<AccessModelMetadataValuesInnerV2026>}
77
+ * @memberof AccessModelMetadataV2026
78
+ */
79
+ 'values'?: Array<AccessModelMetadataValuesInnerV2026>;
80
+ }
81
+ /**
82
+ * An individual value to assign to the metadata item
83
+ * @export
84
+ * @interface AccessModelMetadataValuesInnerV2026
85
+ */
86
+ export interface AccessModelMetadataValuesInnerV2026 {
87
+ /**
88
+ * The value to assign to the metdata item
89
+ * @type {string}
90
+ * @memberof AccessModelMetadataValuesInnerV2026
91
+ */
92
+ 'value'?: string;
93
+ /**
94
+ * Display name of the value
95
+ * @type {string}
96
+ * @memberof AccessModelMetadataValuesInnerV2026
97
+ */
98
+ 'name'?: string;
99
+ /**
100
+ * The status of the individual value
101
+ * @type {string}
102
+ * @memberof AccessModelMetadataValuesInnerV2026
103
+ */
104
+ 'status'?: string;
105
+ }
26
106
  /**
27
107
  *
28
108
  * @export
@@ -722,6 +802,287 @@ export const DtoTypeV2026 = {
722
802
  export type DtoTypeV2026 = typeof DtoTypeV2026[keyof typeof DtoTypeV2026];
723
803
 
724
804
 
805
+ /**
806
+ * Additional data to classify the entitlement
807
+ * @export
808
+ * @interface EntitlementAccessModelMetadataV2026
809
+ */
810
+ export interface EntitlementAccessModelMetadataV2026 {
811
+ /**
812
+ *
813
+ * @type {Array<AccessModelMetadataV2026>}
814
+ * @memberof EntitlementAccessModelMetadataV2026
815
+ */
816
+ 'attributes'?: Array<AccessModelMetadataV2026>;
817
+ }
818
+ /**
819
+ * Object for specifying the bulk update request
820
+ * @export
821
+ * @interface EntitlementBulkUpdateRequestV2026
822
+ */
823
+ export interface EntitlementBulkUpdateRequestV2026 {
824
+ /**
825
+ * List of entitlement ids to update
826
+ * @type {Array<string>}
827
+ * @memberof EntitlementBulkUpdateRequestV2026
828
+ */
829
+ 'entitlementIds': Array<string>;
830
+ /**
831
+ *
832
+ * @type {Array<JsonPatchOperationV2026>}
833
+ * @memberof EntitlementBulkUpdateRequestV2026
834
+ */
835
+ 'jsonPatch': Array<JsonPatchOperationV2026>;
836
+ }
837
+ /**
838
+ * The identity that owns the entitlement
839
+ * @export
840
+ * @interface EntitlementOwnerV2026
841
+ */
842
+ export interface EntitlementOwnerV2026 {
843
+ /**
844
+ * The identity ID
845
+ * @type {string}
846
+ * @memberof EntitlementOwnerV2026
847
+ */
848
+ 'id'?: string;
849
+ /**
850
+ * The type of object
851
+ * @type {string}
852
+ * @memberof EntitlementOwnerV2026
853
+ */
854
+ 'type'?: EntitlementOwnerV2026TypeV2026;
855
+ /**
856
+ * The display name of the identity
857
+ * @type {string}
858
+ * @memberof EntitlementOwnerV2026
859
+ */
860
+ 'name'?: string;
861
+ }
862
+
863
+ export const EntitlementOwnerV2026TypeV2026 = {
864
+ Identity: 'IDENTITY'
865
+ } as const;
866
+
867
+ export type EntitlementOwnerV2026TypeV2026 = typeof EntitlementOwnerV2026TypeV2026[keyof typeof EntitlementOwnerV2026TypeV2026];
868
+
869
+ /**
870
+ *
871
+ * @export
872
+ * @interface EntitlementPrivilegeLevelV2026
873
+ */
874
+ export interface EntitlementPrivilegeLevelV2026 {
875
+ /**
876
+ * Direct privilege level assigned to the entitlement
877
+ * @type {string}
878
+ * @memberof EntitlementPrivilegeLevelV2026
879
+ */
880
+ 'direct'?: EntitlementPrivilegeLevelV2026DirectV2026;
881
+ /**
882
+ * User or process that set the privilege level
883
+ * @type {string}
884
+ * @memberof EntitlementPrivilegeLevelV2026
885
+ */
886
+ 'setBy'?: string;
887
+ /**
888
+ * Method by which the privilege level was set
889
+ * @type {string}
890
+ * @memberof EntitlementPrivilegeLevelV2026
891
+ */
892
+ 'setByType'?: EntitlementPrivilegeLevelV2026SetByTypeV2026 | null;
893
+ /**
894
+ * Inherited privilege level on the entitlement, if any
895
+ * @type {string}
896
+ * @memberof EntitlementPrivilegeLevelV2026
897
+ */
898
+ 'inherited'?: EntitlementPrivilegeLevelV2026InheritedV2026 | null;
899
+ /**
900
+ * Effective privilege level assigned to the entitlement
901
+ * @type {string}
902
+ * @memberof EntitlementPrivilegeLevelV2026
903
+ */
904
+ 'effective'?: EntitlementPrivilegeLevelV2026EffectiveV2026;
905
+ }
906
+
907
+ export const EntitlementPrivilegeLevelV2026DirectV2026 = {
908
+ High: 'HIGH',
909
+ Low: 'LOW',
910
+ Medium: 'MEDIUM',
911
+ None: 'NONE'
912
+ } as const;
913
+
914
+ export type EntitlementPrivilegeLevelV2026DirectV2026 = typeof EntitlementPrivilegeLevelV2026DirectV2026[keyof typeof EntitlementPrivilegeLevelV2026DirectV2026];
915
+ export const EntitlementPrivilegeLevelV2026SetByTypeV2026 = {
916
+ Override: 'OVERRIDE',
917
+ CustomCriteria: 'CUSTOM_CRITERIA',
918
+ ConnectorCriteria: 'CONNECTOR_CRITERIA',
919
+ SingleLevelCriteria: 'SINGLE_LEVEL_CRITERIA'
920
+ } as const;
921
+
922
+ export type EntitlementPrivilegeLevelV2026SetByTypeV2026 = typeof EntitlementPrivilegeLevelV2026SetByTypeV2026[keyof typeof EntitlementPrivilegeLevelV2026SetByTypeV2026];
923
+ export const EntitlementPrivilegeLevelV2026InheritedV2026 = {
924
+ High: 'HIGH',
925
+ Low: 'LOW',
926
+ Medium: 'MEDIUM',
927
+ None: 'NONE'
928
+ } as const;
929
+
930
+ export type EntitlementPrivilegeLevelV2026InheritedV2026 = typeof EntitlementPrivilegeLevelV2026InheritedV2026[keyof typeof EntitlementPrivilegeLevelV2026InheritedV2026];
931
+ export const EntitlementPrivilegeLevelV2026EffectiveV2026 = {
932
+ High: 'HIGH',
933
+ Low: 'LOW',
934
+ Medium: 'MEDIUM',
935
+ None: 'NONE'
936
+ } as const;
937
+
938
+ export type EntitlementPrivilegeLevelV2026EffectiveV2026 = typeof EntitlementPrivilegeLevelV2026EffectiveV2026[keyof typeof EntitlementPrivilegeLevelV2026EffectiveV2026];
939
+
940
+ /**
941
+ *
942
+ * @export
943
+ * @interface EntitlementSourceV2026
944
+ */
945
+ export interface EntitlementSourceV2026 {
946
+ /**
947
+ * The source ID
948
+ * @type {string}
949
+ * @memberof EntitlementSourceV2026
950
+ */
951
+ 'id'?: string;
952
+ /**
953
+ * The source type, will always be \"SOURCE\"
954
+ * @type {string}
955
+ * @memberof EntitlementSourceV2026
956
+ */
957
+ 'type'?: string;
958
+ /**
959
+ * The source name
960
+ * @type {string}
961
+ * @memberof EntitlementSourceV2026
962
+ */
963
+ 'name'?: string;
964
+ }
965
+ /**
966
+ *
967
+ * @export
968
+ * @interface EntitlementV2026
969
+ */
970
+ export interface EntitlementV2026 {
971
+ /**
972
+ * The entitlement id
973
+ * @type {string}
974
+ * @memberof EntitlementV2026
975
+ */
976
+ 'id'?: string;
977
+ /**
978
+ * The entitlement name
979
+ * @type {string}
980
+ * @memberof EntitlementV2026
981
+ */
982
+ 'name'?: string;
983
+ /**
984
+ * The entitlement attribute name
985
+ * @type {string}
986
+ * @memberof EntitlementV2026
987
+ */
988
+ 'attribute'?: string;
989
+ /**
990
+ * The value of the entitlement
991
+ * @type {string}
992
+ * @memberof EntitlementV2026
993
+ */
994
+ 'value'?: string;
995
+ /**
996
+ * The object type of the entitlement from the source schema
997
+ * @type {string}
998
+ * @memberof EntitlementV2026
999
+ */
1000
+ 'sourceSchemaObjectType'?: string;
1001
+ /**
1002
+ * The description of the entitlement
1003
+ * @type {string}
1004
+ * @memberof EntitlementV2026
1005
+ */
1006
+ 'description'?: string | null;
1007
+ /**
1008
+ *
1009
+ * @type {EntitlementPrivilegeLevelV2026}
1010
+ * @memberof EntitlementV2026
1011
+ */
1012
+ 'privilegeLevel'?: EntitlementPrivilegeLevelV2026;
1013
+ /**
1014
+ * List of tags assigned to the entitlement
1015
+ * @type {Array<string>}
1016
+ * @memberof EntitlementV2026
1017
+ */
1018
+ 'tags'?: Array<string> | null;
1019
+ /**
1020
+ * True if the entitlement is cloud governed
1021
+ * @type {boolean}
1022
+ * @memberof EntitlementV2026
1023
+ */
1024
+ 'cloudGoverned'?: boolean;
1025
+ /**
1026
+ * True if the entitlement is able to be directly requested
1027
+ * @type {boolean}
1028
+ * @memberof EntitlementV2026
1029
+ */
1030
+ 'requestable'?: boolean;
1031
+ /**
1032
+ *
1033
+ * @type {EntitlementOwnerV2026}
1034
+ * @memberof EntitlementV2026
1035
+ */
1036
+ 'owner'?: EntitlementOwnerV2026 | null;
1037
+ /**
1038
+ * A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated.
1039
+ * @type {{ [key: string]: any; }}
1040
+ * @memberof EntitlementV2026
1041
+ */
1042
+ 'manuallyUpdatedFields'?: { [key: string]: any; } | null;
1043
+ /**
1044
+ *
1045
+ * @type {EntitlementAccessModelMetadataV2026}
1046
+ * @memberof EntitlementV2026
1047
+ */
1048
+ 'accessModelMetadata'?: EntitlementAccessModelMetadataV2026;
1049
+ /**
1050
+ * Time when the entitlement was created
1051
+ * @type {string}
1052
+ * @memberof EntitlementV2026
1053
+ */
1054
+ 'created'?: string;
1055
+ /**
1056
+ * Time when the entitlement was last modified
1057
+ * @type {string}
1058
+ * @memberof EntitlementV2026
1059
+ */
1060
+ 'modified'?: string;
1061
+ /**
1062
+ *
1063
+ * @type {EntitlementSourceV2026}
1064
+ * @memberof EntitlementV2026
1065
+ */
1066
+ 'source'?: EntitlementSourceV2026;
1067
+ /**
1068
+ * A map of free-form key-value pairs from the source system
1069
+ * @type {{ [key: string]: any; }}
1070
+ * @memberof EntitlementV2026
1071
+ */
1072
+ 'attributes'?: { [key: string]: any; };
1073
+ /**
1074
+ * List of IDs of segments, if any, to which this Entitlement is assigned.
1075
+ * @type {Array<string>}
1076
+ * @memberof EntitlementV2026
1077
+ */
1078
+ 'segments'?: Array<string> | null;
1079
+ /**
1080
+ *
1081
+ * @type {Array<PermissionDtoV2026>}
1082
+ * @memberof EntitlementV2026
1083
+ */
1084
+ 'directPermissions'?: Array<PermissionDtoV2026>;
1085
+ }
725
1086
  /**
726
1087
  *
727
1088
  * @export
@@ -780,32 +1141,6 @@ export interface ErrorResponseDtoV2026 {
780
1141
  */
781
1142
  'causes'?: Array<ErrorMessageDtoV2026>;
782
1143
  }
783
- /**
784
- *
785
- * @export
786
- * @interface GetTaskStatus401ResponseV2026
787
- */
788
- export interface GetTaskStatus401ResponseV2026 {
789
- /**
790
- * A message describing the error
791
- * @type {object}
792
- * @memberof GetTaskStatus401ResponseV2026
793
- */
794
- 'error'?: object;
795
- }
796
- /**
797
- *
798
- * @export
799
- * @interface GetTaskStatus429ResponseV2026
800
- */
801
- export interface GetTaskStatus429ResponseV2026 {
802
- /**
803
- * A message describing the error
804
- * @type {object}
805
- * @memberof GetTaskStatus429ResponseV2026
806
- */
807
- 'message'?: object;
808
- }
809
1144
  /**
810
1145
  * Contains detailed information about an identity, including unique identifier, name, email address, and registration status.
811
1146
  * @export
@@ -881,6 +1216,32 @@ export type JsonPatchOperationV2026OpV2026 = typeof JsonPatchOperationV2026OpV20
881
1216
  */
882
1217
  export type JsonPatchOperationValueV2026 = Array<ArrayInnerV2026> | boolean | number | object | string;
883
1218
 
1219
+ /**
1220
+ *
1221
+ * @export
1222
+ * @interface ListEntitlements401ResponseV2026
1223
+ */
1224
+ export interface ListEntitlements401ResponseV2026 {
1225
+ /**
1226
+ * A message describing the error
1227
+ * @type {object}
1228
+ * @memberof ListEntitlements401ResponseV2026
1229
+ */
1230
+ 'error'?: object;
1231
+ }
1232
+ /**
1233
+ *
1234
+ * @export
1235
+ * @interface ListEntitlements429ResponseV2026
1236
+ */
1237
+ export interface ListEntitlements429ResponseV2026 {
1238
+ /**
1239
+ * A message describing the error
1240
+ * @type {object}
1241
+ * @memberof ListEntitlements429ResponseV2026
1242
+ */
1243
+ 'message'?: object;
1244
+ }
884
1245
  /**
885
1246
  * 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.
886
1247
  * @export
@@ -995,6 +1356,25 @@ export interface MachineAccountSubTypeConfigDtoV2026 {
995
1356
  */
996
1357
  'machineAccountDelete'?: MachineAccountSubTypeConfigDtoMachineAccountDeleteV2026;
997
1358
  }
1359
+ /**
1360
+ * Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.
1361
+ * @export
1362
+ * @interface PermissionDtoV2026
1363
+ */
1364
+ export interface PermissionDtoV2026 {
1365
+ /**
1366
+ * All the rights (e.g. actions) that this permission allows on the target
1367
+ * @type {Array<string>}
1368
+ * @memberof PermissionDtoV2026
1369
+ */
1370
+ 'rights'?: Array<string>;
1371
+ /**
1372
+ * The target the permission would grants rights on.
1373
+ * @type {string}
1374
+ * @memberof PermissionDtoV2026
1375
+ */
1376
+ 'target'?: string;
1377
+ }
998
1378
  /**
999
1379
  *
1000
1380
  * @export
@@ -1619,6 +1999,957 @@ export class DeleteAccountV2026Api extends BaseAPI {
1619
1999
 
1620
2000
 
1621
2001
 
2002
+ /**
2003
+ * EntitlementsV2026Api - axios parameter creator
2004
+ * @export
2005
+ */
2006
+ export const EntitlementsV2026ApiAxiosParamCreator = function (configuration?: Configuration) {
2007
+ return {
2008
+ /**
2009
+ * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
2010
+ * @summary Get entitlements for an account
2011
+ * @param {string} accountId The account ID to get entitlements for
2012
+ * @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.
2013
+ * @param {number} [offset] 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.
2014
+ * @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&#x3D;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.
2015
+ * @param {*} [axiosOptions] Override http request option.
2016
+ * @throws {RequiredError}
2017
+ */
2018
+ getAccountEntitlements: async (accountId: string, limit?: number, offset?: number, count?: boolean, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2019
+ // verify required parameter 'accountId' is not null or undefined
2020
+ assertParamExists('getAccountEntitlements', 'accountId', accountId)
2021
+ const localVarPath = `/entitlements/account/{accountId}/entitlements`
2022
+ .replace(`{${"accountId"}}`, encodeURIComponent(String(accountId)));
2023
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2024
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2025
+ let baseOptions;
2026
+ if (configuration) {
2027
+ baseOptions = configuration.baseOptions;
2028
+ }
2029
+
2030
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
2031
+ const localVarHeaderParameter = {} as any;
2032
+ const localVarQueryParameter = {} as any;
2033
+
2034
+ // authentication userAuth required
2035
+ // oauth required
2036
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2037
+
2038
+ // authentication userAuth required
2039
+ // oauth required
2040
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2041
+
2042
+ if (limit !== undefined) {
2043
+ localVarQueryParameter['limit'] = limit;
2044
+ }
2045
+
2046
+ if (offset !== undefined) {
2047
+ localVarQueryParameter['offset'] = offset;
2048
+ }
2049
+
2050
+ if (count !== undefined) {
2051
+ localVarQueryParameter['count'] = count;
2052
+ }
2053
+
2054
+
2055
+
2056
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2057
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2058
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
2059
+
2060
+ return {
2061
+ url: toPathString(localVarUrlObj),
2062
+ axiosOptions: localVarRequestOptions,
2063
+ };
2064
+ },
2065
+ /**
2066
+ * This API returns an entitlement by its ID.
2067
+ * @summary Get an entitlement
2068
+ * @param {string} id The entitlement ID
2069
+ * @param {*} [axiosOptions] Override http request option.
2070
+ * @throws {RequiredError}
2071
+ */
2072
+ getEntitlement: async (id: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2073
+ // verify required parameter 'id' is not null or undefined
2074
+ assertParamExists('getEntitlement', 'id', id)
2075
+ const localVarPath = `/entitlements/{id}`
2076
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2077
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2078
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2079
+ let baseOptions;
2080
+ if (configuration) {
2081
+ baseOptions = configuration.baseOptions;
2082
+ }
2083
+
2084
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
2085
+ const localVarHeaderParameter = {} as any;
2086
+ const localVarQueryParameter = {} as any;
2087
+
2088
+ // authentication userAuth required
2089
+ // oauth required
2090
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2091
+
2092
+ // authentication userAuth required
2093
+ // oauth required
2094
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2095
+
2096
+
2097
+
2098
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2099
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2100
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
2101
+
2102
+ return {
2103
+ url: toPathString(localVarUrlObj),
2104
+ axiosOptions: localVarRequestOptions,
2105
+ };
2106
+ },
2107
+ /**
2108
+ * This API returns a list of all child entitlements of a given entitlement.
2109
+ * @summary List of entitlements children
2110
+ * @param {string} id Entitlement Id
2111
+ * @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.
2112
+ * @param {number} [offset] 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.
2113
+ * @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&#x3D;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.
2114
+ * @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: **id, name, created, modified, type, attribute, value, source.id**
2115
+ * @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2116
+ * @param {*} [axiosOptions] Override http request option.
2117
+ * @throws {RequiredError}
2118
+ */
2119
+ listEntitlementChildren: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2120
+ // verify required parameter 'id' is not null or undefined
2121
+ assertParamExists('listEntitlementChildren', 'id', id)
2122
+ const localVarPath = `/entitlements/{id}/children`
2123
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2124
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2125
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2126
+ let baseOptions;
2127
+ if (configuration) {
2128
+ baseOptions = configuration.baseOptions;
2129
+ }
2130
+
2131
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
2132
+ const localVarHeaderParameter = {} as any;
2133
+ const localVarQueryParameter = {} as any;
2134
+
2135
+ // authentication userAuth required
2136
+ // oauth required
2137
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2138
+
2139
+ // authentication userAuth required
2140
+ // oauth required
2141
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2142
+
2143
+ if (limit !== undefined) {
2144
+ localVarQueryParameter['limit'] = limit;
2145
+ }
2146
+
2147
+ if (offset !== undefined) {
2148
+ localVarQueryParameter['offset'] = offset;
2149
+ }
2150
+
2151
+ if (count !== undefined) {
2152
+ localVarQueryParameter['count'] = count;
2153
+ }
2154
+
2155
+ if (sorters !== undefined) {
2156
+ localVarQueryParameter['sorters'] = sorters;
2157
+ }
2158
+
2159
+ if (filters !== undefined) {
2160
+ localVarQueryParameter['filters'] = filters;
2161
+ }
2162
+
2163
+
2164
+
2165
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2166
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2167
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
2168
+
2169
+ return {
2170
+ url: toPathString(localVarUrlObj),
2171
+ axiosOptions: localVarRequestOptions,
2172
+ };
2173
+ },
2174
+ /**
2175
+ * This API returns a list of all parent entitlements of a given entitlement.
2176
+ * @summary List of entitlements parents
2177
+ * @param {string} id Entitlement Id
2178
+ * @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.
2179
+ * @param {number} [offset] 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.
2180
+ * @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&#x3D;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.
2181
+ * @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: **id, name, created, modified, type, attribute, value, source.id**
2182
+ * @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2183
+ * @param {*} [axiosOptions] Override http request option.
2184
+ * @throws {RequiredError}
2185
+ */
2186
+ listEntitlementParents: async (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2187
+ // verify required parameter 'id' is not null or undefined
2188
+ assertParamExists('listEntitlementParents', 'id', id)
2189
+ const localVarPath = `/entitlements/{id}/parents`
2190
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2191
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2192
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2193
+ let baseOptions;
2194
+ if (configuration) {
2195
+ baseOptions = configuration.baseOptions;
2196
+ }
2197
+
2198
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
2199
+ const localVarHeaderParameter = {} as any;
2200
+ const localVarQueryParameter = {} as any;
2201
+
2202
+ // authentication userAuth required
2203
+ // oauth required
2204
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2205
+
2206
+ // authentication userAuth required
2207
+ // oauth required
2208
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2209
+
2210
+ if (limit !== undefined) {
2211
+ localVarQueryParameter['limit'] = limit;
2212
+ }
2213
+
2214
+ if (offset !== undefined) {
2215
+ localVarQueryParameter['offset'] = offset;
2216
+ }
2217
+
2218
+ if (count !== undefined) {
2219
+ localVarQueryParameter['count'] = count;
2220
+ }
2221
+
2222
+ if (sorters !== undefined) {
2223
+ localVarQueryParameter['sorters'] = sorters;
2224
+ }
2225
+
2226
+ if (filters !== undefined) {
2227
+ localVarQueryParameter['filters'] = filters;
2228
+ }
2229
+
2230
+
2231
+
2232
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2233
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2234
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
2235
+
2236
+ return {
2237
+ url: toPathString(localVarUrlObj),
2238
+ axiosOptions: localVarRequestOptions,
2239
+ };
2240
+ },
2241
+ /**
2242
+ * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
2243
+ * @summary Gets a list of entitlements.
2244
+ * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\&#39;s Identity.
2245
+ * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
2246
+ * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented&#x3D;false** results in an error.
2247
+ * @param {number} [offset] 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.
2248
+ * @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.
2249
+ * @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&#x3D;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.
2250
+ * @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: **id, name, created, modified, type, attribute, value, source.id, requestable**
2251
+ * @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2252
+ * @param {*} [axiosOptions] Override http request option.
2253
+ * @throws {RequiredError}
2254
+ */
2255
+ listEntitlements: async (segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2256
+ const localVarPath = `/entitlements`;
2257
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2258
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2259
+ let baseOptions;
2260
+ if (configuration) {
2261
+ baseOptions = configuration.baseOptions;
2262
+ }
2263
+
2264
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions};
2265
+ const localVarHeaderParameter = {} as any;
2266
+ const localVarQueryParameter = {} as any;
2267
+
2268
+ // authentication userAuth required
2269
+ // oauth required
2270
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2271
+
2272
+ // authentication userAuth required
2273
+ // oauth required
2274
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2275
+
2276
+ if (segmentedForIdentity !== undefined) {
2277
+ localVarQueryParameter['segmented-for-identity'] = segmentedForIdentity;
2278
+ }
2279
+
2280
+ if (forSegmentIds !== undefined) {
2281
+ localVarQueryParameter['for-segment-ids'] = forSegmentIds;
2282
+ }
2283
+
2284
+ if (includeUnsegmented !== undefined) {
2285
+ localVarQueryParameter['include-unsegmented'] = includeUnsegmented;
2286
+ }
2287
+
2288
+ if (offset !== undefined) {
2289
+ localVarQueryParameter['offset'] = offset;
2290
+ }
2291
+
2292
+ if (limit !== undefined) {
2293
+ localVarQueryParameter['limit'] = limit;
2294
+ }
2295
+
2296
+ if (count !== undefined) {
2297
+ localVarQueryParameter['count'] = count;
2298
+ }
2299
+
2300
+ if (sorters !== undefined) {
2301
+ localVarQueryParameter['sorters'] = sorters;
2302
+ }
2303
+
2304
+ if (filters !== undefined) {
2305
+ localVarQueryParameter['filters'] = filters;
2306
+ }
2307
+
2308
+
2309
+
2310
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2311
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2312
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
2313
+
2314
+ return {
2315
+ url: toPathString(localVarUrlObj),
2316
+ axiosOptions: localVarRequestOptions,
2317
+ };
2318
+ },
2319
+ /**
2320
+ * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
2321
+ * @summary Patch an entitlement
2322
+ * @param {string} id ID of the entitlement to patch
2323
+ * @param {Array<JsonPatchOperationV2026>} [jsonPatchOperationV2026]
2324
+ * @param {*} [axiosOptions] Override http request option.
2325
+ * @throws {RequiredError}
2326
+ */
2327
+ patchEntitlement: async (id: string, jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2328
+ // verify required parameter 'id' is not null or undefined
2329
+ assertParamExists('patchEntitlement', 'id', id)
2330
+ const localVarPath = `/entitlements/{id}`
2331
+ .replace(`{${"id"}}`, encodeURIComponent(String(id)));
2332
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2333
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2334
+ let baseOptions;
2335
+ if (configuration) {
2336
+ baseOptions = configuration.baseOptions;
2337
+ }
2338
+
2339
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...axiosOptions};
2340
+ const localVarHeaderParameter = {} as any;
2341
+ const localVarQueryParameter = {} as any;
2342
+
2343
+ // authentication userAuth required
2344
+ // oauth required
2345
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2346
+
2347
+ // authentication userAuth required
2348
+ // oauth required
2349
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2350
+
2351
+
2352
+
2353
+ localVarHeaderParameter['Content-Type'] = 'application/json-patch+json';
2354
+
2355
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2356
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2357
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
2358
+ localVarRequestOptions.data = serializeDataIfNeeded(jsonPatchOperationV2026, localVarRequestOptions, configuration)
2359
+
2360
+ return {
2361
+ url: toPathString(localVarUrlObj),
2362
+ axiosOptions: localVarRequestOptions,
2363
+ };
2364
+ },
2365
+ /**
2366
+ * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
2367
+ * @summary Bulk update an entitlement list
2368
+ * @param {EntitlementBulkUpdateRequestV2026} entitlementBulkUpdateRequestV2026
2369
+ * @param {*} [axiosOptions] Override http request option.
2370
+ * @throws {RequiredError}
2371
+ */
2372
+ updateEntitlementsInBulk: async (entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026, axiosOptions: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2373
+ // verify required parameter 'entitlementBulkUpdateRequestV2026' is not null or undefined
2374
+ assertParamExists('updateEntitlementsInBulk', 'entitlementBulkUpdateRequestV2026', entitlementBulkUpdateRequestV2026)
2375
+ const localVarPath = `/entitlements/bulk-update`;
2376
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2377
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2378
+ let baseOptions;
2379
+ if (configuration) {
2380
+ baseOptions = configuration.baseOptions;
2381
+ }
2382
+
2383
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions};
2384
+ const localVarHeaderParameter = {} as any;
2385
+ const localVarQueryParameter = {} as any;
2386
+
2387
+ // authentication userAuth required
2388
+ // oauth required
2389
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2390
+
2391
+ // authentication userAuth required
2392
+ // oauth required
2393
+ await setOAuthToObject(localVarHeaderParameter, "userAuth", [], configuration)
2394
+
2395
+
2396
+
2397
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2398
+
2399
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2400
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2401
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers};
2402
+ localVarRequestOptions.data = serializeDataIfNeeded(entitlementBulkUpdateRequestV2026, localVarRequestOptions, configuration)
2403
+
2404
+ return {
2405
+ url: toPathString(localVarUrlObj),
2406
+ axiosOptions: localVarRequestOptions,
2407
+ };
2408
+ },
2409
+ }
2410
+ };
2411
+
2412
+ /**
2413
+ * EntitlementsV2026Api - functional programming interface
2414
+ * @export
2415
+ */
2416
+ export const EntitlementsV2026ApiFp = function(configuration?: Configuration) {
2417
+ const localVarAxiosParamCreator = EntitlementsV2026ApiAxiosParamCreator(configuration)
2418
+ return {
2419
+ /**
2420
+ * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
2421
+ * @summary Get entitlements for an account
2422
+ * @param {string} accountId The account ID to get entitlements for
2423
+ * @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.
2424
+ * @param {number} [offset] 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.
2425
+ * @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&#x3D;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.
2426
+ * @param {*} [axiosOptions] Override http request option.
2427
+ * @throws {RequiredError}
2428
+ */
2429
+ async getAccountEntitlements(accountId: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>> {
2430
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountEntitlements(accountId, limit, offset, count, axiosOptions);
2431
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2432
+ const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.getAccountEntitlements']?.[localVarOperationServerIndex]?.url;
2433
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2434
+ },
2435
+ /**
2436
+ * This API returns an entitlement by its ID.
2437
+ * @summary Get an entitlement
2438
+ * @param {string} id The entitlement ID
2439
+ * @param {*} [axiosOptions] Override http request option.
2440
+ * @throws {RequiredError}
2441
+ */
2442
+ async getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2026>> {
2443
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getEntitlement(id, axiosOptions);
2444
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2445
+ const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.getEntitlement']?.[localVarOperationServerIndex]?.url;
2446
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2447
+ },
2448
+ /**
2449
+ * This API returns a list of all child entitlements of a given entitlement.
2450
+ * @summary List of entitlements children
2451
+ * @param {string} id Entitlement Id
2452
+ * @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.
2453
+ * @param {number} [offset] 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.
2454
+ * @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&#x3D;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.
2455
+ * @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: **id, name, created, modified, type, attribute, value, source.id**
2456
+ * @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2457
+ * @param {*} [axiosOptions] Override http request option.
2458
+ * @throws {RequiredError}
2459
+ */
2460
+ async listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>> {
2461
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementChildren(id, limit, offset, count, sorters, filters, axiosOptions);
2462
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2463
+ const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.listEntitlementChildren']?.[localVarOperationServerIndex]?.url;
2464
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2465
+ },
2466
+ /**
2467
+ * This API returns a list of all parent entitlements of a given entitlement.
2468
+ * @summary List of entitlements parents
2469
+ * @param {string} id Entitlement Id
2470
+ * @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.
2471
+ * @param {number} [offset] 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.
2472
+ * @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&#x3D;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.
2473
+ * @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: **id, name, created, modified, type, attribute, value, source.id**
2474
+ * @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2475
+ * @param {*} [axiosOptions] Override http request option.
2476
+ * @throws {RequiredError}
2477
+ */
2478
+ async listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>> {
2479
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlementParents(id, limit, offset, count, sorters, filters, axiosOptions);
2480
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2481
+ const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.listEntitlementParents']?.[localVarOperationServerIndex]?.url;
2482
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2483
+ },
2484
+ /**
2485
+ * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
2486
+ * @summary Gets a list of entitlements.
2487
+ * @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\&#39;s Identity.
2488
+ * @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
2489
+ * @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented&#x3D;false** results in an error.
2490
+ * @param {number} [offset] 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.
2491
+ * @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.
2492
+ * @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&#x3D;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.
2493
+ * @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: **id, name, created, modified, type, attribute, value, source.id, requestable**
2494
+ * @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: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2495
+ * @param {*} [axiosOptions] Override http request option.
2496
+ * @throws {RequiredError}
2497
+ */
2498
+ async listEntitlements(segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>> {
2499
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listEntitlements(segmentedForIdentity, forSegmentIds, includeUnsegmented, offset, limit, count, sorters, filters, axiosOptions);
2500
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2501
+ const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.listEntitlements']?.[localVarOperationServerIndex]?.url;
2502
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2503
+ },
2504
+ /**
2505
+ * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
2506
+ * @summary Patch an entitlement
2507
+ * @param {string} id ID of the entitlement to patch
2508
+ * @param {Array<JsonPatchOperationV2026>} [jsonPatchOperationV2026]
2509
+ * @param {*} [axiosOptions] Override http request option.
2510
+ * @throws {RequiredError}
2511
+ */
2512
+ async patchEntitlement(id: string, jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2026>> {
2513
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchEntitlement(id, jsonPatchOperationV2026, axiosOptions);
2514
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2515
+ const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.patchEntitlement']?.[localVarOperationServerIndex]?.url;
2516
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2517
+ },
2518
+ /**
2519
+ * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
2520
+ * @summary Bulk update an entitlement list
2521
+ * @param {EntitlementBulkUpdateRequestV2026} entitlementBulkUpdateRequestV2026
2522
+ * @param {*} [axiosOptions] Override http request option.
2523
+ * @throws {RequiredError}
2524
+ */
2525
+ async updateEntitlementsInBulk(entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
2526
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateEntitlementsInBulk(entitlementBulkUpdateRequestV2026, axiosOptions);
2527
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2528
+ const localVarOperationServerBasePath = operationServerMap['EntitlementsV2026Api.updateEntitlementsInBulk']?.[localVarOperationServerIndex]?.url;
2529
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2530
+ },
2531
+ }
2532
+ };
2533
+
2534
+ /**
2535
+ * EntitlementsV2026Api - factory interface
2536
+ * @export
2537
+ */
2538
+ export const EntitlementsV2026ApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
2539
+ const localVarFp = EntitlementsV2026ApiFp(configuration)
2540
+ return {
2541
+ /**
2542
+ * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
2543
+ * @summary Get entitlements for an account
2544
+ * @param {EntitlementsV2026ApiGetAccountEntitlementsRequest} requestParameters Request parameters.
2545
+ * @param {*} [axiosOptions] Override http request option.
2546
+ * @throws {RequiredError}
2547
+ */
2548
+ getAccountEntitlements(requestParameters: EntitlementsV2026ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>> {
2549
+ return localVarFp.getAccountEntitlements(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(axios, basePath));
2550
+ },
2551
+ /**
2552
+ * This API returns an entitlement by its ID.
2553
+ * @summary Get an entitlement
2554
+ * @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters.
2555
+ * @param {*} [axiosOptions] Override http request option.
2556
+ * @throws {RequiredError}
2557
+ */
2558
+ getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementV2026> {
2559
+ return localVarFp.getEntitlement(requestParameters.id, axiosOptions).then((request) => request(axios, basePath));
2560
+ },
2561
+ /**
2562
+ * This API returns a list of all child entitlements of a given entitlement.
2563
+ * @summary List of entitlements children
2564
+ * @param {EntitlementsV2026ApiListEntitlementChildrenRequest} requestParameters Request parameters.
2565
+ * @param {*} [axiosOptions] Override http request option.
2566
+ * @throws {RequiredError}
2567
+ */
2568
+ listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>> {
2569
+ return localVarFp.listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath));
2570
+ },
2571
+ /**
2572
+ * This API returns a list of all parent entitlements of a given entitlement.
2573
+ * @summary List of entitlements parents
2574
+ * @param {EntitlementsV2026ApiListEntitlementParentsRequest} requestParameters Request parameters.
2575
+ * @param {*} [axiosOptions] Override http request option.
2576
+ * @throws {RequiredError}
2577
+ */
2578
+ listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>> {
2579
+ return localVarFp.listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath));
2580
+ },
2581
+ /**
2582
+ * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
2583
+ * @summary Gets a list of entitlements.
2584
+ * @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters.
2585
+ * @param {*} [axiosOptions] Override http request option.
2586
+ * @throws {RequiredError}
2587
+ */
2588
+ listEntitlements(requestParameters: EntitlementsV2026ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>> {
2589
+ return localVarFp.listEntitlements(requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(axios, basePath));
2590
+ },
2591
+ /**
2592
+ * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
2593
+ * @summary Patch an entitlement
2594
+ * @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters.
2595
+ * @param {*} [axiosOptions] Override http request option.
2596
+ * @throws {RequiredError}
2597
+ */
2598
+ patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementV2026> {
2599
+ return localVarFp.patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(axios, basePath));
2600
+ },
2601
+ /**
2602
+ * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
2603
+ * @summary Bulk update an entitlement list
2604
+ * @param {EntitlementsV2026ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
2605
+ * @param {*} [axiosOptions] Override http request option.
2606
+ * @throws {RequiredError}
2607
+ */
2608
+ updateEntitlementsInBulk(requestParameters: EntitlementsV2026ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void> {
2609
+ return localVarFp.updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2026, axiosOptions).then((request) => request(axios, basePath));
2610
+ },
2611
+ };
2612
+ };
2613
+
2614
+ /**
2615
+ * Request parameters for getAccountEntitlements operation in EntitlementsV2026Api.
2616
+ * @export
2617
+ * @interface EntitlementsV2026ApiGetAccountEntitlementsRequest
2618
+ */
2619
+ export interface EntitlementsV2026ApiGetAccountEntitlementsRequest {
2620
+ /**
2621
+ * The account ID to get entitlements for
2622
+ * @type {string}
2623
+ * @memberof EntitlementsV2026ApiGetAccountEntitlements
2624
+ */
2625
+ readonly accountId: string
2626
+
2627
+ /**
2628
+ * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
2629
+ * @type {number}
2630
+ * @memberof EntitlementsV2026ApiGetAccountEntitlements
2631
+ */
2632
+ readonly limit?: number
2633
+
2634
+ /**
2635
+ * 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.
2636
+ * @type {number}
2637
+ * @memberof EntitlementsV2026ApiGetAccountEntitlements
2638
+ */
2639
+ readonly offset?: number
2640
+
2641
+ /**
2642
+ * 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&#x3D;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.
2643
+ * @type {boolean}
2644
+ * @memberof EntitlementsV2026ApiGetAccountEntitlements
2645
+ */
2646
+ readonly count?: boolean
2647
+ }
2648
+
2649
+ /**
2650
+ * Request parameters for getEntitlement operation in EntitlementsV2026Api.
2651
+ * @export
2652
+ * @interface EntitlementsV2026ApiGetEntitlementRequest
2653
+ */
2654
+ export interface EntitlementsV2026ApiGetEntitlementRequest {
2655
+ /**
2656
+ * The entitlement ID
2657
+ * @type {string}
2658
+ * @memberof EntitlementsV2026ApiGetEntitlement
2659
+ */
2660
+ readonly id: string
2661
+ }
2662
+
2663
+ /**
2664
+ * Request parameters for listEntitlementChildren operation in EntitlementsV2026Api.
2665
+ * @export
2666
+ * @interface EntitlementsV2026ApiListEntitlementChildrenRequest
2667
+ */
2668
+ export interface EntitlementsV2026ApiListEntitlementChildrenRequest {
2669
+ /**
2670
+ * Entitlement Id
2671
+ * @type {string}
2672
+ * @memberof EntitlementsV2026ApiListEntitlementChildren
2673
+ */
2674
+ readonly id: string
2675
+
2676
+ /**
2677
+ * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
2678
+ * @type {number}
2679
+ * @memberof EntitlementsV2026ApiListEntitlementChildren
2680
+ */
2681
+ readonly limit?: number
2682
+
2683
+ /**
2684
+ * 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.
2685
+ * @type {number}
2686
+ * @memberof EntitlementsV2026ApiListEntitlementChildren
2687
+ */
2688
+ readonly offset?: number
2689
+
2690
+ /**
2691
+ * 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&#x3D;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.
2692
+ * @type {boolean}
2693
+ * @memberof EntitlementsV2026ApiListEntitlementChildren
2694
+ */
2695
+ readonly count?: boolean
2696
+
2697
+ /**
2698
+ * 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: **id, name, created, modified, type, attribute, value, source.id**
2699
+ * @type {string}
2700
+ * @memberof EntitlementsV2026ApiListEntitlementChildren
2701
+ */
2702
+ readonly sorters?: string
2703
+
2704
+ /**
2705
+ * 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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2706
+ * @type {string}
2707
+ * @memberof EntitlementsV2026ApiListEntitlementChildren
2708
+ */
2709
+ readonly filters?: string
2710
+ }
2711
+
2712
+ /**
2713
+ * Request parameters for listEntitlementParents operation in EntitlementsV2026Api.
2714
+ * @export
2715
+ * @interface EntitlementsV2026ApiListEntitlementParentsRequest
2716
+ */
2717
+ export interface EntitlementsV2026ApiListEntitlementParentsRequest {
2718
+ /**
2719
+ * Entitlement Id
2720
+ * @type {string}
2721
+ * @memberof EntitlementsV2026ApiListEntitlementParents
2722
+ */
2723
+ readonly id: string
2724
+
2725
+ /**
2726
+ * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
2727
+ * @type {number}
2728
+ * @memberof EntitlementsV2026ApiListEntitlementParents
2729
+ */
2730
+ readonly limit?: number
2731
+
2732
+ /**
2733
+ * 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.
2734
+ * @type {number}
2735
+ * @memberof EntitlementsV2026ApiListEntitlementParents
2736
+ */
2737
+ readonly offset?: number
2738
+
2739
+ /**
2740
+ * 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&#x3D;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.
2741
+ * @type {boolean}
2742
+ * @memberof EntitlementsV2026ApiListEntitlementParents
2743
+ */
2744
+ readonly count?: boolean
2745
+
2746
+ /**
2747
+ * 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: **id, name, created, modified, type, attribute, value, source.id**
2748
+ * @type {string}
2749
+ * @memberof EntitlementsV2026ApiListEntitlementParents
2750
+ */
2751
+ readonly sorters?: string
2752
+
2753
+ /**
2754
+ * 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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2755
+ * @type {string}
2756
+ * @memberof EntitlementsV2026ApiListEntitlementParents
2757
+ */
2758
+ readonly filters?: string
2759
+ }
2760
+
2761
+ /**
2762
+ * Request parameters for listEntitlements operation in EntitlementsV2026Api.
2763
+ * @export
2764
+ * @interface EntitlementsV2026ApiListEntitlementsRequest
2765
+ */
2766
+ export interface EntitlementsV2026ApiListEntitlementsRequest {
2767
+ /**
2768
+ * If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\&#39;s Identity.
2769
+ * @type {string}
2770
+ * @memberof EntitlementsV2026ApiListEntitlements
2771
+ */
2772
+ readonly segmentedForIdentity?: string
2773
+
2774
+ /**
2775
+ * If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
2776
+ * @type {string}
2777
+ * @memberof EntitlementsV2026ApiListEntitlements
2778
+ */
2779
+ readonly forSegmentIds?: string
2780
+
2781
+ /**
2782
+ * Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented&#x3D;false** results in an error.
2783
+ * @type {boolean}
2784
+ * @memberof EntitlementsV2026ApiListEntitlements
2785
+ */
2786
+ readonly includeUnsegmented?: boolean
2787
+
2788
+ /**
2789
+ * 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.
2790
+ * @type {number}
2791
+ * @memberof EntitlementsV2026ApiListEntitlements
2792
+ */
2793
+ readonly offset?: number
2794
+
2795
+ /**
2796
+ * Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
2797
+ * @type {number}
2798
+ * @memberof EntitlementsV2026ApiListEntitlements
2799
+ */
2800
+ readonly limit?: number
2801
+
2802
+ /**
2803
+ * 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&#x3D;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.
2804
+ * @type {boolean}
2805
+ * @memberof EntitlementsV2026ApiListEntitlements
2806
+ */
2807
+ readonly count?: boolean
2808
+
2809
+ /**
2810
+ * 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: **id, name, created, modified, type, attribute, value, source.id, requestable**
2811
+ * @type {string}
2812
+ * @memberof EntitlementsV2026ApiListEntitlements
2813
+ */
2814
+ readonly sorters?: string
2815
+
2816
+ /**
2817
+ * 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, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
2818
+ * @type {string}
2819
+ * @memberof EntitlementsV2026ApiListEntitlements
2820
+ */
2821
+ readonly filters?: string
2822
+ }
2823
+
2824
+ /**
2825
+ * Request parameters for patchEntitlement operation in EntitlementsV2026Api.
2826
+ * @export
2827
+ * @interface EntitlementsV2026ApiPatchEntitlementRequest
2828
+ */
2829
+ export interface EntitlementsV2026ApiPatchEntitlementRequest {
2830
+ /**
2831
+ * ID of the entitlement to patch
2832
+ * @type {string}
2833
+ * @memberof EntitlementsV2026ApiPatchEntitlement
2834
+ */
2835
+ readonly id: string
2836
+
2837
+ /**
2838
+ *
2839
+ * @type {Array<JsonPatchOperationV2026>}
2840
+ * @memberof EntitlementsV2026ApiPatchEntitlement
2841
+ */
2842
+ readonly jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>
2843
+ }
2844
+
2845
+ /**
2846
+ * Request parameters for updateEntitlementsInBulk operation in EntitlementsV2026Api.
2847
+ * @export
2848
+ * @interface EntitlementsV2026ApiUpdateEntitlementsInBulkRequest
2849
+ */
2850
+ export interface EntitlementsV2026ApiUpdateEntitlementsInBulkRequest {
2851
+ /**
2852
+ *
2853
+ * @type {EntitlementBulkUpdateRequestV2026}
2854
+ * @memberof EntitlementsV2026ApiUpdateEntitlementsInBulk
2855
+ */
2856
+ readonly entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026
2857
+ }
2858
+
2859
+ /**
2860
+ * EntitlementsV2026Api - object-oriented interface
2861
+ * @export
2862
+ * @class EntitlementsV2026Api
2863
+ * @extends {BaseAPI}
2864
+ */
2865
+ export class EntitlementsV2026Api extends BaseAPI {
2866
+ /**
2867
+ * This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
2868
+ * @summary Get entitlements for an account
2869
+ * @param {EntitlementsV2026ApiGetAccountEntitlementsRequest} requestParameters Request parameters.
2870
+ * @param {*} [axiosOptions] Override http request option.
2871
+ * @throws {RequiredError}
2872
+ * @memberof EntitlementsV2026Api
2873
+ */
2874
+ public getAccountEntitlements(requestParameters: EntitlementsV2026ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig) {
2875
+ return EntitlementsV2026ApiFp(this.configuration).getAccountEntitlements(requestParameters.accountId, requestParameters.limit, requestParameters.offset, requestParameters.count, axiosOptions).then((request) => request(this.axios, this.basePath));
2876
+ }
2877
+
2878
+ /**
2879
+ * This API returns an entitlement by its ID.
2880
+ * @summary Get an entitlement
2881
+ * @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters.
2882
+ * @param {*} [axiosOptions] Override http request option.
2883
+ * @throws {RequiredError}
2884
+ * @memberof EntitlementsV2026Api
2885
+ */
2886
+ public getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) {
2887
+ return EntitlementsV2026ApiFp(this.configuration).getEntitlement(requestParameters.id, axiosOptions).then((request) => request(this.axios, this.basePath));
2888
+ }
2889
+
2890
+ /**
2891
+ * This API returns a list of all child entitlements of a given entitlement.
2892
+ * @summary List of entitlements children
2893
+ * @param {EntitlementsV2026ApiListEntitlementChildrenRequest} requestParameters Request parameters.
2894
+ * @param {*} [axiosOptions] Override http request option.
2895
+ * @throws {RequiredError}
2896
+ * @memberof EntitlementsV2026Api
2897
+ */
2898
+ public listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig) {
2899
+ return EntitlementsV2026ApiFp(this.configuration).listEntitlementChildren(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath));
2900
+ }
2901
+
2902
+ /**
2903
+ * This API returns a list of all parent entitlements of a given entitlement.
2904
+ * @summary List of entitlements parents
2905
+ * @param {EntitlementsV2026ApiListEntitlementParentsRequest} requestParameters Request parameters.
2906
+ * @param {*} [axiosOptions] Override http request option.
2907
+ * @throws {RequiredError}
2908
+ * @memberof EntitlementsV2026Api
2909
+ */
2910
+ public listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig) {
2911
+ return EntitlementsV2026ApiFp(this.configuration).listEntitlementParents(requestParameters.id, requestParameters.limit, requestParameters.offset, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath));
2912
+ }
2913
+
2914
+ /**
2915
+ * This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
2916
+ * @summary Gets a list of entitlements.
2917
+ * @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters.
2918
+ * @param {*} [axiosOptions] Override http request option.
2919
+ * @throws {RequiredError}
2920
+ * @memberof EntitlementsV2026Api
2921
+ */
2922
+ public listEntitlements(requestParameters: EntitlementsV2026ApiListEntitlementsRequest = {}, axiosOptions?: RawAxiosRequestConfig) {
2923
+ return EntitlementsV2026ApiFp(this.configuration).listEntitlements(requestParameters.segmentedForIdentity, requestParameters.forSegmentIds, requestParameters.includeUnsegmented, requestParameters.offset, requestParameters.limit, requestParameters.count, requestParameters.sorters, requestParameters.filters, axiosOptions).then((request) => request(this.axios, this.basePath));
2924
+ }
2925
+
2926
+ /**
2927
+ * This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
2928
+ * @summary Patch an entitlement
2929
+ * @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters.
2930
+ * @param {*} [axiosOptions] Override http request option.
2931
+ * @throws {RequiredError}
2932
+ * @memberof EntitlementsV2026Api
2933
+ */
2934
+ public patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig) {
2935
+ return EntitlementsV2026ApiFp(this.configuration).patchEntitlement(requestParameters.id, requestParameters.jsonPatchOperationV2026, axiosOptions).then((request) => request(this.axios, this.basePath));
2936
+ }
2937
+
2938
+ /**
2939
+ * This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
2940
+ * @summary Bulk update an entitlement list
2941
+ * @param {EntitlementsV2026ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
2942
+ * @param {*} [axiosOptions] Override http request option.
2943
+ * @throws {RequiredError}
2944
+ * @memberof EntitlementsV2026Api
2945
+ */
2946
+ public updateEntitlementsInBulk(requestParameters: EntitlementsV2026ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig) {
2947
+ return EntitlementsV2026ApiFp(this.configuration).updateEntitlementsInBulk(requestParameters.entitlementBulkUpdateRequestV2026, axiosOptions).then((request) => request(this.axios, this.basePath));
2948
+ }
2949
+ }
2950
+
2951
+
2952
+
1622
2953
  /**
1623
2954
  * HumanAccountDeletionApprovalConfigV2026Api - axios parameter creator
1624
2955
  * @export