system-initiative-api-client 1.0.4 → 1.0.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/cjs/api.d.ts CHANGED
@@ -2312,6 +2312,19 @@ export interface UpdateSecretV1Response {
2312
2312
  */
2313
2313
  'secret': SecretV1;
2314
2314
  }
2315
+ /**
2316
+ *
2317
+ * @export
2318
+ * @interface UpgradeComponentV1Response
2319
+ */
2320
+ export interface UpgradeComponentV1Response {
2321
+ /**
2322
+ *
2323
+ * @type {ComponentViewV1}
2324
+ * @memberof UpgradeComponentV1Response
2325
+ */
2326
+ 'component': ComponentViewV1;
2327
+ }
2315
2328
  /**
2316
2329
  *
2317
2330
  * @export
@@ -3319,6 +3332,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
3319
3332
  * @throws {RequiredError}
3320
3333
  */
3321
3334
  updateComponent: (workspaceId: string, changeSetId: string, componentId: string, updateComponentV1Request: UpdateComponentV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3335
+ /**
3336
+ *
3337
+ * @summary Upgrade a component to the latest schema variant
3338
+ * @param {string} workspaceId Workspace identifier
3339
+ * @param {string} changeSetId Change Set identifier
3340
+ * @param {string} componentId Component identifier
3341
+ * @param {*} [options] Override http request option.
3342
+ * @throws {RequiredError}
3343
+ */
3344
+ upgradeComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3322
3345
  };
3323
3346
  /**
3324
3347
  * ComponentsApi - functional programming interface
@@ -3441,6 +3464,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
3441
3464
  * @throws {RequiredError}
3442
3465
  */
3443
3466
  updateComponent(workspaceId: string, changeSetId: string, componentId: string, updateComponentV1Request: UpdateComponentV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateComponentV1Response>>;
3467
+ /**
3468
+ *
3469
+ * @summary Upgrade a component to the latest schema variant
3470
+ * @param {string} workspaceId Workspace identifier
3471
+ * @param {string} changeSetId Change Set identifier
3472
+ * @param {string} componentId Component identifier
3473
+ * @param {*} [options] Override http request option.
3474
+ * @throws {RequiredError}
3475
+ */
3476
+ upgradeComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpgradeComponentV1Response>>;
3444
3477
  };
3445
3478
  /**
3446
3479
  * ComponentsApi - factory interface
@@ -3535,6 +3568,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
3535
3568
  * @throws {RequiredError}
3536
3569
  */
3537
3570
  updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateComponentV1Response>;
3571
+ /**
3572
+ *
3573
+ * @summary Upgrade a component to the latest schema variant
3574
+ * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
3575
+ * @param {*} [options] Override http request option.
3576
+ * @throws {RequiredError}
3577
+ */
3578
+ upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradeComponentV1Response>;
3538
3579
  };
3539
3580
  /**
3540
3581
  * ComponentsApi - interface
@@ -3641,6 +3682,15 @@ export interface ComponentsApiInterface {
3641
3682
  * @memberof ComponentsApiInterface
3642
3683
  */
3643
3684
  updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateComponentV1Response>;
3685
+ /**
3686
+ *
3687
+ * @summary Upgrade a component to the latest schema variant
3688
+ * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
3689
+ * @param {*} [options] Override http request option.
3690
+ * @throws {RequiredError}
3691
+ * @memberof ComponentsApiInterface
3692
+ */
3693
+ upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradeComponentV1Response>;
3644
3694
  }
3645
3695
  /**
3646
3696
  * Request parameters for addAction operation in ComponentsApi.
@@ -3953,6 +4003,31 @@ export interface ComponentsApiUpdateComponentRequest {
3953
4003
  */
3954
4004
  readonly updateComponentV1Request: UpdateComponentV1Request;
3955
4005
  }
4006
+ /**
4007
+ * Request parameters for upgradeComponent operation in ComponentsApi.
4008
+ * @export
4009
+ * @interface ComponentsApiUpgradeComponentRequest
4010
+ */
4011
+ export interface ComponentsApiUpgradeComponentRequest {
4012
+ /**
4013
+ * Workspace identifier
4014
+ * @type {string}
4015
+ * @memberof ComponentsApiUpgradeComponent
4016
+ */
4017
+ readonly workspaceId: string;
4018
+ /**
4019
+ * Change Set identifier
4020
+ * @type {string}
4021
+ * @memberof ComponentsApiUpgradeComponent
4022
+ */
4023
+ readonly changeSetId: string;
4024
+ /**
4025
+ * Component identifier
4026
+ * @type {string}
4027
+ * @memberof ComponentsApiUpgradeComponent
4028
+ */
4029
+ readonly componentId: string;
4030
+ }
3956
4031
  /**
3957
4032
  * ComponentsApi - object-oriented interface
3958
4033
  * @export
@@ -4059,6 +4134,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
4059
4134
  * @memberof ComponentsApi
4060
4135
  */
4061
4136
  updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateComponentV1Response, any>>;
4137
+ /**
4138
+ *
4139
+ * @summary Upgrade a component to the latest schema variant
4140
+ * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
4141
+ * @param {*} [options] Override http request option.
4142
+ * @throws {RequiredError}
4143
+ * @memberof ComponentsApi
4144
+ */
4145
+ upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpgradeComponentV1Response, any>>;
4062
4146
  }
4063
4147
  /**
4064
4148
  * FuncsApi - axios parameter creator
package/dist/cjs/api.js CHANGED
@@ -1375,6 +1375,43 @@ const ComponentsApiAxiosParamCreator = function (configuration) {
1375
1375
  options: localVarRequestOptions,
1376
1376
  };
1377
1377
  },
1378
+ /**
1379
+ *
1380
+ * @summary Upgrade a component to the latest schema variant
1381
+ * @param {string} workspaceId Workspace identifier
1382
+ * @param {string} changeSetId Change Set identifier
1383
+ * @param {string} componentId Component identifier
1384
+ * @param {*} [options] Override http request option.
1385
+ * @throws {RequiredError}
1386
+ */
1387
+ upgradeComponent: async (workspaceId, changeSetId, componentId, options = {}) => {
1388
+ // verify required parameter 'workspaceId' is not null or undefined
1389
+ (0, common_1.assertParamExists)('upgradeComponent', 'workspaceId', workspaceId);
1390
+ // verify required parameter 'changeSetId' is not null or undefined
1391
+ (0, common_1.assertParamExists)('upgradeComponent', 'changeSetId', changeSetId);
1392
+ // verify required parameter 'componentId' is not null or undefined
1393
+ (0, common_1.assertParamExists)('upgradeComponent', 'componentId', componentId);
1394
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/{component_id}/upgrade`
1395
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
1396
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
1397
+ .replace(`{${"component_id"}}`, encodeURIComponent(String(componentId)));
1398
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1399
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1400
+ let baseOptions;
1401
+ if (configuration) {
1402
+ baseOptions = configuration.baseOptions;
1403
+ }
1404
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1405
+ const localVarHeaderParameter = {};
1406
+ const localVarQueryParameter = {};
1407
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1408
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1409
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1410
+ return {
1411
+ url: (0, common_1.toPathString)(localVarUrlObj),
1412
+ options: localVarRequestOptions,
1413
+ };
1414
+ },
1378
1415
  };
1379
1416
  };
1380
1417
  exports.ComponentsApiAxiosParamCreator = ComponentsApiAxiosParamCreator;
@@ -1556,6 +1593,21 @@ const ComponentsApiFp = function (configuration) {
1556
1593
  const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.updateComponent']?.[localVarOperationServerIndex]?.url;
1557
1594
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1558
1595
  },
1596
+ /**
1597
+ *
1598
+ * @summary Upgrade a component to the latest schema variant
1599
+ * @param {string} workspaceId Workspace identifier
1600
+ * @param {string} changeSetId Change Set identifier
1601
+ * @param {string} componentId Component identifier
1602
+ * @param {*} [options] Override http request option.
1603
+ * @throws {RequiredError}
1604
+ */
1605
+ async upgradeComponent(workspaceId, changeSetId, componentId, options) {
1606
+ const localVarAxiosArgs = await localVarAxiosParamCreator.upgradeComponent(workspaceId, changeSetId, componentId, options);
1607
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1608
+ const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.upgradeComponent']?.[localVarOperationServerIndex]?.url;
1609
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1610
+ },
1559
1611
  };
1560
1612
  };
1561
1613
  exports.ComponentsApiFp = ComponentsApiFp;
@@ -1676,6 +1728,16 @@ const ComponentsApiFactory = function (configuration, basePath, axios) {
1676
1728
  updateComponent(requestParameters, options) {
1677
1729
  return localVarFp.updateComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.updateComponentV1Request, options).then((request) => request(axios, basePath));
1678
1730
  },
1731
+ /**
1732
+ *
1733
+ * @summary Upgrade a component to the latest schema variant
1734
+ * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
1735
+ * @param {*} [options] Override http request option.
1736
+ * @throws {RequiredError}
1737
+ */
1738
+ upgradeComponent(requestParameters, options) {
1739
+ return localVarFp.upgradeComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(axios, basePath));
1740
+ },
1679
1741
  };
1680
1742
  };
1681
1743
  exports.ComponentsApiFactory = ComponentsApiFactory;
@@ -1807,6 +1869,17 @@ class ComponentsApi extends base_1.BaseAPI {
1807
1869
  updateComponent(requestParameters, options) {
1808
1870
  return (0, exports.ComponentsApiFp)(this.configuration).updateComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.updateComponentV1Request, options).then((request) => request(this.axios, this.basePath));
1809
1871
  }
1872
+ /**
1873
+ *
1874
+ * @summary Upgrade a component to the latest schema variant
1875
+ * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
1876
+ * @param {*} [options] Override http request option.
1877
+ * @throws {RequiredError}
1878
+ * @memberof ComponentsApi
1879
+ */
1880
+ upgradeComponent(requestParameters, options) {
1881
+ return (0, exports.ComponentsApiFp)(this.configuration).upgradeComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
1882
+ }
1810
1883
  }
1811
1884
  exports.ComponentsApi = ComponentsApi;
1812
1885
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "system-initiative-api-client",
3
- "version": "1.0.4",
3
+ "version": "1.0.5",
4
4
  "description": "TypeScript/JavaScript SDK for the System Initiative Public API",
5
5
  "author": "System Initiative <support@systeminit.com>",
6
6
  "repository": {