system-initiative-api-client 1.11.0 → 1.13.0
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/cjs/api.d.ts +445 -2
- package/dist/cjs/api.js +169 -7
- package/dist/esm/api.d.ts +445 -2
- package/dist/esm/api.js +163 -5
- package/package.json +2 -2
package/dist/esm/api.js
CHANGED
|
@@ -1332,10 +1332,20 @@ export const ComponentsApiAxiosParamCreator = function (configuration) {
|
|
|
1332
1332
|
* @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
|
|
1333
1333
|
* @param {string} [cursor] Cursor for pagination (ComponentId of the last item from previous page)
|
|
1334
1334
|
* @param {boolean} [includeCodegen] Allow returning the codegen for the cloudformation template for the component (if it exists)
|
|
1335
|
+
* @param {boolean} [includeAll] Include all graph summary data (equivalent to enabling all include options)
|
|
1336
|
+
* @param {boolean} [includeFunctions] Include all function types (action, management, qualification)
|
|
1337
|
+
* @param {boolean} [includeSubscriptions] Include subscription relationships
|
|
1338
|
+
* @param {boolean} [includeManages] Include management relationships
|
|
1339
|
+
* @param {boolean} [includeActionFunctions] Include action function relationships
|
|
1340
|
+
* @param {boolean} [includeManagementFunctions] Include management function relationships
|
|
1341
|
+
* @param {boolean} [includeQualificationFunctions] Include qualification function relationships
|
|
1342
|
+
* @param {boolean} [includeResourceInfo] Include resource information (resource ID and status)
|
|
1343
|
+
* @param {boolean} [includeDiffStatus] Include component diff status vs HEAD (Added/Modified/None)
|
|
1344
|
+
* @param {boolean} [includeExecutionHistory] Include last 10 execution history entries for each function
|
|
1335
1345
|
* @param {*} [options] Override http request option.
|
|
1336
1346
|
* @throws {RequiredError}
|
|
1337
1347
|
*/
|
|
1338
|
-
listComponents: async (workspaceId, changeSetId, limit, cursor, includeCodegen, options = {}) => {
|
|
1348
|
+
listComponents: async (workspaceId, changeSetId, limit, cursor, includeCodegen, includeAll, includeFunctions, includeSubscriptions, includeManages, includeActionFunctions, includeManagementFunctions, includeQualificationFunctions, includeResourceInfo, includeDiffStatus, includeExecutionHistory, options = {}) => {
|
|
1339
1349
|
// verify required parameter 'workspaceId' is not null or undefined
|
|
1340
1350
|
assertParamExists('listComponents', 'workspaceId', workspaceId);
|
|
1341
1351
|
// verify required parameter 'changeSetId' is not null or undefined
|
|
@@ -1361,6 +1371,36 @@ export const ComponentsApiAxiosParamCreator = function (configuration) {
|
|
|
1361
1371
|
if (includeCodegen !== undefined) {
|
|
1362
1372
|
localVarQueryParameter['includeCodegen'] = includeCodegen;
|
|
1363
1373
|
}
|
|
1374
|
+
if (includeAll !== undefined) {
|
|
1375
|
+
localVarQueryParameter['includeAll'] = includeAll;
|
|
1376
|
+
}
|
|
1377
|
+
if (includeFunctions !== undefined) {
|
|
1378
|
+
localVarQueryParameter['includeFunctions'] = includeFunctions;
|
|
1379
|
+
}
|
|
1380
|
+
if (includeSubscriptions !== undefined) {
|
|
1381
|
+
localVarQueryParameter['includeSubscriptions'] = includeSubscriptions;
|
|
1382
|
+
}
|
|
1383
|
+
if (includeManages !== undefined) {
|
|
1384
|
+
localVarQueryParameter['includeManages'] = includeManages;
|
|
1385
|
+
}
|
|
1386
|
+
if (includeActionFunctions !== undefined) {
|
|
1387
|
+
localVarQueryParameter['includeActionFunctions'] = includeActionFunctions;
|
|
1388
|
+
}
|
|
1389
|
+
if (includeManagementFunctions !== undefined) {
|
|
1390
|
+
localVarQueryParameter['includeManagementFunctions'] = includeManagementFunctions;
|
|
1391
|
+
}
|
|
1392
|
+
if (includeQualificationFunctions !== undefined) {
|
|
1393
|
+
localVarQueryParameter['includeQualificationFunctions'] = includeQualificationFunctions;
|
|
1394
|
+
}
|
|
1395
|
+
if (includeResourceInfo !== undefined) {
|
|
1396
|
+
localVarQueryParameter['includeResourceInfo'] = includeResourceInfo;
|
|
1397
|
+
}
|
|
1398
|
+
if (includeDiffStatus !== undefined) {
|
|
1399
|
+
localVarQueryParameter['includeDiffStatus'] = includeDiffStatus;
|
|
1400
|
+
}
|
|
1401
|
+
if (includeExecutionHistory !== undefined) {
|
|
1402
|
+
localVarQueryParameter['includeExecutionHistory'] = includeExecutionHistory;
|
|
1403
|
+
}
|
|
1364
1404
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1365
1405
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1366
1406
|
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
@@ -1735,11 +1775,21 @@ export const ComponentsApiFp = function (configuration) {
|
|
|
1735
1775
|
* @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
|
|
1736
1776
|
* @param {string} [cursor] Cursor for pagination (ComponentId of the last item from previous page)
|
|
1737
1777
|
* @param {boolean} [includeCodegen] Allow returning the codegen for the cloudformation template for the component (if it exists)
|
|
1778
|
+
* @param {boolean} [includeAll] Include all graph summary data (equivalent to enabling all include options)
|
|
1779
|
+
* @param {boolean} [includeFunctions] Include all function types (action, management, qualification)
|
|
1780
|
+
* @param {boolean} [includeSubscriptions] Include subscription relationships
|
|
1781
|
+
* @param {boolean} [includeManages] Include management relationships
|
|
1782
|
+
* @param {boolean} [includeActionFunctions] Include action function relationships
|
|
1783
|
+
* @param {boolean} [includeManagementFunctions] Include management function relationships
|
|
1784
|
+
* @param {boolean} [includeQualificationFunctions] Include qualification function relationships
|
|
1785
|
+
* @param {boolean} [includeResourceInfo] Include resource information (resource ID and status)
|
|
1786
|
+
* @param {boolean} [includeDiffStatus] Include component diff status vs HEAD (Added/Modified/None)
|
|
1787
|
+
* @param {boolean} [includeExecutionHistory] Include last 10 execution history entries for each function
|
|
1738
1788
|
* @param {*} [options] Override http request option.
|
|
1739
1789
|
* @throws {RequiredError}
|
|
1740
1790
|
*/
|
|
1741
|
-
async listComponents(workspaceId, changeSetId, limit, cursor, includeCodegen, options) {
|
|
1742
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listComponents(workspaceId, changeSetId, limit, cursor, includeCodegen, options);
|
|
1791
|
+
async listComponents(workspaceId, changeSetId, limit, cursor, includeCodegen, includeAll, includeFunctions, includeSubscriptions, includeManages, includeActionFunctions, includeManagementFunctions, includeQualificationFunctions, includeResourceInfo, includeDiffStatus, includeExecutionHistory, options) {
|
|
1792
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listComponents(workspaceId, changeSetId, limit, cursor, includeCodegen, includeAll, includeFunctions, includeSubscriptions, includeManages, includeActionFunctions, includeManagementFunctions, includeQualificationFunctions, includeResourceInfo, includeDiffStatus, includeExecutionHistory, options);
|
|
1743
1793
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1744
1794
|
const localVarOperationServerBasePath = operationServerMap['ComponentsApi.listComponents']?.[localVarOperationServerIndex]?.url;
|
|
1745
1795
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1938,7 +1988,7 @@ export const ComponentsApiFactory = function (configuration, basePath, axios) {
|
|
|
1938
1988
|
* @throws {RequiredError}
|
|
1939
1989
|
*/
|
|
1940
1990
|
listComponents(requestParameters, options) {
|
|
1941
|
-
return localVarFp.listComponents(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.limit, requestParameters.cursor, requestParameters.includeCodegen, options).then((request) => request(axios, basePath));
|
|
1991
|
+
return localVarFp.listComponents(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.limit, requestParameters.cursor, requestParameters.includeCodegen, requestParameters.includeAll, requestParameters.includeFunctions, requestParameters.includeSubscriptions, requestParameters.includeManages, requestParameters.includeActionFunctions, requestParameters.includeManagementFunctions, requestParameters.includeQualificationFunctions, requestParameters.includeResourceInfo, requestParameters.includeDiffStatus, requestParameters.includeExecutionHistory, options).then((request) => request(axios, basePath));
|
|
1942
1992
|
},
|
|
1943
1993
|
/**
|
|
1944
1994
|
*
|
|
@@ -2118,7 +2168,7 @@ export class ComponentsApi extends BaseAPI {
|
|
|
2118
2168
|
* @memberof ComponentsApi
|
|
2119
2169
|
*/
|
|
2120
2170
|
listComponents(requestParameters, options) {
|
|
2121
|
-
return ComponentsApiFp(this.configuration).listComponents(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.limit, requestParameters.cursor, requestParameters.includeCodegen, options).then((request) => request(this.axios, this.basePath));
|
|
2171
|
+
return ComponentsApiFp(this.configuration).listComponents(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.limit, requestParameters.cursor, requestParameters.includeCodegen, requestParameters.includeAll, requestParameters.includeFunctions, requestParameters.includeSubscriptions, requestParameters.includeManages, requestParameters.includeActionFunctions, requestParameters.includeManagementFunctions, requestParameters.includeQualificationFunctions, requestParameters.includeResourceInfo, requestParameters.includeDiffStatus, requestParameters.includeExecutionHistory, options).then((request) => request(this.axios, this.basePath));
|
|
2122
2172
|
}
|
|
2123
2173
|
/**
|
|
2124
2174
|
*
|
|
@@ -2876,6 +2926,114 @@ export class ManagementFuncsApi extends BaseAPI {
|
|
|
2876
2926
|
return ManagementFuncsApiFp(this.configuration).getManagementFuncRunState(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.managementFuncJobStateId, options).then((request) => request(this.axios, this.basePath));
|
|
2877
2927
|
}
|
|
2878
2928
|
}
|
|
2929
|
+
/**
|
|
2930
|
+
* PolicyReportsApi - axios parameter creator
|
|
2931
|
+
* @export
|
|
2932
|
+
*/
|
|
2933
|
+
export const PolicyReportsApiAxiosParamCreator = function (configuration) {
|
|
2934
|
+
return {
|
|
2935
|
+
/**
|
|
2936
|
+
*
|
|
2937
|
+
* @summary Upload a policy report
|
|
2938
|
+
* @param {string} workspaceId Workspace identifier
|
|
2939
|
+
* @param {string} changeSetId Change Set identifier
|
|
2940
|
+
* @param {UploadPolicyReportV1Request} uploadPolicyReportV1Request
|
|
2941
|
+
* @param {*} [options] Override http request option.
|
|
2942
|
+
* @throws {RequiredError}
|
|
2943
|
+
*/
|
|
2944
|
+
uploadPolicyReport: async (workspaceId, changeSetId, uploadPolicyReportV1Request, options = {}) => {
|
|
2945
|
+
// verify required parameter 'workspaceId' is not null or undefined
|
|
2946
|
+
assertParamExists('uploadPolicyReport', 'workspaceId', workspaceId);
|
|
2947
|
+
// verify required parameter 'changeSetId' is not null or undefined
|
|
2948
|
+
assertParamExists('uploadPolicyReport', 'changeSetId', changeSetId);
|
|
2949
|
+
// verify required parameter 'uploadPolicyReportV1Request' is not null or undefined
|
|
2950
|
+
assertParamExists('uploadPolicyReport', 'uploadPolicyReportV1Request', uploadPolicyReportV1Request);
|
|
2951
|
+
const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/policy-reports`
|
|
2952
|
+
.replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
|
|
2953
|
+
.replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
|
|
2954
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2955
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2956
|
+
let baseOptions;
|
|
2957
|
+
if (configuration) {
|
|
2958
|
+
baseOptions = configuration.baseOptions;
|
|
2959
|
+
}
|
|
2960
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
2961
|
+
const localVarHeaderParameter = {};
|
|
2962
|
+
const localVarQueryParameter = {};
|
|
2963
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2964
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2965
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2966
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
2967
|
+
localVarRequestOptions.data = serializeDataIfNeeded(uploadPolicyReportV1Request, localVarRequestOptions, configuration);
|
|
2968
|
+
return {
|
|
2969
|
+
url: toPathString(localVarUrlObj),
|
|
2970
|
+
options: localVarRequestOptions,
|
|
2971
|
+
};
|
|
2972
|
+
},
|
|
2973
|
+
};
|
|
2974
|
+
};
|
|
2975
|
+
/**
|
|
2976
|
+
* PolicyReportsApi - functional programming interface
|
|
2977
|
+
* @export
|
|
2978
|
+
*/
|
|
2979
|
+
export const PolicyReportsApiFp = function (configuration) {
|
|
2980
|
+
const localVarAxiosParamCreator = PolicyReportsApiAxiosParamCreator(configuration);
|
|
2981
|
+
return {
|
|
2982
|
+
/**
|
|
2983
|
+
*
|
|
2984
|
+
* @summary Upload a policy report
|
|
2985
|
+
* @param {string} workspaceId Workspace identifier
|
|
2986
|
+
* @param {string} changeSetId Change Set identifier
|
|
2987
|
+
* @param {UploadPolicyReportV1Request} uploadPolicyReportV1Request
|
|
2988
|
+
* @param {*} [options] Override http request option.
|
|
2989
|
+
* @throws {RequiredError}
|
|
2990
|
+
*/
|
|
2991
|
+
async uploadPolicyReport(workspaceId, changeSetId, uploadPolicyReportV1Request, options) {
|
|
2992
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadPolicyReport(workspaceId, changeSetId, uploadPolicyReportV1Request, options);
|
|
2993
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2994
|
+
const localVarOperationServerBasePath = operationServerMap['PolicyReportsApi.uploadPolicyReport']?.[localVarOperationServerIndex]?.url;
|
|
2995
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2996
|
+
},
|
|
2997
|
+
};
|
|
2998
|
+
};
|
|
2999
|
+
/**
|
|
3000
|
+
* PolicyReportsApi - factory interface
|
|
3001
|
+
* @export
|
|
3002
|
+
*/
|
|
3003
|
+
export const PolicyReportsApiFactory = function (configuration, basePath, axios) {
|
|
3004
|
+
const localVarFp = PolicyReportsApiFp(configuration);
|
|
3005
|
+
return {
|
|
3006
|
+
/**
|
|
3007
|
+
*
|
|
3008
|
+
* @summary Upload a policy report
|
|
3009
|
+
* @param {PolicyReportsApiUploadPolicyReportRequest} requestParameters Request parameters.
|
|
3010
|
+
* @param {*} [options] Override http request option.
|
|
3011
|
+
* @throws {RequiredError}
|
|
3012
|
+
*/
|
|
3013
|
+
uploadPolicyReport(requestParameters, options) {
|
|
3014
|
+
return localVarFp.uploadPolicyReport(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.uploadPolicyReportV1Request, options).then((request) => request(axios, basePath));
|
|
3015
|
+
},
|
|
3016
|
+
};
|
|
3017
|
+
};
|
|
3018
|
+
/**
|
|
3019
|
+
* PolicyReportsApi - object-oriented interface
|
|
3020
|
+
* @export
|
|
3021
|
+
* @class PolicyReportsApi
|
|
3022
|
+
* @extends {BaseAPI}
|
|
3023
|
+
*/
|
|
3024
|
+
export class PolicyReportsApi extends BaseAPI {
|
|
3025
|
+
/**
|
|
3026
|
+
*
|
|
3027
|
+
* @summary Upload a policy report
|
|
3028
|
+
* @param {PolicyReportsApiUploadPolicyReportRequest} requestParameters Request parameters.
|
|
3029
|
+
* @param {*} [options] Override http request option.
|
|
3030
|
+
* @throws {RequiredError}
|
|
3031
|
+
* @memberof PolicyReportsApi
|
|
3032
|
+
*/
|
|
3033
|
+
uploadPolicyReport(requestParameters, options) {
|
|
3034
|
+
return PolicyReportsApiFp(this.configuration).uploadPolicyReport(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.uploadPolicyReportV1Request, options).then((request) => request(this.axios, this.basePath));
|
|
3035
|
+
}
|
|
3036
|
+
}
|
|
2879
3037
|
/**
|
|
2880
3038
|
* RootApi - axios parameter creator
|
|
2881
3039
|
* @export
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "system-initiative-api-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.13.0",
|
|
4
4
|
"description": "TypeScript/JavaScript SDK for the System Initiative Public API",
|
|
5
5
|
"author": "System Initiative <support@systeminit.com>",
|
|
6
6
|
"repository": {
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"typescript": "^5.0.0"
|
|
46
46
|
},
|
|
47
47
|
"engines": {
|
|
48
|
-
"node": ">=
|
|
48
|
+
"node": ">=20.0.0"
|
|
49
49
|
},
|
|
50
50
|
"publishConfig": {
|
|
51
51
|
"access": "public"
|