system-initiative-api-client 1.1.8 → 1.3.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 CHANGED
@@ -356,6 +356,44 @@ export interface ComponentReferenceOneOf1 {
356
356
  */
357
357
  'componentId': string;
358
358
  }
359
+ /**
360
+ * Component data in search results.
361
+ * @export
362
+ * @interface ComponentSearchResult
363
+ */
364
+ export interface ComponentSearchResult {
365
+ /**
366
+ *
367
+ * @type {string}
368
+ * @memberof ComponentSearchResult
369
+ */
370
+ 'id': string;
371
+ /**
372
+ *
373
+ * @type {string}
374
+ * @memberof ComponentSearchResult
375
+ */
376
+ 'name': string;
377
+ /**
378
+ *
379
+ * @type {ComponentSearchResultSchema}
380
+ * @memberof ComponentSearchResult
381
+ */
382
+ 'schema': ComponentSearchResultSchema;
383
+ }
384
+ /**
385
+ * The schema for a component in search results.
386
+ * @export
387
+ * @interface ComponentSearchResultSchema
388
+ */
389
+ export interface ComponentSearchResultSchema {
390
+ /**
391
+ *
392
+ * @type {string}
393
+ * @memberof ComponentSearchResultSchema
394
+ */
395
+ 'name': string;
396
+ }
359
397
  /**
360
398
  *
361
399
  * @export
@@ -1683,6 +1721,12 @@ export interface GetSchemaVariantV1Response {
1683
1721
  * @memberof GetSchemaVariantV1Response
1684
1722
  */
1685
1723
  'variantFuncIds': Array<string>;
1724
+ /**
1725
+ *
1726
+ * @type {Array<SchemaVariantFunc>}
1727
+ * @memberof GetSchemaVariantV1Response
1728
+ */
1729
+ 'variantFuncs': Array<SchemaVariantFunc>;
1686
1730
  /**
1687
1731
  *
1688
1732
  * @type {string}
@@ -2157,6 +2201,108 @@ export interface SchemaV1RequestPath {
2157
2201
  */
2158
2202
  'schema_id': string;
2159
2203
  }
2204
+ /**
2205
+ *
2206
+ * @export
2207
+ * @interface SchemaVariantFunc
2208
+ */
2209
+ export interface SchemaVariantFunc {
2210
+ /**
2211
+ *
2212
+ * @type {SchemaVariantFuncKind}
2213
+ * @memberof SchemaVariantFunc
2214
+ */
2215
+ 'funcKind': SchemaVariantFuncKind;
2216
+ /**
2217
+ *
2218
+ * @type {string}
2219
+ * @memberof SchemaVariantFunc
2220
+ */
2221
+ 'id': string;
2222
+ }
2223
+ /**
2224
+ * @type SchemaVariantFuncKind
2225
+ * @export
2226
+ */
2227
+ export type SchemaVariantFuncKind = SchemaVariantFuncKindOneOf | SchemaVariantFuncKindOneOf1 | SchemaVariantFuncKindOneOf2;
2228
+ /**
2229
+ * Action function; carries the specific `ActionKind`.
2230
+ * @export
2231
+ * @interface SchemaVariantFuncKindOneOf
2232
+ */
2233
+ export interface SchemaVariantFuncKindOneOf {
2234
+ /**
2235
+ * Specific action kind
2236
+ * @type {string}
2237
+ * @memberof SchemaVariantFuncKindOneOf
2238
+ */
2239
+ 'actionKind': string;
2240
+ /**
2241
+ *
2242
+ * @type {string}
2243
+ * @memberof SchemaVariantFuncKindOneOf
2244
+ */
2245
+ 'kind': SchemaVariantFuncKindOneOfKindEnum;
2246
+ }
2247
+ /**
2248
+ * @export
2249
+ * @enum {string}
2250
+ */
2251
+ export declare enum SchemaVariantFuncKindOneOfKindEnum {
2252
+ ACTION = "action"
2253
+ }
2254
+ /**
2255
+ * Management function; carries the specific `ManagementFuncKind`.
2256
+ * @export
2257
+ * @interface SchemaVariantFuncKindOneOf1
2258
+ */
2259
+ export interface SchemaVariantFuncKindOneOf1 {
2260
+ /**
2261
+ *
2262
+ * @type {string}
2263
+ * @memberof SchemaVariantFuncKindOneOf1
2264
+ */
2265
+ 'kind': SchemaVariantFuncKindOneOf1KindEnum;
2266
+ /**
2267
+ * Specific management function kind
2268
+ * @type {string}
2269
+ * @memberof SchemaVariantFuncKindOneOf1
2270
+ */
2271
+ 'managementFuncKind': string;
2272
+ }
2273
+ /**
2274
+ * @export
2275
+ * @enum {string}
2276
+ */
2277
+ export declare enum SchemaVariantFuncKindOneOf1KindEnum {
2278
+ MANAGEMENT = "management"
2279
+ }
2280
+ /**
2281
+ * Any other function; exposes the raw `FuncKind` category.
2282
+ * @export
2283
+ * @interface SchemaVariantFuncKindOneOf2
2284
+ */
2285
+ export interface SchemaVariantFuncKindOneOf2 {
2286
+ /**
2287
+ *
2288
+ * @type {string}
2289
+ * @memberof SchemaVariantFuncKindOneOf2
2290
+ */
2291
+ 'funcKind': string;
2292
+ /**
2293
+ *
2294
+ * @type {string}
2295
+ * @memberof SchemaVariantFuncKindOneOf2
2296
+ */
2297
+ 'kind': SchemaVariantFuncKindOneOf2KindEnum;
2298
+ }
2299
+ /**
2300
+ * @export
2301
+ * @enum {string}
2302
+ */
2303
+ export declare enum SchemaVariantFuncKindOneOf2KindEnum {
2304
+ OTHER = "other"
2305
+ }
2160
2306
  /**
2161
2307
  *
2162
2308
  * @export
@@ -2182,6 +2328,12 @@ export interface SchemaVariantV1RequestPath {
2182
2328
  * @interface SearchComponentsV1Request
2183
2329
  */
2184
2330
  export interface SearchComponentsV1Request {
2331
+ /**
2332
+ *
2333
+ * @type {string}
2334
+ * @memberof SearchComponentsV1Request
2335
+ */
2336
+ 'queryString'?: string | null;
2185
2337
  /**
2186
2338
  *
2187
2339
  * @type {string}
@@ -2240,6 +2392,32 @@ export interface SearchSchemasV1Response {
2240
2392
  */
2241
2393
  'schemas': Array<SchemaResponse>;
2242
2394
  }
2395
+ /**
2396
+ *
2397
+ * @export
2398
+ * @interface SearchV1Request
2399
+ */
2400
+ export interface SearchV1Request {
2401
+ /**
2402
+ *
2403
+ * @type {string}
2404
+ * @memberof SearchV1Request
2405
+ */
2406
+ 'q': string;
2407
+ }
2408
+ /**
2409
+ *
2410
+ * @export
2411
+ * @interface SearchV1Response
2412
+ */
2413
+ export interface SearchV1Response {
2414
+ /**
2415
+ *
2416
+ * @type {Array<ComponentSearchResult>}
2417
+ * @memberof SearchV1Response
2418
+ */
2419
+ 'components': Array<ComponentSearchResult>;
2420
+ }
2243
2421
  /**
2244
2422
  *
2245
2423
  * @export
@@ -6163,6 +6341,110 @@ export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
6163
6341
  */
6164
6342
  updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
6165
6343
  }
6344
+ /**
6345
+ * SearchApi - axios parameter creator
6346
+ * @export
6347
+ */
6348
+ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
6349
+ /**
6350
+ *
6351
+ * @summary Complex search for components
6352
+ * @param {string} workspaceId Workspace identifier
6353
+ * @param {string} changeSetId Change Set identifier
6354
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
6355
+ * @param {*} [options] Override http request option.
6356
+ * @throws {RequiredError}
6357
+ */
6358
+ search: (workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6359
+ };
6360
+ /**
6361
+ * SearchApi - functional programming interface
6362
+ * @export
6363
+ */
6364
+ export declare const SearchApiFp: (configuration?: Configuration) => {
6365
+ /**
6366
+ *
6367
+ * @summary Complex search for components
6368
+ * @param {string} workspaceId Workspace identifier
6369
+ * @param {string} changeSetId Change Set identifier
6370
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
6371
+ * @param {*} [options] Override http request option.
6372
+ * @throws {RequiredError}
6373
+ */
6374
+ search(workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchV1Response>>;
6375
+ };
6376
+ /**
6377
+ * SearchApi - factory interface
6378
+ * @export
6379
+ */
6380
+ export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6381
+ /**
6382
+ *
6383
+ * @summary Complex search for components
6384
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
6385
+ * @param {*} [options] Override http request option.
6386
+ * @throws {RequiredError}
6387
+ */
6388
+ search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
6389
+ };
6390
+ /**
6391
+ * SearchApi - interface
6392
+ * @export
6393
+ * @interface SearchApi
6394
+ */
6395
+ export interface SearchApiInterface {
6396
+ /**
6397
+ *
6398
+ * @summary Complex search for components
6399
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
6400
+ * @param {*} [options] Override http request option.
6401
+ * @throws {RequiredError}
6402
+ * @memberof SearchApiInterface
6403
+ */
6404
+ search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
6405
+ }
6406
+ /**
6407
+ * Request parameters for search operation in SearchApi.
6408
+ * @export
6409
+ * @interface SearchApiSearchRequest
6410
+ */
6411
+ export interface SearchApiSearchRequest {
6412
+ /**
6413
+ * Workspace identifier
6414
+ * @type {string}
6415
+ * @memberof SearchApiSearch
6416
+ */
6417
+ readonly workspaceId: string;
6418
+ /**
6419
+ * Change Set identifier
6420
+ * @type {string}
6421
+ * @memberof SearchApiSearch
6422
+ */
6423
+ readonly changeSetId: string;
6424
+ /**
6425
+ * Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
6426
+ * @type {string}
6427
+ * @memberof SearchApiSearch
6428
+ */
6429
+ readonly q: string;
6430
+ }
6431
+ /**
6432
+ * SearchApi - object-oriented interface
6433
+ * @export
6434
+ * @class SearchApi
6435
+ * @extends {BaseAPI}
6436
+ */
6437
+ export declare class SearchApi extends BaseAPI implements SearchApiInterface {
6438
+ /**
6439
+ *
6440
+ * @summary Complex search for components
6441
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
6442
+ * @param {*} [options] Override http request option.
6443
+ * @throws {RequiredError}
6444
+ * @memberof SearchApi
6445
+ */
6446
+ search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchV1Response, any, {}>>;
6447
+ }
6166
6448
  /**
6167
6449
  * SecretsApi - axios parameter creator
6168
6450
  * @export
package/dist/cjs/api.js CHANGED
@@ -16,13 +16,37 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
16
16
  return (mod && mod.__esModule) ? mod : { "default": mod };
17
17
  };
18
18
  Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.WhoamiApi = exports.WhoamiApiFactory = exports.WhoamiApiFp = exports.WhoamiApiAxiosParamCreator = exports.SecretsApi = exports.SecretsApiFactory = exports.SecretsApiFp = exports.SecretsApiAxiosParamCreator = exports.SchemasApi = exports.SchemasApiFactory = exports.SchemasApiFp = exports.SchemasApiAxiosParamCreator = exports.RootApi = exports.RootApiFactory = exports.RootApiFp = exports.RootApiAxiosParamCreator = exports.ManagementFuncsApi = exports.ManagementFuncsApiFactory = exports.ManagementFuncsApiFp = exports.ManagementFuncsApiAxiosParamCreator = exports.FuncsApi = exports.FuncsApiFactory = exports.FuncsApiFp = exports.FuncsApiAxiosParamCreator = exports.ComponentsApi = exports.ComponentsApiFactory = exports.ComponentsApiFp = exports.ComponentsApiAxiosParamCreator = exports.ChangeSetsApi = exports.ChangeSetsApiFactory = exports.ChangeSetsApiFp = exports.ChangeSetsApiAxiosParamCreator = exports.ActionsApi = exports.ActionsApiFactory = exports.ActionsApiFp = exports.ActionsApiAxiosParamCreator = void 0;
19
+ exports.WhoamiApi = exports.WhoamiApiFactory = exports.WhoamiApiFp = exports.WhoamiApiAxiosParamCreator = exports.SecretsApi = exports.SecretsApiFactory = exports.SecretsApiFp = exports.SecretsApiAxiosParamCreator = exports.SearchApi = exports.SearchApiFactory = exports.SearchApiFp = exports.SearchApiAxiosParamCreator = exports.SchemasApi = exports.SchemasApiFactory = exports.SchemasApiFp = exports.SchemasApiAxiosParamCreator = exports.RootApi = exports.RootApiFactory = exports.RootApiFp = exports.RootApiAxiosParamCreator = exports.ManagementFuncsApi = exports.ManagementFuncsApiFactory = exports.ManagementFuncsApiFp = exports.ManagementFuncsApiAxiosParamCreator = exports.FuncsApi = exports.FuncsApiFactory = exports.FuncsApiFp = exports.FuncsApiAxiosParamCreator = exports.ComponentsApi = exports.ComponentsApiFactory = exports.ComponentsApiFp = exports.ComponentsApiAxiosParamCreator = exports.ChangeSetsApi = exports.ChangeSetsApiFactory = exports.ChangeSetsApiFp = exports.ChangeSetsApiAxiosParamCreator = exports.ActionsApi = exports.ActionsApiFactory = exports.ActionsApiFp = exports.ActionsApiAxiosParamCreator = exports.SchemaVariantFuncKindOneOf2KindEnum = exports.SchemaVariantFuncKindOneOf1KindEnum = exports.SchemaVariantFuncKindOneOfKindEnum = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  // Some imports not used depending on template conditions
22
22
  // @ts-ignore
23
23
  const common_1 = require("./common");
24
24
  // @ts-ignore
25
25
  const base_1 = require("./base");
26
+ /**
27
+ * @export
28
+ * @enum {string}
29
+ */
30
+ var SchemaVariantFuncKindOneOfKindEnum;
31
+ (function (SchemaVariantFuncKindOneOfKindEnum) {
32
+ SchemaVariantFuncKindOneOfKindEnum["ACTION"] = "action";
33
+ })(SchemaVariantFuncKindOneOfKindEnum || (exports.SchemaVariantFuncKindOneOfKindEnum = SchemaVariantFuncKindOneOfKindEnum = {}));
34
+ /**
35
+ * @export
36
+ * @enum {string}
37
+ */
38
+ var SchemaVariantFuncKindOneOf1KindEnum;
39
+ (function (SchemaVariantFuncKindOneOf1KindEnum) {
40
+ SchemaVariantFuncKindOneOf1KindEnum["MANAGEMENT"] = "management";
41
+ })(SchemaVariantFuncKindOneOf1KindEnum || (exports.SchemaVariantFuncKindOneOf1KindEnum = SchemaVariantFuncKindOneOf1KindEnum = {}));
42
+ /**
43
+ * @export
44
+ * @enum {string}
45
+ */
46
+ var SchemaVariantFuncKindOneOf2KindEnum;
47
+ (function (SchemaVariantFuncKindOneOf2KindEnum) {
48
+ SchemaVariantFuncKindOneOf2KindEnum["OTHER"] = "other";
49
+ })(SchemaVariantFuncKindOneOf2KindEnum || (exports.SchemaVariantFuncKindOneOf2KindEnum = SchemaVariantFuncKindOneOf2KindEnum = {}));
26
50
  /**
27
51
  * ActionsApi - axios parameter creator
28
52
  * @export
@@ -3704,6 +3728,119 @@ class SchemasApi extends base_1.BaseAPI {
3704
3728
  }
3705
3729
  }
3706
3730
  exports.SchemasApi = SchemasApi;
3731
+ /**
3732
+ * SearchApi - axios parameter creator
3733
+ * @export
3734
+ */
3735
+ const SearchApiAxiosParamCreator = function (configuration) {
3736
+ return {
3737
+ /**
3738
+ *
3739
+ * @summary Complex search for components
3740
+ * @param {string} workspaceId Workspace identifier
3741
+ * @param {string} changeSetId Change Set identifier
3742
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
3743
+ * @param {*} [options] Override http request option.
3744
+ * @throws {RequiredError}
3745
+ */
3746
+ search: async (workspaceId, changeSetId, q, options = {}) => {
3747
+ // verify required parameter 'workspaceId' is not null or undefined
3748
+ (0, common_1.assertParamExists)('search', 'workspaceId', workspaceId);
3749
+ // verify required parameter 'changeSetId' is not null or undefined
3750
+ (0, common_1.assertParamExists)('search', 'changeSetId', changeSetId);
3751
+ // verify required parameter 'q' is not null or undefined
3752
+ (0, common_1.assertParamExists)('search', 'q', q);
3753
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/search`
3754
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
3755
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
3756
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3757
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
3758
+ let baseOptions;
3759
+ if (configuration) {
3760
+ baseOptions = configuration.baseOptions;
3761
+ }
3762
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
3763
+ const localVarHeaderParameter = {};
3764
+ const localVarQueryParameter = {};
3765
+ if (q !== undefined) {
3766
+ localVarQueryParameter['q'] = q;
3767
+ }
3768
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
3769
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3770
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
3771
+ return {
3772
+ url: (0, common_1.toPathString)(localVarUrlObj),
3773
+ options: localVarRequestOptions,
3774
+ };
3775
+ },
3776
+ };
3777
+ };
3778
+ exports.SearchApiAxiosParamCreator = SearchApiAxiosParamCreator;
3779
+ /**
3780
+ * SearchApi - functional programming interface
3781
+ * @export
3782
+ */
3783
+ const SearchApiFp = function (configuration) {
3784
+ const localVarAxiosParamCreator = (0, exports.SearchApiAxiosParamCreator)(configuration);
3785
+ return {
3786
+ /**
3787
+ *
3788
+ * @summary Complex search for components
3789
+ * @param {string} workspaceId Workspace identifier
3790
+ * @param {string} changeSetId Change Set identifier
3791
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
3792
+ * @param {*} [options] Override http request option.
3793
+ * @throws {RequiredError}
3794
+ */
3795
+ async search(workspaceId, changeSetId, q, options) {
3796
+ const localVarAxiosArgs = await localVarAxiosParamCreator.search(workspaceId, changeSetId, q, options);
3797
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3798
+ const localVarOperationServerBasePath = base_1.operationServerMap['SearchApi.search']?.[localVarOperationServerIndex]?.url;
3799
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3800
+ },
3801
+ };
3802
+ };
3803
+ exports.SearchApiFp = SearchApiFp;
3804
+ /**
3805
+ * SearchApi - factory interface
3806
+ * @export
3807
+ */
3808
+ const SearchApiFactory = function (configuration, basePath, axios) {
3809
+ const localVarFp = (0, exports.SearchApiFp)(configuration);
3810
+ return {
3811
+ /**
3812
+ *
3813
+ * @summary Complex search for components
3814
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
3815
+ * @param {*} [options] Override http request option.
3816
+ * @throws {RequiredError}
3817
+ */
3818
+ search(requestParameters, options) {
3819
+ return localVarFp.search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(axios, basePath));
3820
+ },
3821
+ };
3822
+ };
3823
+ exports.SearchApiFactory = SearchApiFactory;
3824
+ /**
3825
+ * SearchApi - object-oriented interface
3826
+ * @export
3827
+ * @class SearchApi
3828
+ * @extends {BaseAPI}
3829
+ */
3830
+ class SearchApi extends base_1.BaseAPI {
3831
+ /**
3832
+ *
3833
+ * @summary Complex search for components
3834
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
3835
+ * @param {*} [options] Override http request option.
3836
+ * @throws {RequiredError}
3837
+ * @memberof SearchApi
3838
+ */
3839
+ search(requestParameters, options) {
3840
+ return (0, exports.SearchApiFp)(this.configuration).search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(this.axios, this.basePath));
3841
+ }
3842
+ }
3843
+ exports.SearchApi = SearchApi;
3707
3844
  /**
3708
3845
  * SecretsApi - axios parameter creator
3709
3846
  * @export
package/dist/esm/api.d.ts CHANGED
@@ -356,6 +356,44 @@ export interface ComponentReferenceOneOf1 {
356
356
  */
357
357
  'componentId': string;
358
358
  }
359
+ /**
360
+ * Component data in search results.
361
+ * @export
362
+ * @interface ComponentSearchResult
363
+ */
364
+ export interface ComponentSearchResult {
365
+ /**
366
+ *
367
+ * @type {string}
368
+ * @memberof ComponentSearchResult
369
+ */
370
+ 'id': string;
371
+ /**
372
+ *
373
+ * @type {string}
374
+ * @memberof ComponentSearchResult
375
+ */
376
+ 'name': string;
377
+ /**
378
+ *
379
+ * @type {ComponentSearchResultSchema}
380
+ * @memberof ComponentSearchResult
381
+ */
382
+ 'schema': ComponentSearchResultSchema;
383
+ }
384
+ /**
385
+ * The schema for a component in search results.
386
+ * @export
387
+ * @interface ComponentSearchResultSchema
388
+ */
389
+ export interface ComponentSearchResultSchema {
390
+ /**
391
+ *
392
+ * @type {string}
393
+ * @memberof ComponentSearchResultSchema
394
+ */
395
+ 'name': string;
396
+ }
359
397
  /**
360
398
  *
361
399
  * @export
@@ -1683,6 +1721,12 @@ export interface GetSchemaVariantV1Response {
1683
1721
  * @memberof GetSchemaVariantV1Response
1684
1722
  */
1685
1723
  'variantFuncIds': Array<string>;
1724
+ /**
1725
+ *
1726
+ * @type {Array<SchemaVariantFunc>}
1727
+ * @memberof GetSchemaVariantV1Response
1728
+ */
1729
+ 'variantFuncs': Array<SchemaVariantFunc>;
1686
1730
  /**
1687
1731
  *
1688
1732
  * @type {string}
@@ -2157,6 +2201,108 @@ export interface SchemaV1RequestPath {
2157
2201
  */
2158
2202
  'schema_id': string;
2159
2203
  }
2204
+ /**
2205
+ *
2206
+ * @export
2207
+ * @interface SchemaVariantFunc
2208
+ */
2209
+ export interface SchemaVariantFunc {
2210
+ /**
2211
+ *
2212
+ * @type {SchemaVariantFuncKind}
2213
+ * @memberof SchemaVariantFunc
2214
+ */
2215
+ 'funcKind': SchemaVariantFuncKind;
2216
+ /**
2217
+ *
2218
+ * @type {string}
2219
+ * @memberof SchemaVariantFunc
2220
+ */
2221
+ 'id': string;
2222
+ }
2223
+ /**
2224
+ * @type SchemaVariantFuncKind
2225
+ * @export
2226
+ */
2227
+ export type SchemaVariantFuncKind = SchemaVariantFuncKindOneOf | SchemaVariantFuncKindOneOf1 | SchemaVariantFuncKindOneOf2;
2228
+ /**
2229
+ * Action function; carries the specific `ActionKind`.
2230
+ * @export
2231
+ * @interface SchemaVariantFuncKindOneOf
2232
+ */
2233
+ export interface SchemaVariantFuncKindOneOf {
2234
+ /**
2235
+ * Specific action kind
2236
+ * @type {string}
2237
+ * @memberof SchemaVariantFuncKindOneOf
2238
+ */
2239
+ 'actionKind': string;
2240
+ /**
2241
+ *
2242
+ * @type {string}
2243
+ * @memberof SchemaVariantFuncKindOneOf
2244
+ */
2245
+ 'kind': SchemaVariantFuncKindOneOfKindEnum;
2246
+ }
2247
+ /**
2248
+ * @export
2249
+ * @enum {string}
2250
+ */
2251
+ export declare enum SchemaVariantFuncKindOneOfKindEnum {
2252
+ ACTION = "action"
2253
+ }
2254
+ /**
2255
+ * Management function; carries the specific `ManagementFuncKind`.
2256
+ * @export
2257
+ * @interface SchemaVariantFuncKindOneOf1
2258
+ */
2259
+ export interface SchemaVariantFuncKindOneOf1 {
2260
+ /**
2261
+ *
2262
+ * @type {string}
2263
+ * @memberof SchemaVariantFuncKindOneOf1
2264
+ */
2265
+ 'kind': SchemaVariantFuncKindOneOf1KindEnum;
2266
+ /**
2267
+ * Specific management function kind
2268
+ * @type {string}
2269
+ * @memberof SchemaVariantFuncKindOneOf1
2270
+ */
2271
+ 'managementFuncKind': string;
2272
+ }
2273
+ /**
2274
+ * @export
2275
+ * @enum {string}
2276
+ */
2277
+ export declare enum SchemaVariantFuncKindOneOf1KindEnum {
2278
+ MANAGEMENT = "management"
2279
+ }
2280
+ /**
2281
+ * Any other function; exposes the raw `FuncKind` category.
2282
+ * @export
2283
+ * @interface SchemaVariantFuncKindOneOf2
2284
+ */
2285
+ export interface SchemaVariantFuncKindOneOf2 {
2286
+ /**
2287
+ *
2288
+ * @type {string}
2289
+ * @memberof SchemaVariantFuncKindOneOf2
2290
+ */
2291
+ 'funcKind': string;
2292
+ /**
2293
+ *
2294
+ * @type {string}
2295
+ * @memberof SchemaVariantFuncKindOneOf2
2296
+ */
2297
+ 'kind': SchemaVariantFuncKindOneOf2KindEnum;
2298
+ }
2299
+ /**
2300
+ * @export
2301
+ * @enum {string}
2302
+ */
2303
+ export declare enum SchemaVariantFuncKindOneOf2KindEnum {
2304
+ OTHER = "other"
2305
+ }
2160
2306
  /**
2161
2307
  *
2162
2308
  * @export
@@ -2182,6 +2328,12 @@ export interface SchemaVariantV1RequestPath {
2182
2328
  * @interface SearchComponentsV1Request
2183
2329
  */
2184
2330
  export interface SearchComponentsV1Request {
2331
+ /**
2332
+ *
2333
+ * @type {string}
2334
+ * @memberof SearchComponentsV1Request
2335
+ */
2336
+ 'queryString'?: string | null;
2185
2337
  /**
2186
2338
  *
2187
2339
  * @type {string}
@@ -2240,6 +2392,32 @@ export interface SearchSchemasV1Response {
2240
2392
  */
2241
2393
  'schemas': Array<SchemaResponse>;
2242
2394
  }
2395
+ /**
2396
+ *
2397
+ * @export
2398
+ * @interface SearchV1Request
2399
+ */
2400
+ export interface SearchV1Request {
2401
+ /**
2402
+ *
2403
+ * @type {string}
2404
+ * @memberof SearchV1Request
2405
+ */
2406
+ 'q': string;
2407
+ }
2408
+ /**
2409
+ *
2410
+ * @export
2411
+ * @interface SearchV1Response
2412
+ */
2413
+ export interface SearchV1Response {
2414
+ /**
2415
+ *
2416
+ * @type {Array<ComponentSearchResult>}
2417
+ * @memberof SearchV1Response
2418
+ */
2419
+ 'components': Array<ComponentSearchResult>;
2420
+ }
2243
2421
  /**
2244
2422
  *
2245
2423
  * @export
@@ -6163,6 +6341,110 @@ export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
6163
6341
  */
6164
6342
  updateSchemaVariant(requestParameters: SchemasApiUpdateSchemaVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
6165
6343
  }
6344
+ /**
6345
+ * SearchApi - axios parameter creator
6346
+ * @export
6347
+ */
6348
+ export declare const SearchApiAxiosParamCreator: (configuration?: Configuration) => {
6349
+ /**
6350
+ *
6351
+ * @summary Complex search for components
6352
+ * @param {string} workspaceId Workspace identifier
6353
+ * @param {string} changeSetId Change Set identifier
6354
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
6355
+ * @param {*} [options] Override http request option.
6356
+ * @throws {RequiredError}
6357
+ */
6358
+ search: (workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6359
+ };
6360
+ /**
6361
+ * SearchApi - functional programming interface
6362
+ * @export
6363
+ */
6364
+ export declare const SearchApiFp: (configuration?: Configuration) => {
6365
+ /**
6366
+ *
6367
+ * @summary Complex search for components
6368
+ * @param {string} workspaceId Workspace identifier
6369
+ * @param {string} changeSetId Change Set identifier
6370
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
6371
+ * @param {*} [options] Override http request option.
6372
+ * @throws {RequiredError}
6373
+ */
6374
+ search(workspaceId: string, changeSetId: string, q: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchV1Response>>;
6375
+ };
6376
+ /**
6377
+ * SearchApi - factory interface
6378
+ * @export
6379
+ */
6380
+ export declare const SearchApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6381
+ /**
6382
+ *
6383
+ * @summary Complex search for components
6384
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
6385
+ * @param {*} [options] Override http request option.
6386
+ * @throws {RequiredError}
6387
+ */
6388
+ search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
6389
+ };
6390
+ /**
6391
+ * SearchApi - interface
6392
+ * @export
6393
+ * @interface SearchApi
6394
+ */
6395
+ export interface SearchApiInterface {
6396
+ /**
6397
+ *
6398
+ * @summary Complex search for components
6399
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
6400
+ * @param {*} [options] Override http request option.
6401
+ * @throws {RequiredError}
6402
+ * @memberof SearchApiInterface
6403
+ */
6404
+ search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchV1Response>;
6405
+ }
6406
+ /**
6407
+ * Request parameters for search operation in SearchApi.
6408
+ * @export
6409
+ * @interface SearchApiSearchRequest
6410
+ */
6411
+ export interface SearchApiSearchRequest {
6412
+ /**
6413
+ * Workspace identifier
6414
+ * @type {string}
6415
+ * @memberof SearchApiSearch
6416
+ */
6417
+ readonly workspaceId: string;
6418
+ /**
6419
+ * Change Set identifier
6420
+ * @type {string}
6421
+ * @memberof SearchApiSearch
6422
+ */
6423
+ readonly changeSetId: string;
6424
+ /**
6425
+ * Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
6426
+ * @type {string}
6427
+ * @memberof SearchApiSearch
6428
+ */
6429
+ readonly q: string;
6430
+ }
6431
+ /**
6432
+ * SearchApi - object-oriented interface
6433
+ * @export
6434
+ * @class SearchApi
6435
+ * @extends {BaseAPI}
6436
+ */
6437
+ export declare class SearchApi extends BaseAPI implements SearchApiInterface {
6438
+ /**
6439
+ *
6440
+ * @summary Complex search for components
6441
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
6442
+ * @param {*} [options] Override http request option.
6443
+ * @throws {RequiredError}
6444
+ * @memberof SearchApi
6445
+ */
6446
+ search(requestParameters: SearchApiSearchRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchV1Response, any, {}>>;
6447
+ }
6166
6448
  /**
6167
6449
  * SecretsApi - axios parameter creator
6168
6450
  * @export
package/dist/esm/api.js CHANGED
@@ -17,6 +17,30 @@ import globalAxios from 'axios';
17
17
  import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
18
18
  // @ts-ignore
19
19
  import { BASE_PATH, BaseAPI, operationServerMap } from './base';
20
+ /**
21
+ * @export
22
+ * @enum {string}
23
+ */
24
+ export var SchemaVariantFuncKindOneOfKindEnum;
25
+ (function (SchemaVariantFuncKindOneOfKindEnum) {
26
+ SchemaVariantFuncKindOneOfKindEnum["ACTION"] = "action";
27
+ })(SchemaVariantFuncKindOneOfKindEnum || (SchemaVariantFuncKindOneOfKindEnum = {}));
28
+ /**
29
+ * @export
30
+ * @enum {string}
31
+ */
32
+ export var SchemaVariantFuncKindOneOf1KindEnum;
33
+ (function (SchemaVariantFuncKindOneOf1KindEnum) {
34
+ SchemaVariantFuncKindOneOf1KindEnum["MANAGEMENT"] = "management";
35
+ })(SchemaVariantFuncKindOneOf1KindEnum || (SchemaVariantFuncKindOneOf1KindEnum = {}));
36
+ /**
37
+ * @export
38
+ * @enum {string}
39
+ */
40
+ export var SchemaVariantFuncKindOneOf2KindEnum;
41
+ (function (SchemaVariantFuncKindOneOf2KindEnum) {
42
+ SchemaVariantFuncKindOneOf2KindEnum["OTHER"] = "other";
43
+ })(SchemaVariantFuncKindOneOf2KindEnum || (SchemaVariantFuncKindOneOf2KindEnum = {}));
20
44
  /**
21
45
  * ActionsApi - axios parameter creator
22
46
  * @export
@@ -3670,6 +3694,115 @@ export class SchemasApi extends BaseAPI {
3670
3694
  return SchemasApiFp(this.configuration).updateSchemaVariant(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, requestParameters.schemaVariantId, requestParameters.updateSchemaVariantV1Request, options).then((request) => request(this.axios, this.basePath));
3671
3695
  }
3672
3696
  }
3697
+ /**
3698
+ * SearchApi - axios parameter creator
3699
+ * @export
3700
+ */
3701
+ export const SearchApiAxiosParamCreator = function (configuration) {
3702
+ return {
3703
+ /**
3704
+ *
3705
+ * @summary Complex search for components
3706
+ * @param {string} workspaceId Workspace identifier
3707
+ * @param {string} changeSetId Change Set identifier
3708
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
3709
+ * @param {*} [options] Override http request option.
3710
+ * @throws {RequiredError}
3711
+ */
3712
+ search: async (workspaceId, changeSetId, q, options = {}) => {
3713
+ // verify required parameter 'workspaceId' is not null or undefined
3714
+ assertParamExists('search', 'workspaceId', workspaceId);
3715
+ // verify required parameter 'changeSetId' is not null or undefined
3716
+ assertParamExists('search', 'changeSetId', changeSetId);
3717
+ // verify required parameter 'q' is not null or undefined
3718
+ assertParamExists('search', 'q', q);
3719
+ const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/search`
3720
+ .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
3721
+ .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
3722
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
3723
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3724
+ let baseOptions;
3725
+ if (configuration) {
3726
+ baseOptions = configuration.baseOptions;
3727
+ }
3728
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
3729
+ const localVarHeaderParameter = {};
3730
+ const localVarQueryParameter = {};
3731
+ if (q !== undefined) {
3732
+ localVarQueryParameter['q'] = q;
3733
+ }
3734
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
3735
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3736
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
3737
+ return {
3738
+ url: toPathString(localVarUrlObj),
3739
+ options: localVarRequestOptions,
3740
+ };
3741
+ },
3742
+ };
3743
+ };
3744
+ /**
3745
+ * SearchApi - functional programming interface
3746
+ * @export
3747
+ */
3748
+ export const SearchApiFp = function (configuration) {
3749
+ const localVarAxiosParamCreator = SearchApiAxiosParamCreator(configuration);
3750
+ return {
3751
+ /**
3752
+ *
3753
+ * @summary Complex search for components
3754
+ * @param {string} workspaceId Workspace identifier
3755
+ * @param {string} changeSetId Change Set identifier
3756
+ * @param {string} q Query string. See https://docs.systeminit.com/explanation/search-syntax for details.
3757
+ * @param {*} [options] Override http request option.
3758
+ * @throws {RequiredError}
3759
+ */
3760
+ async search(workspaceId, changeSetId, q, options) {
3761
+ const localVarAxiosArgs = await localVarAxiosParamCreator.search(workspaceId, changeSetId, q, options);
3762
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3763
+ const localVarOperationServerBasePath = operationServerMap['SearchApi.search']?.[localVarOperationServerIndex]?.url;
3764
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3765
+ },
3766
+ };
3767
+ };
3768
+ /**
3769
+ * SearchApi - factory interface
3770
+ * @export
3771
+ */
3772
+ export const SearchApiFactory = function (configuration, basePath, axios) {
3773
+ const localVarFp = SearchApiFp(configuration);
3774
+ return {
3775
+ /**
3776
+ *
3777
+ * @summary Complex search for components
3778
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
3779
+ * @param {*} [options] Override http request option.
3780
+ * @throws {RequiredError}
3781
+ */
3782
+ search(requestParameters, options) {
3783
+ return localVarFp.search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(axios, basePath));
3784
+ },
3785
+ };
3786
+ };
3787
+ /**
3788
+ * SearchApi - object-oriented interface
3789
+ * @export
3790
+ * @class SearchApi
3791
+ * @extends {BaseAPI}
3792
+ */
3793
+ export class SearchApi extends BaseAPI {
3794
+ /**
3795
+ *
3796
+ * @summary Complex search for components
3797
+ * @param {SearchApiSearchRequest} requestParameters Request parameters.
3798
+ * @param {*} [options] Override http request option.
3799
+ * @throws {RequiredError}
3800
+ * @memberof SearchApi
3801
+ */
3802
+ search(requestParameters, options) {
3803
+ return SearchApiFp(this.configuration).search(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.q, options).then((request) => request(this.axios, this.basePath));
3804
+ }
3805
+ }
3673
3806
  /**
3674
3807
  * SecretsApi - axios parameter creator
3675
3808
  * @export
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "system-initiative-api-client",
3
- "version": "1.1.8",
3
+ "version": "1.3.0",
4
4
  "description": "TypeScript/JavaScript SDK for the System Initiative Public API",
5
5
  "author": "System Initiative <support@systeminit.com>",
6
6
  "repository": {