system-initiative-api-client 1.7.0 → 1.9.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/esm/api.js CHANGED
@@ -1325,6 +1325,43 @@ export const ComponentsApiAxiosParamCreator = function (configuration) {
1325
1325
  options: localVarRequestOptions,
1326
1326
  };
1327
1327
  },
1328
+ /**
1329
+ *
1330
+ * @summary Get a component resource by component Id
1331
+ * @param {string} workspaceId Workspace identifier
1332
+ * @param {string} changeSetId Change Set identifier
1333
+ * @param {string} componentId Component identifier
1334
+ * @param {*} [options] Override http request option.
1335
+ * @throws {RequiredError}
1336
+ */
1337
+ getComponentResource: async (workspaceId, changeSetId, componentId, options = {}) => {
1338
+ // verify required parameter 'workspaceId' is not null or undefined
1339
+ assertParamExists('getComponentResource', 'workspaceId', workspaceId);
1340
+ // verify required parameter 'changeSetId' is not null or undefined
1341
+ assertParamExists('getComponentResource', 'changeSetId', changeSetId);
1342
+ // verify required parameter 'componentId' is not null or undefined
1343
+ assertParamExists('getComponentResource', 'componentId', componentId);
1344
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/{component_id}/resource`
1345
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
1346
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
1347
+ .replace(`{${"component_id"}}`, encodeURIComponent(String(componentId)));
1348
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1349
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1350
+ let baseOptions;
1351
+ if (configuration) {
1352
+ baseOptions = configuration.baseOptions;
1353
+ }
1354
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
1355
+ const localVarHeaderParameter = {};
1356
+ const localVarQueryParameter = {};
1357
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1358
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1359
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1360
+ return {
1361
+ url: toPathString(localVarUrlObj),
1362
+ options: localVarRequestOptions,
1363
+ };
1364
+ },
1328
1365
  /**
1329
1366
  *
1330
1367
  * @summary List all components
@@ -1728,6 +1765,21 @@ export const ComponentsApiFp = function (configuration) {
1728
1765
  const localVarOperationServerBasePath = operationServerMap['ComponentsApi.getComponent']?.[localVarOperationServerIndex]?.url;
1729
1766
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1730
1767
  },
1768
+ /**
1769
+ *
1770
+ * @summary Get a component resource by component Id
1771
+ * @param {string} workspaceId Workspace identifier
1772
+ * @param {string} changeSetId Change Set identifier
1773
+ * @param {string} componentId Component identifier
1774
+ * @param {*} [options] Override http request option.
1775
+ * @throws {RequiredError}
1776
+ */
1777
+ async getComponentResource(workspaceId, changeSetId, componentId, options) {
1778
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getComponentResource(workspaceId, changeSetId, componentId, options);
1779
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1780
+ const localVarOperationServerBasePath = operationServerMap['ComponentsApi.getComponentResource']?.[localVarOperationServerIndex]?.url;
1781
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1782
+ },
1731
1783
  /**
1732
1784
  *
1733
1785
  * @summary List all components
@@ -1931,6 +1983,16 @@ export const ComponentsApiFactory = function (configuration, basePath, axios) {
1931
1983
  getComponent(requestParameters, options) {
1932
1984
  return localVarFp.getComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(axios, basePath));
1933
1985
  },
1986
+ /**
1987
+ *
1988
+ * @summary Get a component resource by component Id
1989
+ * @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
1990
+ * @param {*} [options] Override http request option.
1991
+ * @throws {RequiredError}
1992
+ */
1993
+ getComponentResource(requestParameters, options) {
1994
+ return localVarFp.getComponentResource(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(axios, basePath));
1995
+ },
1934
1996
  /**
1935
1997
  *
1936
1998
  * @summary List all components
@@ -2110,6 +2172,17 @@ export class ComponentsApi extends BaseAPI {
2110
2172
  getComponent(requestParameters, options) {
2111
2173
  return ComponentsApiFp(this.configuration).getComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
2112
2174
  }
2175
+ /**
2176
+ *
2177
+ * @summary Get a component resource by component Id
2178
+ * @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
2179
+ * @param {*} [options] Override http request option.
2180
+ * @throws {RequiredError}
2181
+ * @memberof ComponentsApi
2182
+ */
2183
+ getComponentResource(requestParameters, options) {
2184
+ return ComponentsApiFp(this.configuration).getComponentResource(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
2185
+ }
2113
2186
  /**
2114
2187
  *
2115
2188
  * @summary List all components
@@ -2177,6 +2250,187 @@ export class ComponentsApi extends BaseAPI {
2177
2250
  return ComponentsApiFp(this.configuration).upgradeComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
2178
2251
  }
2179
2252
  }
2253
+ /**
2254
+ * DebugFuncsApi - axios parameter creator
2255
+ * @export
2256
+ */
2257
+ export const DebugFuncsApiAxiosParamCreator = function (configuration) {
2258
+ return {
2259
+ /**
2260
+ *
2261
+ * @summary Execute a debug function in the context of a component
2262
+ * @param {string} workspaceId Workspace identifier
2263
+ * @param {string} changeSetId Change Set identifier
2264
+ * @param {ExecDebugFuncV1Request} execDebugFuncV1Request
2265
+ * @param {*} [options] Override http request option.
2266
+ * @throws {RequiredError}
2267
+ */
2268
+ execDebugFunc: async (workspaceId, changeSetId, execDebugFuncV1Request, options = {}) => {
2269
+ // verify required parameter 'workspaceId' is not null or undefined
2270
+ assertParamExists('execDebugFunc', 'workspaceId', workspaceId);
2271
+ // verify required parameter 'changeSetId' is not null or undefined
2272
+ assertParamExists('execDebugFunc', 'changeSetId', changeSetId);
2273
+ // verify required parameter 'execDebugFuncV1Request' is not null or undefined
2274
+ assertParamExists('execDebugFunc', 'execDebugFuncV1Request', execDebugFuncV1Request);
2275
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/debug-funcs`
2276
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
2277
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
2278
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2279
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2280
+ let baseOptions;
2281
+ if (configuration) {
2282
+ baseOptions = configuration.baseOptions;
2283
+ }
2284
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
2285
+ const localVarHeaderParameter = {};
2286
+ const localVarQueryParameter = {};
2287
+ localVarHeaderParameter['Content-Type'] = 'application/json';
2288
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2289
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2290
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2291
+ localVarRequestOptions.data = serializeDataIfNeeded(execDebugFuncV1Request, localVarRequestOptions, configuration);
2292
+ return {
2293
+ url: toPathString(localVarUrlObj),
2294
+ options: localVarRequestOptions,
2295
+ };
2296
+ },
2297
+ /**
2298
+ *
2299
+ * @summary Get debug funcs job state details
2300
+ * @param {string} workspaceId Workspace identifier
2301
+ * @param {string} changeSetId Change Set identifier
2302
+ * @param {string} debugFuncJobStateId Debug Func Job identifier
2303
+ * @param {*} [options] Override http request option.
2304
+ * @throws {RequiredError}
2305
+ */
2306
+ getDebugFuncState: async (workspaceId, changeSetId, debugFuncJobStateId, options = {}) => {
2307
+ // verify required parameter 'workspaceId' is not null or undefined
2308
+ assertParamExists('getDebugFuncState', 'workspaceId', workspaceId);
2309
+ // verify required parameter 'changeSetId' is not null or undefined
2310
+ assertParamExists('getDebugFuncState', 'changeSetId', changeSetId);
2311
+ // verify required parameter 'debugFuncJobStateId' is not null or undefined
2312
+ assertParamExists('getDebugFuncState', 'debugFuncJobStateId', debugFuncJobStateId);
2313
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/debug-funcs/{debug_func_job_state_id}`
2314
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
2315
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
2316
+ .replace(`{${"debug_func_job_state_id"}}`, encodeURIComponent(String(debugFuncJobStateId)));
2317
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
2318
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2319
+ let baseOptions;
2320
+ if (configuration) {
2321
+ baseOptions = configuration.baseOptions;
2322
+ }
2323
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
2324
+ const localVarHeaderParameter = {};
2325
+ const localVarQueryParameter = {};
2326
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
2327
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2328
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
2329
+ return {
2330
+ url: toPathString(localVarUrlObj),
2331
+ options: localVarRequestOptions,
2332
+ };
2333
+ },
2334
+ };
2335
+ };
2336
+ /**
2337
+ * DebugFuncsApi - functional programming interface
2338
+ * @export
2339
+ */
2340
+ export const DebugFuncsApiFp = function (configuration) {
2341
+ const localVarAxiosParamCreator = DebugFuncsApiAxiosParamCreator(configuration);
2342
+ return {
2343
+ /**
2344
+ *
2345
+ * @summary Execute a debug function in the context of a component
2346
+ * @param {string} workspaceId Workspace identifier
2347
+ * @param {string} changeSetId Change Set identifier
2348
+ * @param {ExecDebugFuncV1Request} execDebugFuncV1Request
2349
+ * @param {*} [options] Override http request option.
2350
+ * @throws {RequiredError}
2351
+ */
2352
+ async execDebugFunc(workspaceId, changeSetId, execDebugFuncV1Request, options) {
2353
+ const localVarAxiosArgs = await localVarAxiosParamCreator.execDebugFunc(workspaceId, changeSetId, execDebugFuncV1Request, options);
2354
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2355
+ const localVarOperationServerBasePath = operationServerMap['DebugFuncsApi.execDebugFunc']?.[localVarOperationServerIndex]?.url;
2356
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2357
+ },
2358
+ /**
2359
+ *
2360
+ * @summary Get debug funcs job state details
2361
+ * @param {string} workspaceId Workspace identifier
2362
+ * @param {string} changeSetId Change Set identifier
2363
+ * @param {string} debugFuncJobStateId Debug Func Job identifier
2364
+ * @param {*} [options] Override http request option.
2365
+ * @throws {RequiredError}
2366
+ */
2367
+ async getDebugFuncState(workspaceId, changeSetId, debugFuncJobStateId, options) {
2368
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getDebugFuncState(workspaceId, changeSetId, debugFuncJobStateId, options);
2369
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2370
+ const localVarOperationServerBasePath = operationServerMap['DebugFuncsApi.getDebugFuncState']?.[localVarOperationServerIndex]?.url;
2371
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
2372
+ },
2373
+ };
2374
+ };
2375
+ /**
2376
+ * DebugFuncsApi - factory interface
2377
+ * @export
2378
+ */
2379
+ export const DebugFuncsApiFactory = function (configuration, basePath, axios) {
2380
+ const localVarFp = DebugFuncsApiFp(configuration);
2381
+ return {
2382
+ /**
2383
+ *
2384
+ * @summary Execute a debug function in the context of a component
2385
+ * @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
2386
+ * @param {*} [options] Override http request option.
2387
+ * @throws {RequiredError}
2388
+ */
2389
+ execDebugFunc(requestParameters, options) {
2390
+ return localVarFp.execDebugFunc(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.execDebugFuncV1Request, options).then((request) => request(axios, basePath));
2391
+ },
2392
+ /**
2393
+ *
2394
+ * @summary Get debug funcs job state details
2395
+ * @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
2396
+ * @param {*} [options] Override http request option.
2397
+ * @throws {RequiredError}
2398
+ */
2399
+ getDebugFuncState(requestParameters, options) {
2400
+ return localVarFp.getDebugFuncState(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.debugFuncJobStateId, options).then((request) => request(axios, basePath));
2401
+ },
2402
+ };
2403
+ };
2404
+ /**
2405
+ * DebugFuncsApi - object-oriented interface
2406
+ * @export
2407
+ * @class DebugFuncsApi
2408
+ * @extends {BaseAPI}
2409
+ */
2410
+ export class DebugFuncsApi extends BaseAPI {
2411
+ /**
2412
+ *
2413
+ * @summary Execute a debug function in the context of a component
2414
+ * @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
2415
+ * @param {*} [options] Override http request option.
2416
+ * @throws {RequiredError}
2417
+ * @memberof DebugFuncsApi
2418
+ */
2419
+ execDebugFunc(requestParameters, options) {
2420
+ return DebugFuncsApiFp(this.configuration).execDebugFunc(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.execDebugFuncV1Request, options).then((request) => request(this.axios, this.basePath));
2421
+ }
2422
+ /**
2423
+ *
2424
+ * @summary Get debug funcs job state details
2425
+ * @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
2426
+ * @param {*} [options] Override http request option.
2427
+ * @throws {RequiredError}
2428
+ * @memberof DebugFuncsApi
2429
+ */
2430
+ getDebugFuncState(requestParameters, options) {
2431
+ return DebugFuncsApiFp(this.configuration).getDebugFuncState(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.debugFuncJobStateId, options).then((request) => request(this.axios, this.basePath));
2432
+ }
2433
+ }
2180
2434
  /**
2181
2435
  * FuncsApi - axios parameter creator
2182
2436
  * @export
@@ -3443,7 +3697,7 @@ export const SchemasApiAxiosParamCreator = function (configuration) {
3443
3697
  },
3444
3698
  /**
3445
3699
  *
3446
- * @summary Complex search for shemas
3700
+ * @summary Complex search for schemas
3447
3701
  * @param {string} workspaceId Workspace identifier
3448
3702
  * @param {string} changeSetId Change Set identifier
3449
3703
  * @param {SearchSchemasV1Request} searchSchemasV1Request
@@ -3851,7 +4105,7 @@ export const SchemasApiFp = function (configuration) {
3851
4105
  },
3852
4106
  /**
3853
4107
  *
3854
- * @summary Complex search for shemas
4108
+ * @summary Complex search for schemas
3855
4109
  * @param {string} workspaceId Workspace identifier
3856
4110
  * @param {string} changeSetId Change Set identifier
3857
4111
  * @param {SearchSchemasV1Request} searchSchemasV1Request
@@ -4077,7 +4331,7 @@ export const SchemasApiFactory = function (configuration, basePath, axios) {
4077
4331
  },
4078
4332
  /**
4079
4333
  *
4080
- * @summary Complex search for shemas
4334
+ * @summary Complex search for schemas
4081
4335
  * @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
4082
4336
  * @param {*} [options] Override http request option.
4083
4337
  * @throws {RequiredError}
@@ -4303,7 +4557,7 @@ export class SchemasApi extends BaseAPI {
4303
4557
  }
4304
4558
  /**
4305
4559
  *
4306
- * @summary Complex search for shemas
4560
+ * @summary Complex search for schemas
4307
4561
  * @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
4308
4562
  * @param {*} [options] Override http request option.
4309
4563
  * @throws {RequiredError}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "system-initiative-api-client",
3
- "version": "1.7.0",
3
+ "version": "1.9.0",
4
4
  "description": "TypeScript/JavaScript SDK for the System Initiative Public API",
5
5
  "author": "System Initiative <support@systeminit.com>",
6
6
  "repository": {