system-initiative-api-client 1.0.5 → 1.0.6

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
@@ -1193,6 +1193,56 @@ export interface FuncRunViewV1 {
1193
1193
  */
1194
1194
  'updatedAt': string;
1195
1195
  }
1196
+ /**
1197
+ *
1198
+ * @export
1199
+ * @interface GenerateTemplateV1Request
1200
+ */
1201
+ export interface GenerateTemplateV1Request {
1202
+ /**
1203
+ *
1204
+ * @type {string}
1205
+ * @memberof GenerateTemplateV1Request
1206
+ */
1207
+ 'assetName': string;
1208
+ /**
1209
+ *
1210
+ * @type {string}
1211
+ * @memberof GenerateTemplateV1Request
1212
+ */
1213
+ 'category'?: string | null;
1214
+ /**
1215
+ *
1216
+ * @type {Array<string>}
1217
+ * @memberof GenerateTemplateV1Request
1218
+ */
1219
+ 'componentIds': Array<string>;
1220
+ /**
1221
+ *
1222
+ * @type {string}
1223
+ * @memberof GenerateTemplateV1Request
1224
+ */
1225
+ 'funcName': string;
1226
+ }
1227
+ /**
1228
+ *
1229
+ * @export
1230
+ * @interface GenerateTemplateV1Response
1231
+ */
1232
+ export interface GenerateTemplateV1Response {
1233
+ /**
1234
+ *
1235
+ * @type {string}
1236
+ * @memberof GenerateTemplateV1Response
1237
+ */
1238
+ 'funcId': string;
1239
+ /**
1240
+ *
1241
+ * @type {string}
1242
+ * @memberof GenerateTemplateV1Response
1243
+ */
1244
+ 'schemaVariantId': string;
1245
+ }
1196
1246
  /**
1197
1247
  *
1198
1248
  * @export
@@ -3279,6 +3329,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
3279
3329
  * @throws {RequiredError}
3280
3330
  */
3281
3331
  findComponent: (workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3332
+ /**
3333
+ *
3334
+ * @summary Generate a template
3335
+ * @param {string} workspaceId Workspace identifier
3336
+ * @param {string} changeSetId Change Set identifier
3337
+ * @param {GenerateTemplateV1Request} generateTemplateV1Request
3338
+ * @param {*} [options] Override http request option.
3339
+ * @throws {RequiredError}
3340
+ */
3341
+ generateTemplate: (workspaceId: string, changeSetId: string, generateTemplateV1Request: GenerateTemplateV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
3282
3342
  /**
3283
3343
  *
3284
3344
  * @summary Get a component by component Id
@@ -3411,6 +3471,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
3411
3471
  * @throws {RequiredError}
3412
3472
  */
3413
3473
  findComponent(workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentV1Response>>;
3474
+ /**
3475
+ *
3476
+ * @summary Generate a template
3477
+ * @param {string} workspaceId Workspace identifier
3478
+ * @param {string} changeSetId Change Set identifier
3479
+ * @param {GenerateTemplateV1Request} generateTemplateV1Request
3480
+ * @param {*} [options] Override http request option.
3481
+ * @throws {RequiredError}
3482
+ */
3483
+ generateTemplate(workspaceId: string, changeSetId: string, generateTemplateV1Request: GenerateTemplateV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateTemplateV1Response>>;
3414
3484
  /**
3415
3485
  *
3416
3486
  * @summary Get a component by component Id
@@ -3528,6 +3598,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
3528
3598
  * @throws {RequiredError}
3529
3599
  */
3530
3600
  findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
3601
+ /**
3602
+ *
3603
+ * @summary Generate a template
3604
+ * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
3605
+ * @param {*} [options] Override http request option.
3606
+ * @throws {RequiredError}
3607
+ */
3608
+ generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateTemplateV1Response>;
3531
3609
  /**
3532
3610
  *
3533
3611
  * @summary Get a component by component Id
@@ -3637,6 +3715,15 @@ export interface ComponentsApiInterface {
3637
3715
  * @memberof ComponentsApiInterface
3638
3716
  */
3639
3717
  findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
3718
+ /**
3719
+ *
3720
+ * @summary Generate a template
3721
+ * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
3722
+ * @param {*} [options] Override http request option.
3723
+ * @throws {RequiredError}
3724
+ * @memberof ComponentsApiInterface
3725
+ */
3726
+ generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateTemplateV1Response>;
3640
3727
  /**
3641
3728
  *
3642
3729
  * @summary Get a component by component Id
@@ -3860,6 +3947,31 @@ export interface ComponentsApiFindComponentRequest {
3860
3947
  */
3861
3948
  readonly componentId?: string | null;
3862
3949
  }
3950
+ /**
3951
+ * Request parameters for generateTemplate operation in ComponentsApi.
3952
+ * @export
3953
+ * @interface ComponentsApiGenerateTemplateRequest
3954
+ */
3955
+ export interface ComponentsApiGenerateTemplateRequest {
3956
+ /**
3957
+ * Workspace identifier
3958
+ * @type {string}
3959
+ * @memberof ComponentsApiGenerateTemplate
3960
+ */
3961
+ readonly workspaceId: string;
3962
+ /**
3963
+ * Change Set identifier
3964
+ * @type {string}
3965
+ * @memberof ComponentsApiGenerateTemplate
3966
+ */
3967
+ readonly changeSetId: string;
3968
+ /**
3969
+ *
3970
+ * @type {GenerateTemplateV1Request}
3971
+ * @memberof ComponentsApiGenerateTemplate
3972
+ */
3973
+ readonly generateTemplateV1Request: GenerateTemplateV1Request;
3974
+ }
3863
3975
  /**
3864
3976
  * Request parameters for getComponent operation in ComponentsApi.
3865
3977
  * @export
@@ -4089,6 +4201,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
4089
4201
  * @memberof ComponentsApi
4090
4202
  */
4091
4203
  findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentV1Response, any>>;
4204
+ /**
4205
+ *
4206
+ * @summary Generate a template
4207
+ * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
4208
+ * @param {*} [options] Override http request option.
4209
+ * @throws {RequiredError}
4210
+ * @memberof ComponentsApi
4211
+ */
4212
+ generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateTemplateV1Response, any>>;
4092
4213
  /**
4093
4214
  *
4094
4215
  * @summary Get a component by component Id
package/dist/cjs/api.js CHANGED
@@ -1175,6 +1175,44 @@ const ComponentsApiAxiosParamCreator = function (configuration) {
1175
1175
  options: localVarRequestOptions,
1176
1176
  };
1177
1177
  },
1178
+ /**
1179
+ *
1180
+ * @summary Generate a template
1181
+ * @param {string} workspaceId Workspace identifier
1182
+ * @param {string} changeSetId Change Set identifier
1183
+ * @param {GenerateTemplateV1Request} generateTemplateV1Request
1184
+ * @param {*} [options] Override http request option.
1185
+ * @throws {RequiredError}
1186
+ */
1187
+ generateTemplate: async (workspaceId, changeSetId, generateTemplateV1Request, options = {}) => {
1188
+ // verify required parameter 'workspaceId' is not null or undefined
1189
+ (0, common_1.assertParamExists)('generateTemplate', 'workspaceId', workspaceId);
1190
+ // verify required parameter 'changeSetId' is not null or undefined
1191
+ (0, common_1.assertParamExists)('generateTemplate', 'changeSetId', changeSetId);
1192
+ // verify required parameter 'generateTemplateV1Request' is not null or undefined
1193
+ (0, common_1.assertParamExists)('generateTemplate', 'generateTemplateV1Request', generateTemplateV1Request);
1194
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/generate_template`
1195
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
1196
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
1197
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1198
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
1199
+ let baseOptions;
1200
+ if (configuration) {
1201
+ baseOptions = configuration.baseOptions;
1202
+ }
1203
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
1204
+ const localVarHeaderParameter = {};
1205
+ const localVarQueryParameter = {};
1206
+ localVarHeaderParameter['Content-Type'] = 'application/json';
1207
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
1208
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1209
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
1210
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(generateTemplateV1Request, localVarRequestOptions, configuration);
1211
+ return {
1212
+ url: (0, common_1.toPathString)(localVarUrlObj),
1213
+ options: localVarRequestOptions,
1214
+ };
1215
+ },
1178
1216
  /**
1179
1217
  *
1180
1218
  * @summary Get a component by component Id
@@ -1515,6 +1553,21 @@ const ComponentsApiFp = function (configuration) {
1515
1553
  const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.findComponent']?.[localVarOperationServerIndex]?.url;
1516
1554
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1517
1555
  },
1556
+ /**
1557
+ *
1558
+ * @summary Generate a template
1559
+ * @param {string} workspaceId Workspace identifier
1560
+ * @param {string} changeSetId Change Set identifier
1561
+ * @param {GenerateTemplateV1Request} generateTemplateV1Request
1562
+ * @param {*} [options] Override http request option.
1563
+ * @throws {RequiredError}
1564
+ */
1565
+ async generateTemplate(workspaceId, changeSetId, generateTemplateV1Request, options) {
1566
+ const localVarAxiosArgs = await localVarAxiosParamCreator.generateTemplate(workspaceId, changeSetId, generateTemplateV1Request, options);
1567
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1568
+ const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.generateTemplate']?.[localVarOperationServerIndex]?.url;
1569
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1570
+ },
1518
1571
  /**
1519
1572
  *
1520
1573
  * @summary Get a component by component Id
@@ -1678,6 +1731,16 @@ const ComponentsApiFactory = function (configuration, basePath, axios) {
1678
1731
  findComponent(requestParameters, options) {
1679
1732
  return localVarFp.findComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.component, requestParameters.componentId, options).then((request) => request(axios, basePath));
1680
1733
  },
1734
+ /**
1735
+ *
1736
+ * @summary Generate a template
1737
+ * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
1738
+ * @param {*} [options] Override http request option.
1739
+ * @throws {RequiredError}
1740
+ */
1741
+ generateTemplate(requestParameters, options) {
1742
+ return localVarFp.generateTemplate(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.generateTemplateV1Request, options).then((request) => request(axios, basePath));
1743
+ },
1681
1744
  /**
1682
1745
  *
1683
1746
  * @summary Get a component by component Id
@@ -1814,6 +1877,17 @@ class ComponentsApi extends base_1.BaseAPI {
1814
1877
  findComponent(requestParameters, options) {
1815
1878
  return (0, exports.ComponentsApiFp)(this.configuration).findComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.component, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
1816
1879
  }
1880
+ /**
1881
+ *
1882
+ * @summary Generate a template
1883
+ * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
1884
+ * @param {*} [options] Override http request option.
1885
+ * @throws {RequiredError}
1886
+ * @memberof ComponentsApi
1887
+ */
1888
+ generateTemplate(requestParameters, options) {
1889
+ return (0, exports.ComponentsApiFp)(this.configuration).generateTemplate(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.generateTemplateV1Request, options).then((request) => request(this.axios, this.basePath));
1890
+ }
1817
1891
  /**
1818
1892
  *
1819
1893
  * @summary Get a component by component Id
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "system-initiative-api-client",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "description": "TypeScript/JavaScript SDK for the System Initiative Public API",
5
5
  "author": "System Initiative <support@systeminit.com>",
6
6
  "repository": {