@sailpoint/api-client 2.2.4 → 2.2.5
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/dist/access_profiles/api.d.ts +457 -0
- package/dist/access_profiles/api.js +453 -1
- package/dist/access_profiles/api.js.map +1 -1
- package/dist/entitlements/api.d.ts +333 -0
- package/dist/entitlements/api.js +277 -1
- package/dist/entitlements/api.js.map +1 -1
- package/dist/esm/access_profiles/api.js +452 -0
- package/dist/esm/entitlements/api.js +276 -0
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/package.json +1 -1
|
@@ -780,6 +780,201 @@ export interface EntitlementV2Source {
|
|
|
780
780
|
*/
|
|
781
781
|
'name'?: string;
|
|
782
782
|
}
|
|
783
|
+
/**
|
|
784
|
+
* Request to bulk update Access Model Metadata on every entitlement matching a filter expression. Adding or replacing custom metadata requires a suite license.
|
|
785
|
+
* @export
|
|
786
|
+
* @interface Entitlementmetadatabulkupdatebyfilterrequest
|
|
787
|
+
*/
|
|
788
|
+
export interface Entitlementmetadatabulkupdatebyfilterrequest {
|
|
789
|
+
/**
|
|
790
|
+
* 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*
|
|
791
|
+
* @type {string}
|
|
792
|
+
* @memberof Entitlementmetadatabulkupdatebyfilterrequest
|
|
793
|
+
*/
|
|
794
|
+
'filters': string;
|
|
795
|
+
/**
|
|
796
|
+
* The operation to be performed
|
|
797
|
+
* @type {string}
|
|
798
|
+
* @memberof Entitlementmetadatabulkupdatebyfilterrequest
|
|
799
|
+
*/
|
|
800
|
+
'operation': EntitlementmetadatabulkupdatebyfilterrequestOperationEnum;
|
|
801
|
+
/**
|
|
802
|
+
* The choice of update scope. **ATTRIBUTE** replaces only the values of the attributes named in `values`, and **ALL** replaces every metadata attribute on the entitlement.
|
|
803
|
+
* @type {string}
|
|
804
|
+
* @memberof Entitlementmetadatabulkupdatebyfilterrequest
|
|
805
|
+
*/
|
|
806
|
+
'replaceScope'?: EntitlementmetadatabulkupdatebyfilterrequestReplaceScopeEnum;
|
|
807
|
+
/**
|
|
808
|
+
* The metadata to be updated, including attribute key and value.
|
|
809
|
+
* @type {Array<EntitlementmetadatabulkupdatebyidrequestValuesInner>}
|
|
810
|
+
* @memberof Entitlementmetadatabulkupdatebyfilterrequest
|
|
811
|
+
*/
|
|
812
|
+
'values': Array<EntitlementmetadatabulkupdatebyidrequestValuesInner>;
|
|
813
|
+
}
|
|
814
|
+
export declare const EntitlementmetadatabulkupdatebyfilterrequestOperationEnum: {
|
|
815
|
+
readonly Add: "ADD";
|
|
816
|
+
readonly Remove: "REMOVE";
|
|
817
|
+
readonly Replace: "REPLACE";
|
|
818
|
+
};
|
|
819
|
+
export type EntitlementmetadatabulkupdatebyfilterrequestOperationEnum = typeof EntitlementmetadatabulkupdatebyfilterrequestOperationEnum[keyof typeof EntitlementmetadatabulkupdatebyfilterrequestOperationEnum];
|
|
820
|
+
export declare const EntitlementmetadatabulkupdatebyfilterrequestReplaceScopeEnum: {
|
|
821
|
+
readonly All: "ALL";
|
|
822
|
+
readonly Attribute: "ATTRIBUTE";
|
|
823
|
+
};
|
|
824
|
+
export type EntitlementmetadatabulkupdatebyfilterrequestReplaceScopeEnum = typeof EntitlementmetadatabulkupdatebyfilterrequestReplaceScopeEnum[keyof typeof EntitlementmetadatabulkupdatebyfilterrequestReplaceScopeEnum];
|
|
825
|
+
/**
|
|
826
|
+
* Request to bulk update Access Model Metadata on a list of entitlements identified by ID. The maximum entitlement count in a single request is 3000. Adding or replacing custom metadata requires a suite license.
|
|
827
|
+
* @export
|
|
828
|
+
* @interface Entitlementmetadatabulkupdatebyidrequest
|
|
829
|
+
*/
|
|
830
|
+
export interface Entitlementmetadatabulkupdatebyidrequest {
|
|
831
|
+
/**
|
|
832
|
+
* The IDs of the entitlements to update.
|
|
833
|
+
* @type {Array<string>}
|
|
834
|
+
* @memberof Entitlementmetadatabulkupdatebyidrequest
|
|
835
|
+
*/
|
|
836
|
+
'entitlements': Array<string>;
|
|
837
|
+
/**
|
|
838
|
+
* The operation to be performed
|
|
839
|
+
* @type {string}
|
|
840
|
+
* @memberof Entitlementmetadatabulkupdatebyidrequest
|
|
841
|
+
*/
|
|
842
|
+
'operation': EntitlementmetadatabulkupdatebyidrequestOperationEnum;
|
|
843
|
+
/**
|
|
844
|
+
* The choice of update scope. **ATTRIBUTE** replaces only the values of the attributes named in `values`, and **ALL** replaces every metadata attribute on the entitlement.
|
|
845
|
+
* @type {string}
|
|
846
|
+
* @memberof Entitlementmetadatabulkupdatebyidrequest
|
|
847
|
+
*/
|
|
848
|
+
'replaceScope'?: EntitlementmetadatabulkupdatebyidrequestReplaceScopeEnum;
|
|
849
|
+
/**
|
|
850
|
+
* The metadata to be updated, including attribute key and value.
|
|
851
|
+
* @type {Array<EntitlementmetadatabulkupdatebyidrequestValuesInner>}
|
|
852
|
+
* @memberof Entitlementmetadatabulkupdatebyidrequest
|
|
853
|
+
*/
|
|
854
|
+
'values': Array<EntitlementmetadatabulkupdatebyidrequestValuesInner>;
|
|
855
|
+
}
|
|
856
|
+
export declare const EntitlementmetadatabulkupdatebyidrequestOperationEnum: {
|
|
857
|
+
readonly Add: "ADD";
|
|
858
|
+
readonly Remove: "REMOVE";
|
|
859
|
+
readonly Replace: "REPLACE";
|
|
860
|
+
};
|
|
861
|
+
export type EntitlementmetadatabulkupdatebyidrequestOperationEnum = typeof EntitlementmetadatabulkupdatebyidrequestOperationEnum[keyof typeof EntitlementmetadatabulkupdatebyidrequestOperationEnum];
|
|
862
|
+
export declare const EntitlementmetadatabulkupdatebyidrequestReplaceScopeEnum: {
|
|
863
|
+
readonly All: "ALL";
|
|
864
|
+
readonly Attribute: "ATTRIBUTE";
|
|
865
|
+
};
|
|
866
|
+
export type EntitlementmetadatabulkupdatebyidrequestReplaceScopeEnum = typeof EntitlementmetadatabulkupdatebyidrequestReplaceScopeEnum[keyof typeof EntitlementmetadatabulkupdatebyidrequestReplaceScopeEnum];
|
|
867
|
+
/**
|
|
868
|
+
*
|
|
869
|
+
* @export
|
|
870
|
+
* @interface EntitlementmetadatabulkupdatebyidrequestValuesInner
|
|
871
|
+
*/
|
|
872
|
+
export interface EntitlementmetadatabulkupdatebyidrequestValuesInner {
|
|
873
|
+
/**
|
|
874
|
+
* The technical name of the metadata attribute.
|
|
875
|
+
* @type {string}
|
|
876
|
+
* @memberof EntitlementmetadatabulkupdatebyidrequestValuesInner
|
|
877
|
+
*/
|
|
878
|
+
'attribute': string;
|
|
879
|
+
/**
|
|
880
|
+
* The values of the attribute to be updated.
|
|
881
|
+
* @type {Array<string>}
|
|
882
|
+
* @memberof EntitlementmetadatabulkupdatebyidrequestValuesInner
|
|
883
|
+
*/
|
|
884
|
+
'values': Array<string> | null;
|
|
885
|
+
/**
|
|
886
|
+
* The type of the metadata attribute. Set to `custom` for custom metadata attributes, which require a suite license.
|
|
887
|
+
* @type {string}
|
|
888
|
+
* @memberof EntitlementmetadatabulkupdatebyidrequestValuesInner
|
|
889
|
+
*/
|
|
890
|
+
'objectType'?: string;
|
|
891
|
+
}
|
|
892
|
+
/**
|
|
893
|
+
* Request to bulk update Access Model Metadata on every entitlement matching a search query. Adding or replacing custom metadata requires a suite license. For more information about the query object, refer to [V3 API Perform Search](https://developer.sailpoint.com/docs/api/v3/search-post).
|
|
894
|
+
* @export
|
|
895
|
+
* @interface Entitlementmetadatabulkupdatebyqueryrequest
|
|
896
|
+
*/
|
|
897
|
+
export interface Entitlementmetadatabulkupdatebyqueryrequest {
|
|
898
|
+
/**
|
|
899
|
+
* The search query selecting the entitlements to update.
|
|
900
|
+
* @type {object}
|
|
901
|
+
* @memberof Entitlementmetadatabulkupdatebyqueryrequest
|
|
902
|
+
*/
|
|
903
|
+
'query': object;
|
|
904
|
+
/**
|
|
905
|
+
* The operation to be performed
|
|
906
|
+
* @type {string}
|
|
907
|
+
* @memberof Entitlementmetadatabulkupdatebyqueryrequest
|
|
908
|
+
*/
|
|
909
|
+
'operation': EntitlementmetadatabulkupdatebyqueryrequestOperationEnum;
|
|
910
|
+
/**
|
|
911
|
+
* The choice of update scope. **ATTRIBUTE** replaces only the values of the attributes named in `values`, and **ALL** replaces every metadata attribute on the entitlement.
|
|
912
|
+
* @type {string}
|
|
913
|
+
* @memberof Entitlementmetadatabulkupdatebyqueryrequest
|
|
914
|
+
*/
|
|
915
|
+
'replaceScope'?: EntitlementmetadatabulkupdatebyqueryrequestReplaceScopeEnum;
|
|
916
|
+
/**
|
|
917
|
+
* The metadata to be updated, including attribute key and value.
|
|
918
|
+
* @type {Array<EntitlementmetadatabulkupdatebyidrequestValuesInner>}
|
|
919
|
+
* @memberof Entitlementmetadatabulkupdatebyqueryrequest
|
|
920
|
+
*/
|
|
921
|
+
'values': Array<EntitlementmetadatabulkupdatebyidrequestValuesInner>;
|
|
922
|
+
}
|
|
923
|
+
export declare const EntitlementmetadatabulkupdatebyqueryrequestOperationEnum: {
|
|
924
|
+
readonly Add: "ADD";
|
|
925
|
+
readonly Remove: "REMOVE";
|
|
926
|
+
readonly Replace: "REPLACE";
|
|
927
|
+
};
|
|
928
|
+
export type EntitlementmetadatabulkupdatebyqueryrequestOperationEnum = typeof EntitlementmetadatabulkupdatebyqueryrequestOperationEnum[keyof typeof EntitlementmetadatabulkupdatebyqueryrequestOperationEnum];
|
|
929
|
+
export declare const EntitlementmetadatabulkupdatebyqueryrequestReplaceScopeEnum: {
|
|
930
|
+
readonly All: "ALL";
|
|
931
|
+
readonly Attribute: "ATTRIBUTE";
|
|
932
|
+
};
|
|
933
|
+
export type EntitlementmetadatabulkupdatebyqueryrequestReplaceScopeEnum = typeof EntitlementmetadatabulkupdatebyqueryrequestReplaceScopeEnum[keyof typeof EntitlementmetadatabulkupdatebyqueryrequestReplaceScopeEnum];
|
|
934
|
+
/**
|
|
935
|
+
*
|
|
936
|
+
* @export
|
|
937
|
+
* @interface Entitlementmetadatabulkupdateresponse
|
|
938
|
+
*/
|
|
939
|
+
export interface Entitlementmetadatabulkupdateresponse {
|
|
940
|
+
/**
|
|
941
|
+
* ID of the task that is processing the bulk update.
|
|
942
|
+
* @type {string}
|
|
943
|
+
* @memberof Entitlementmetadatabulkupdateresponse
|
|
944
|
+
*/
|
|
945
|
+
'id'?: string;
|
|
946
|
+
/**
|
|
947
|
+
* Type of the object the bulk update applies to.
|
|
948
|
+
* @type {string}
|
|
949
|
+
* @memberof Entitlementmetadatabulkupdateresponse
|
|
950
|
+
*/
|
|
951
|
+
'type'?: string;
|
|
952
|
+
/**
|
|
953
|
+
* The status of the bulk update request.
|
|
954
|
+
* @type {string}
|
|
955
|
+
* @memberof Entitlementmetadatabulkupdateresponse
|
|
956
|
+
*/
|
|
957
|
+
'status'?: EntitlementmetadatabulkupdateresponseStatusEnum;
|
|
958
|
+
/**
|
|
959
|
+
* Time when the bulk update request was created
|
|
960
|
+
* @type {string}
|
|
961
|
+
* @memberof Entitlementmetadatabulkupdateresponse
|
|
962
|
+
*/
|
|
963
|
+
'created'?: string;
|
|
964
|
+
}
|
|
965
|
+
export declare const EntitlementmetadatabulkupdateresponseStatusEnum: {
|
|
966
|
+
readonly Created: "CREATED";
|
|
967
|
+
readonly PreProcess: "PRE_PROCESS";
|
|
968
|
+
readonly PreProcessCompleted: "PRE_PROCESS_COMPLETED";
|
|
969
|
+
readonly PostProcess: "POST_PROCESS";
|
|
970
|
+
readonly Completed: "COMPLETED";
|
|
971
|
+
readonly ChunkPending: "CHUNK_PENDING";
|
|
972
|
+
readonly ChunkProcessing: "CHUNK_PROCESSING";
|
|
973
|
+
readonly ReProcessing: "RE_PROCESSING";
|
|
974
|
+
readonly PreProcessFailed: "PRE_PROCESS_FAILED";
|
|
975
|
+
readonly Failed: "FAILED";
|
|
976
|
+
};
|
|
977
|
+
export type EntitlementmetadatabulkupdateresponseStatusEnum = typeof EntitlementmetadatabulkupdateresponseStatusEnum[keyof typeof EntitlementmetadatabulkupdateresponseStatusEnum];
|
|
783
978
|
/**
|
|
784
979
|
*
|
|
785
980
|
* @export
|
|
@@ -1154,6 +1349,30 @@ export declare const EntitlementsApiAxiosParamCreator: (configuration?: Configur
|
|
|
1154
1349
|
* @throws {RequiredError}
|
|
1155
1350
|
*/
|
|
1156
1351
|
updateEntitlementsInBulkV1: (entitlementBulkUpdateRequest: EntitlementBulkUpdateRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1352
|
+
/**
|
|
1353
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByFilterV1` operation.
|
|
1354
|
+
* @summary Bulk-update metadata by filter
|
|
1355
|
+
* @param {Entitlementmetadatabulkupdatebyfilterrequest} entitlementmetadatabulkupdatebyfilterrequest Attribute metadata bulk update request body.
|
|
1356
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1357
|
+
* @throws {RequiredError}
|
|
1358
|
+
*/
|
|
1359
|
+
updateEntitlementsMetadataByFilterV1: (entitlementmetadatabulkupdatebyfilterrequest: Entitlementmetadatabulkupdatebyfilterrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1360
|
+
/**
|
|
1361
|
+
* This API initiates a bulk update of Access Model Metadata for one or more entitlements by a list of entitlement IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum entitlement count in a single request is 3000. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByIdsV1` operation.
|
|
1362
|
+
* @summary Bulk-update metadata by ids
|
|
1363
|
+
* @param {Entitlementmetadatabulkupdatebyidrequest} entitlementmetadatabulkupdatebyidrequest Attribute metadata bulk update request body.
|
|
1364
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1365
|
+
* @throws {RequiredError}
|
|
1366
|
+
*/
|
|
1367
|
+
updateEntitlementsMetadataByIdsV1: (entitlementmetadatabulkupdatebyidrequest: Entitlementmetadatabulkupdatebyidrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1368
|
+
/**
|
|
1369
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByQueryV1` operation.
|
|
1370
|
+
* @summary Bulk-update metadata by query
|
|
1371
|
+
* @param {Entitlementmetadatabulkupdatebyqueryrequest} entitlementmetadatabulkupdatebyqueryrequest Attribute metadata bulk update request body.
|
|
1372
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1373
|
+
* @throws {RequiredError}
|
|
1374
|
+
*/
|
|
1375
|
+
updateEntitlementsMetadataByQueryV1: (entitlementmetadatabulkupdatebyqueryrequest: Entitlementmetadatabulkupdatebyqueryrequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1157
1376
|
};
|
|
1158
1377
|
/**
|
|
1159
1378
|
* EntitlementsApi - functional programming interface
|
|
@@ -1297,6 +1516,30 @@ export declare const EntitlementsApiFp: (configuration?: Configuration) => {
|
|
|
1297
1516
|
* @throws {RequiredError}
|
|
1298
1517
|
*/
|
|
1299
1518
|
updateEntitlementsInBulkV1(entitlementBulkUpdateRequest: EntitlementBulkUpdateRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1519
|
+
/**
|
|
1520
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByFilterV1` operation.
|
|
1521
|
+
* @summary Bulk-update metadata by filter
|
|
1522
|
+
* @param {Entitlementmetadatabulkupdatebyfilterrequest} entitlementmetadatabulkupdatebyfilterrequest Attribute metadata bulk update request body.
|
|
1523
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1524
|
+
* @throws {RequiredError}
|
|
1525
|
+
*/
|
|
1526
|
+
updateEntitlementsMetadataByFilterV1(entitlementmetadatabulkupdatebyfilterrequest: Entitlementmetadatabulkupdatebyfilterrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entitlementmetadatabulkupdateresponse>>;
|
|
1527
|
+
/**
|
|
1528
|
+
* This API initiates a bulk update of Access Model Metadata for one or more entitlements by a list of entitlement IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum entitlement count in a single request is 3000. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByIdsV1` operation.
|
|
1529
|
+
* @summary Bulk-update metadata by ids
|
|
1530
|
+
* @param {Entitlementmetadatabulkupdatebyidrequest} entitlementmetadatabulkupdatebyidrequest Attribute metadata bulk update request body.
|
|
1531
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1532
|
+
* @throws {RequiredError}
|
|
1533
|
+
*/
|
|
1534
|
+
updateEntitlementsMetadataByIdsV1(entitlementmetadatabulkupdatebyidrequest: Entitlementmetadatabulkupdatebyidrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entitlementmetadatabulkupdateresponse>>;
|
|
1535
|
+
/**
|
|
1536
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByQueryV1` operation.
|
|
1537
|
+
* @summary Bulk-update metadata by query
|
|
1538
|
+
* @param {Entitlementmetadatabulkupdatebyqueryrequest} entitlementmetadatabulkupdatebyqueryrequest Attribute metadata bulk update request body.
|
|
1539
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1540
|
+
* @throws {RequiredError}
|
|
1541
|
+
*/
|
|
1542
|
+
updateEntitlementsMetadataByQueryV1(entitlementmetadatabulkupdatebyqueryrequest: Entitlementmetadatabulkupdatebyqueryrequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Entitlementmetadatabulkupdateresponse>>;
|
|
1300
1543
|
};
|
|
1301
1544
|
/**
|
|
1302
1545
|
* EntitlementsApi - factory interface
|
|
@@ -1408,6 +1651,30 @@ export declare const EntitlementsApiFactory: (configuration?: Configuration, bas
|
|
|
1408
1651
|
* @throws {RequiredError}
|
|
1409
1652
|
*/
|
|
1410
1653
|
updateEntitlementsInBulkV1(requestParameters: EntitlementsApiUpdateEntitlementsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1654
|
+
/**
|
|
1655
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByFilterV1` operation.
|
|
1656
|
+
* @summary Bulk-update metadata by filter
|
|
1657
|
+
* @param {EntitlementsApiUpdateEntitlementsMetadataByFilterV1Request} requestParameters Request parameters.
|
|
1658
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1659
|
+
* @throws {RequiredError}
|
|
1660
|
+
*/
|
|
1661
|
+
updateEntitlementsMetadataByFilterV1(requestParameters: EntitlementsApiUpdateEntitlementsMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Entitlementmetadatabulkupdateresponse>;
|
|
1662
|
+
/**
|
|
1663
|
+
* This API initiates a bulk update of Access Model Metadata for one or more entitlements by a list of entitlement IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum entitlement count in a single request is 3000. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByIdsV1` operation.
|
|
1664
|
+
* @summary Bulk-update metadata by ids
|
|
1665
|
+
* @param {EntitlementsApiUpdateEntitlementsMetadataByIdsV1Request} requestParameters Request parameters.
|
|
1666
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1667
|
+
* @throws {RequiredError}
|
|
1668
|
+
*/
|
|
1669
|
+
updateEntitlementsMetadataByIdsV1(requestParameters: EntitlementsApiUpdateEntitlementsMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Entitlementmetadatabulkupdateresponse>;
|
|
1670
|
+
/**
|
|
1671
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByQueryV1` operation.
|
|
1672
|
+
* @summary Bulk-update metadata by query
|
|
1673
|
+
* @param {EntitlementsApiUpdateEntitlementsMetadataByQueryV1Request} requestParameters Request parameters.
|
|
1674
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1675
|
+
* @throws {RequiredError}
|
|
1676
|
+
*/
|
|
1677
|
+
updateEntitlementsMetadataByQueryV1(requestParameters: EntitlementsApiUpdateEntitlementsMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Entitlementmetadatabulkupdateresponse>;
|
|
1411
1678
|
};
|
|
1412
1679
|
/**
|
|
1413
1680
|
* Request parameters for createAccessModelMetadataForEntitlementV1 operation in EntitlementsApi.
|
|
@@ -1770,6 +2037,45 @@ export interface EntitlementsApiUpdateEntitlementsInBulkV1Request {
|
|
|
1770
2037
|
*/
|
|
1771
2038
|
readonly entitlementBulkUpdateRequest: EntitlementBulkUpdateRequest;
|
|
1772
2039
|
}
|
|
2040
|
+
/**
|
|
2041
|
+
* Request parameters for updateEntitlementsMetadataByFilterV1 operation in EntitlementsApi.
|
|
2042
|
+
* @export
|
|
2043
|
+
* @interface EntitlementsApiUpdateEntitlementsMetadataByFilterV1Request
|
|
2044
|
+
*/
|
|
2045
|
+
export interface EntitlementsApiUpdateEntitlementsMetadataByFilterV1Request {
|
|
2046
|
+
/**
|
|
2047
|
+
* Attribute metadata bulk update request body.
|
|
2048
|
+
* @type {Entitlementmetadatabulkupdatebyfilterrequest}
|
|
2049
|
+
* @memberof EntitlementsApiUpdateEntitlementsMetadataByFilterV1
|
|
2050
|
+
*/
|
|
2051
|
+
readonly entitlementmetadatabulkupdatebyfilterrequest: Entitlementmetadatabulkupdatebyfilterrequest;
|
|
2052
|
+
}
|
|
2053
|
+
/**
|
|
2054
|
+
* Request parameters for updateEntitlementsMetadataByIdsV1 operation in EntitlementsApi.
|
|
2055
|
+
* @export
|
|
2056
|
+
* @interface EntitlementsApiUpdateEntitlementsMetadataByIdsV1Request
|
|
2057
|
+
*/
|
|
2058
|
+
export interface EntitlementsApiUpdateEntitlementsMetadataByIdsV1Request {
|
|
2059
|
+
/**
|
|
2060
|
+
* Attribute metadata bulk update request body.
|
|
2061
|
+
* @type {Entitlementmetadatabulkupdatebyidrequest}
|
|
2062
|
+
* @memberof EntitlementsApiUpdateEntitlementsMetadataByIdsV1
|
|
2063
|
+
*/
|
|
2064
|
+
readonly entitlementmetadatabulkupdatebyidrequest: Entitlementmetadatabulkupdatebyidrequest;
|
|
2065
|
+
}
|
|
2066
|
+
/**
|
|
2067
|
+
* Request parameters for updateEntitlementsMetadataByQueryV1 operation in EntitlementsApi.
|
|
2068
|
+
* @export
|
|
2069
|
+
* @interface EntitlementsApiUpdateEntitlementsMetadataByQueryV1Request
|
|
2070
|
+
*/
|
|
2071
|
+
export interface EntitlementsApiUpdateEntitlementsMetadataByQueryV1Request {
|
|
2072
|
+
/**
|
|
2073
|
+
* Attribute metadata bulk update request body.
|
|
2074
|
+
* @type {Entitlementmetadatabulkupdatebyqueryrequest}
|
|
2075
|
+
* @memberof EntitlementsApiUpdateEntitlementsMetadataByQueryV1
|
|
2076
|
+
*/
|
|
2077
|
+
readonly entitlementmetadatabulkupdatebyqueryrequest: Entitlementmetadatabulkupdatebyqueryrequest;
|
|
2078
|
+
}
|
|
1773
2079
|
/**
|
|
1774
2080
|
* EntitlementsApi - object-oriented interface
|
|
1775
2081
|
* @export
|
|
@@ -1895,4 +2201,31 @@ export declare class EntitlementsApi extends BaseAPI {
|
|
|
1895
2201
|
* @memberof EntitlementsApi
|
|
1896
2202
|
*/
|
|
1897
2203
|
updateEntitlementsInBulkV1(requestParameters: EntitlementsApiUpdateEntitlementsInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2204
|
+
/**
|
|
2205
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByFilterV1` operation.
|
|
2206
|
+
* @summary Bulk-update metadata by filter
|
|
2207
|
+
* @param {EntitlementsApiUpdateEntitlementsMetadataByFilterV1Request} requestParameters Request parameters.
|
|
2208
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2209
|
+
* @throws {RequiredError}
|
|
2210
|
+
* @memberof EntitlementsApi
|
|
2211
|
+
*/
|
|
2212
|
+
updateEntitlementsMetadataByFilterV1(requestParameters: EntitlementsApiUpdateEntitlementsMetadataByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlementmetadatabulkupdateresponse, any>>;
|
|
2213
|
+
/**
|
|
2214
|
+
* This API initiates a bulk update of Access Model Metadata for one or more entitlements by a list of entitlement IDs. The update is processed asynchronously. The response returns the ID of the task performing the update. The maximum entitlement count in a single request is 3000. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByIdsV1` operation.
|
|
2215
|
+
* @summary Bulk-update metadata by ids
|
|
2216
|
+
* @param {EntitlementsApiUpdateEntitlementsMetadataByIdsV1Request} requestParameters Request parameters.
|
|
2217
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2218
|
+
* @throws {RequiredError}
|
|
2219
|
+
* @memberof EntitlementsApi
|
|
2220
|
+
*/
|
|
2221
|
+
updateEntitlementsMetadataByIdsV1(requestParameters: EntitlementsApiUpdateEntitlementsMetadataByIdsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlementmetadatabulkupdateresponse, any>>;
|
|
2222
|
+
/**
|
|
2223
|
+
* This API initiates a bulk update of Access Model Metadata for every entitlement matching the supplied search query. The update is processed asynchronously. The response returns the ID of the task performing the update. Adding or replacing custom metadata requires a suite license. This API replaces the deprecated `updateAccessModelMetadataByQueryV1` operation.
|
|
2224
|
+
* @summary Bulk-update metadata by query
|
|
2225
|
+
* @param {EntitlementsApiUpdateEntitlementsMetadataByQueryV1Request} requestParameters Request parameters.
|
|
2226
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2227
|
+
* @throws {RequiredError}
|
|
2228
|
+
* @memberof EntitlementsApi
|
|
2229
|
+
*/
|
|
2230
|
+
updateEntitlementsMetadataByQueryV1(requestParameters: EntitlementsApiUpdateEntitlementsMetadataByQueryV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlementmetadatabulkupdateresponse, any>>;
|
|
1898
2231
|
}
|