system-initiative-api-client 1.0.7 → 1.0.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/dist/cjs/api.d.ts CHANGED
@@ -183,6 +183,37 @@ export interface ApiSuccessString {
183
183
  */
184
184
  'data': string;
185
185
  }
186
+ /**
187
+ *
188
+ * @export
189
+ * @interface BuildingResponseV1
190
+ */
191
+ export interface BuildingResponseV1 {
192
+ /**
193
+ *
194
+ * @type {number}
195
+ * @memberof BuildingResponseV1
196
+ */
197
+ 'estimatedCompletionSeconds': number;
198
+ /**
199
+ *
200
+ * @type {string}
201
+ * @memberof BuildingResponseV1
202
+ */
203
+ 'message': string;
204
+ /**
205
+ *
206
+ * @type {number}
207
+ * @memberof BuildingResponseV1
208
+ */
209
+ 'retryAfterSeconds': number;
210
+ /**
211
+ *
212
+ * @type {string}
213
+ * @memberof BuildingResponseV1
214
+ */
215
+ 'status': string;
216
+ }
186
217
  /**
187
218
  *
188
219
  * @export
@@ -1492,7 +1523,7 @@ export interface GetSchemaVariantV1Response {
1492
1523
  * @type {PropSchemaV1}
1493
1524
  * @memberof GetSchemaVariantV1Response
1494
1525
  */
1495
- 'domainProps': PropSchemaV1;
1526
+ 'domainProps'?: PropSchemaV1 | null;
1496
1527
  /**
1497
1528
  *
1498
1529
  * @type {boolean}
@@ -1895,12 +1926,30 @@ export interface PropSchemaV1 {
1895
1926
  * @memberof PropSchemaV1
1896
1927
  */
1897
1928
  'children': Array<PropSchemaV1>;
1929
+ /**
1930
+ *
1931
+ * @type {any}
1932
+ * @memberof PropSchemaV1
1933
+ */
1934
+ 'defaultValue': any;
1898
1935
  /**
1899
1936
  *
1900
1937
  * @type {string}
1901
1938
  * @memberof PropSchemaV1
1902
1939
  */
1903
1940
  'description': string;
1941
+ /**
1942
+ *
1943
+ * @type {string}
1944
+ * @memberof PropSchemaV1
1945
+ */
1946
+ 'docLink': string;
1947
+ /**
1948
+ *
1949
+ * @type {boolean}
1950
+ * @memberof PropSchemaV1
1951
+ */
1952
+ 'hidden': boolean;
1904
1953
  /**
1905
1954
  *
1906
1955
  * @type {string}
@@ -1919,6 +1968,12 @@ export interface PropSchemaV1 {
1919
1968
  * @memberof PropSchemaV1
1920
1969
  */
1921
1970
  'propType': string;
1971
+ /**
1972
+ *
1973
+ * @type {string}
1974
+ * @memberof PropSchemaV1
1975
+ */
1976
+ 'validationFormat': string;
1922
1977
  }
1923
1978
  /**
1924
1979
  *
@@ -1959,6 +2014,19 @@ export interface RequestApprovalChangeSetV1Response {
1959
2014
  */
1960
2015
  'success': boolean;
1961
2016
  }
2017
+ /**
2018
+ *
2019
+ * @export
2020
+ * @interface RestoreComponentV1Response
2021
+ */
2022
+ export interface RestoreComponentV1Response {
2023
+ /**
2024
+ *
2025
+ * @type {boolean}
2026
+ * @memberof RestoreComponentV1Response
2027
+ */
2028
+ 'status': boolean;
2029
+ }
1962
2030
  /**
1963
2031
  *
1964
2032
  * @export
@@ -3388,6 +3456,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
3388
3456
  * @throws {RequiredError}
3389
3457
  */
3390
3458
  manageComponent: (workspaceId: string, changeSetId: string, componentId: string, manageComponentV1Request: ManageComponentV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3459
+ /**
3460
+ *
3461
+ * @summary Restore a component that is marked for deletion
3462
+ * @param {string} workspaceId Workspace identifier
3463
+ * @param {string} changeSetId Change Set identifier
3464
+ * @param {string} componentId Component identifier
3465
+ * @param {*} [options] Override http request option.
3466
+ * @throws {RequiredError}
3467
+ */
3468
+ restoreComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3391
3469
  /**
3392
3470
  *
3393
3471
  * @summary Complex search for components
@@ -3540,6 +3618,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
3540
3618
  * @throws {RequiredError}
3541
3619
  */
3542
3620
  manageComponent(workspaceId: string, changeSetId: string, componentId: string, manageComponentV1Request: ManageComponentV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManageComponentV1Response>>;
3621
+ /**
3622
+ *
3623
+ * @summary Restore a component that is marked for deletion
3624
+ * @param {string} workspaceId Workspace identifier
3625
+ * @param {string} changeSetId Change Set identifier
3626
+ * @param {string} componentId Component identifier
3627
+ * @param {*} [options] Override http request option.
3628
+ * @throws {RequiredError}
3629
+ */
3630
+ restoreComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestoreComponentV1Response>>;
3543
3631
  /**
3544
3632
  *
3545
3633
  * @summary Complex search for components
@@ -3665,6 +3753,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
3665
3753
  * @throws {RequiredError}
3666
3754
  */
3667
3755
  manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ManageComponentV1Response>;
3756
+ /**
3757
+ *
3758
+ * @summary Restore a component that is marked for deletion
3759
+ * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
3760
+ * @param {*} [options] Override http request option.
3761
+ * @throws {RequiredError}
3762
+ */
3763
+ restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<RestoreComponentV1Response>;
3668
3764
  /**
3669
3765
  *
3670
3766
  * @summary Complex search for components
@@ -3795,6 +3891,15 @@ export interface ComponentsApiInterface {
3795
3891
  * @memberof ComponentsApiInterface
3796
3892
  */
3797
3893
  manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ManageComponentV1Response>;
3894
+ /**
3895
+ *
3896
+ * @summary Restore a component that is marked for deletion
3897
+ * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
3898
+ * @param {*} [options] Override http request option.
3899
+ * @throws {RequiredError}
3900
+ * @memberof ComponentsApiInterface
3901
+ */
3902
+ restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<RestoreComponentV1Response>;
3798
3903
  /**
3799
3904
  *
3800
3905
  * @summary Complex search for components
@@ -4128,6 +4233,31 @@ export interface ComponentsApiManageComponentRequest {
4128
4233
  */
4129
4234
  readonly manageComponentV1Request: ManageComponentV1Request;
4130
4235
  }
4236
+ /**
4237
+ * Request parameters for restoreComponent operation in ComponentsApi.
4238
+ * @export
4239
+ * @interface ComponentsApiRestoreComponentRequest
4240
+ */
4241
+ export interface ComponentsApiRestoreComponentRequest {
4242
+ /**
4243
+ * Workspace identifier
4244
+ * @type {string}
4245
+ * @memberof ComponentsApiRestoreComponent
4246
+ */
4247
+ readonly workspaceId: string;
4248
+ /**
4249
+ * Change Set identifier
4250
+ * @type {string}
4251
+ * @memberof ComponentsApiRestoreComponent
4252
+ */
4253
+ readonly changeSetId: string;
4254
+ /**
4255
+ * Component identifier
4256
+ * @type {string}
4257
+ * @memberof ComponentsApiRestoreComponent
4258
+ */
4259
+ readonly componentId: string;
4260
+ }
4131
4261
  /**
4132
4262
  * Request parameters for searchComponents operation in ComponentsApi.
4133
4263
  * @export
@@ -4315,6 +4445,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
4315
4445
  * @memberof ComponentsApi
4316
4446
  */
4317
4447
  manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ManageComponentV1Response, any>>;
4448
+ /**
4449
+ *
4450
+ * @summary Restore a component that is marked for deletion
4451
+ * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
4452
+ * @param {*} [options] Override http request option.
4453
+ * @throws {RequiredError}
4454
+ * @memberof ComponentsApi
4455
+ */
4456
+ restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RestoreComponentV1Response, any>>;
4318
4457
  /**
4319
4458
  *
4320
4459
  * @summary Complex search for components
package/dist/cjs/api.js CHANGED
@@ -1370,6 +1370,43 @@ const ComponentsApiAxiosParamCreator = function (configuration) {
1370
1370
  options: localVarRequestOptions,
1371
1371
  };
1372
1372
  },
1373
+ /**
1374
+ *
1375
+ * @summary Restore a component that is marked for deletion
1376
+ * @param {string} workspaceId Workspace identifier
1377
+ * @param {string} changeSetId Change Set identifier
1378
+ * @param {string} componentId Component identifier
1379
+ * @param {*} [options] Override http request option.
1380
+ * @throws {RequiredError}
1381
+ */
1382
+ restoreComponent: async (workspaceId, changeSetId, componentId, options = {}) => {
1383
+ // verify required parameter 'workspaceId' is not null or undefined
1384
+ (0, common_1.assertParamExists)('restoreComponent', 'workspaceId', workspaceId);
1385
+ // verify required parameter 'changeSetId' is not null or undefined
1386
+ (0, common_1.assertParamExists)('restoreComponent', 'changeSetId', changeSetId);
1387
+ // verify required parameter 'componentId' is not null or undefined
1388
+ (0, common_1.assertParamExists)('restoreComponent', 'componentId', componentId);
1389
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/{component_id}/restore`
1390
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
1391
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
1392
+ .replace(`{${"component_id"}}`, encodeURIComponent(String(componentId)));
1393
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1394
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1395
+ let baseOptions;
1396
+ if (configuration) {
1397
+ baseOptions = configuration.baseOptions;
1398
+ }
1399
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1400
+ const localVarHeaderParameter = {};
1401
+ const localVarQueryParameter = {};
1402
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1403
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1404
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1405
+ return {
1406
+ url: (0, common_1.toPathString)(localVarUrlObj),
1407
+ options: localVarRequestOptions,
1408
+ };
1409
+ },
1373
1410
  /**
1374
1411
  *
1375
1412
  * @summary Complex search for components
@@ -1667,6 +1704,21 @@ const ComponentsApiFp = function (configuration) {
1667
1704
  const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.manageComponent']?.[localVarOperationServerIndex]?.url;
1668
1705
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1669
1706
  },
1707
+ /**
1708
+ *
1709
+ * @summary Restore a component that is marked for deletion
1710
+ * @param {string} workspaceId Workspace identifier
1711
+ * @param {string} changeSetId Change Set identifier
1712
+ * @param {string} componentId Component identifier
1713
+ * @param {*} [options] Override http request option.
1714
+ * @throws {RequiredError}
1715
+ */
1716
+ async restoreComponent(workspaceId, changeSetId, componentId, options) {
1717
+ const localVarAxiosArgs = await localVarAxiosParamCreator.restoreComponent(workspaceId, changeSetId, componentId, options);
1718
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1719
+ const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.restoreComponent']?.[localVarOperationServerIndex]?.url;
1720
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1721
+ },
1670
1722
  /**
1671
1723
  *
1672
1724
  * @summary Complex search for components
@@ -1833,6 +1885,16 @@ const ComponentsApiFactory = function (configuration, basePath, axios) {
1833
1885
  manageComponent(requestParameters, options) {
1834
1886
  return localVarFp.manageComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.manageComponentV1Request, options).then((request) => request(axios, basePath));
1835
1887
  },
1888
+ /**
1889
+ *
1890
+ * @summary Restore a component that is marked for deletion
1891
+ * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
1892
+ * @param {*} [options] Override http request option.
1893
+ * @throws {RequiredError}
1894
+ */
1895
+ restoreComponent(requestParameters, options) {
1896
+ return localVarFp.restoreComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(axios, basePath));
1897
+ },
1836
1898
  /**
1837
1899
  *
1838
1900
  * @summary Complex search for components
@@ -1994,6 +2056,17 @@ class ComponentsApi extends base_1.BaseAPI {
1994
2056
  manageComponent(requestParameters, options) {
1995
2057
  return (0, exports.ComponentsApiFp)(this.configuration).manageComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.manageComponentV1Request, options).then((request) => request(this.axios, this.basePath));
1996
2058
  }
2059
+ /**
2060
+ *
2061
+ * @summary Restore a component that is marked for deletion
2062
+ * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
2063
+ * @param {*} [options] Override http request option.
2064
+ * @throws {RequiredError}
2065
+ * @memberof ComponentsApi
2066
+ */
2067
+ restoreComponent(requestParameters, options) {
2068
+ return (0, exports.ComponentsApiFp)(this.configuration).restoreComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
2069
+ }
1997
2070
  /**
1998
2071
  *
1999
2072
  * @summary Complex search for components
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "system-initiative-api-client",
3
- "version": "1.0.7",
3
+ "version": "1.0.9",
4
4
  "description": "TypeScript/JavaScript SDK for the System Initiative Public API",
5
5
  "author": "System Initiative <support@systeminit.com>",
6
6
  "repository": {