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/cjs/api.d.ts CHANGED
@@ -1134,6 +1134,56 @@ export interface ErrorResponse {
1134
1134
  */
1135
1135
  'error': ErrorDetail;
1136
1136
  }
1137
+ /**
1138
+ *
1139
+ * @export
1140
+ * @interface ExecDebugFuncV1Request
1141
+ */
1142
+ export interface ExecDebugFuncV1Request {
1143
+ /**
1144
+ *
1145
+ * @type {string}
1146
+ * @memberof ExecDebugFuncV1Request
1147
+ */
1148
+ 'code': string;
1149
+ /**
1150
+ *
1151
+ * @type {string}
1152
+ * @memberof ExecDebugFuncV1Request
1153
+ */
1154
+ 'componentId': string;
1155
+ /**
1156
+ *
1157
+ * @type {any}
1158
+ * @memberof ExecDebugFuncV1Request
1159
+ */
1160
+ 'debugInput'?: any;
1161
+ /**
1162
+ *
1163
+ * @type {string}
1164
+ * @memberof ExecDebugFuncV1Request
1165
+ */
1166
+ 'handler': string;
1167
+ /**
1168
+ *
1169
+ * @type {string}
1170
+ * @memberof ExecDebugFuncV1Request
1171
+ */
1172
+ 'name': string;
1173
+ }
1174
+ /**
1175
+ *
1176
+ * @export
1177
+ * @interface ExecDebugFuncV1Response
1178
+ */
1179
+ export interface ExecDebugFuncV1Response {
1180
+ /**
1181
+ *
1182
+ * @type {string}
1183
+ * @memberof ExecDebugFuncV1Response
1184
+ */
1185
+ 'debugFuncJobStateId': string;
1186
+ }
1137
1187
  /**
1138
1188
  *
1139
1189
  * @export
@@ -1568,6 +1618,31 @@ export interface GetChangeSetV1Response {
1568
1618
  */
1569
1619
  'changeSet': ChangeSetViewV1;
1570
1620
  }
1621
+ /**
1622
+ *
1623
+ * @export
1624
+ * @interface GetComponentResourceDataV1Response
1625
+ */
1626
+ export interface GetComponentResourceDataV1Response {
1627
+ /**
1628
+ *
1629
+ * @type {string}
1630
+ * @memberof GetComponentResourceDataV1Response
1631
+ */
1632
+ 'last_synced': string;
1633
+ /**
1634
+ *
1635
+ * @type {any}
1636
+ * @memberof GetComponentResourceDataV1Response
1637
+ */
1638
+ 'payload'?: any;
1639
+ /**
1640
+ *
1641
+ * @type {string}
1642
+ * @memberof GetComponentResourceDataV1Response
1643
+ */
1644
+ 'status': string;
1645
+ }
1571
1646
  /**
1572
1647
  *
1573
1648
  * @export
@@ -1631,6 +1706,43 @@ export interface GetComponentV1ResponseManagementFunction {
1631
1706
  */
1632
1707
  'managementPrototypeId': string;
1633
1708
  }
1709
+ /**
1710
+ *
1711
+ * @export
1712
+ * @interface GetDebugFuncJobStateV1Response
1713
+ */
1714
+ export interface GetDebugFuncJobStateV1Response {
1715
+ /**
1716
+ *
1717
+ * @type {string}
1718
+ * @memberof GetDebugFuncJobStateV1Response
1719
+ */
1720
+ 'failure'?: string | null;
1721
+ /**
1722
+ *
1723
+ * @type {string}
1724
+ * @memberof GetDebugFuncJobStateV1Response
1725
+ */
1726
+ 'funcRunId'?: string | null;
1727
+ /**
1728
+ *
1729
+ * @type {string}
1730
+ * @memberof GetDebugFuncJobStateV1Response
1731
+ */
1732
+ 'id': string;
1733
+ /**
1734
+ *
1735
+ * @type {any}
1736
+ * @memberof GetDebugFuncJobStateV1Response
1737
+ */
1738
+ 'result'?: any;
1739
+ /**
1740
+ *
1741
+ * @type {string}
1742
+ * @memberof GetDebugFuncJobStateV1Response
1743
+ */
1744
+ 'state': string;
1745
+ }
1634
1746
  /**
1635
1747
  *
1636
1748
  * @export
@@ -4081,6 +4193,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
4081
4193
  * @throws {RequiredError}
4082
4194
  */
4083
4195
  getComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4196
+ /**
4197
+ *
4198
+ * @summary Get a component resource by component Id
4199
+ * @param {string} workspaceId Workspace identifier
4200
+ * @param {string} changeSetId Change Set identifier
4201
+ * @param {string} componentId Component identifier
4202
+ * @param {*} [options] Override http request option.
4203
+ * @throws {RequiredError}
4204
+ */
4205
+ getComponentResource: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4084
4206
  /**
4085
4207
  *
4086
4208
  * @summary List all components
@@ -4254,6 +4376,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
4254
4376
  * @throws {RequiredError}
4255
4377
  */
4256
4378
  getComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentV1Response>>;
4379
+ /**
4380
+ *
4381
+ * @summary Get a component resource by component Id
4382
+ * @param {string} workspaceId Workspace identifier
4383
+ * @param {string} changeSetId Change Set identifier
4384
+ * @param {string} componentId Component identifier
4385
+ * @param {*} [options] Override http request option.
4386
+ * @throws {RequiredError}
4387
+ */
4388
+ getComponentResource(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentResourceDataV1Response>>;
4257
4389
  /**
4258
4390
  *
4259
4391
  * @summary List all components
@@ -4404,6 +4536,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
4404
4536
  * @throws {RequiredError}
4405
4537
  */
4406
4538
  getComponent(requestParameters: ComponentsApiGetComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
4539
+ /**
4540
+ *
4541
+ * @summary Get a component resource by component Id
4542
+ * @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
4543
+ * @param {*} [options] Override http request option.
4544
+ * @throws {RequiredError}
4545
+ */
4546
+ getComponentResource(requestParameters: ComponentsApiGetComponentResourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentResourceDataV1Response>;
4407
4547
  /**
4408
4548
  *
4409
4549
  * @summary List all components
@@ -4549,6 +4689,15 @@ export interface ComponentsApiInterface {
4549
4689
  * @memberof ComponentsApiInterface
4550
4690
  */
4551
4691
  getComponent(requestParameters: ComponentsApiGetComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
4692
+ /**
4693
+ *
4694
+ * @summary Get a component resource by component Id
4695
+ * @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
4696
+ * @param {*} [options] Override http request option.
4697
+ * @throws {RequiredError}
4698
+ * @memberof ComponentsApiInterface
4699
+ */
4700
+ getComponentResource(requestParameters: ComponentsApiGetComponentResourceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentResourceDataV1Response>;
4552
4701
  /**
4553
4702
  *
4554
4703
  * @summary List all components
@@ -4872,6 +5021,31 @@ export interface ComponentsApiGetComponentRequest {
4872
5021
  */
4873
5022
  readonly componentId: string;
4874
5023
  }
5024
+ /**
5025
+ * Request parameters for getComponentResource operation in ComponentsApi.
5026
+ * @export
5027
+ * @interface ComponentsApiGetComponentResourceRequest
5028
+ */
5029
+ export interface ComponentsApiGetComponentResourceRequest {
5030
+ /**
5031
+ * Workspace identifier
5032
+ * @type {string}
5033
+ * @memberof ComponentsApiGetComponentResource
5034
+ */
5035
+ readonly workspaceId: string;
5036
+ /**
5037
+ * Change Set identifier
5038
+ * @type {string}
5039
+ * @memberof ComponentsApiGetComponentResource
5040
+ */
5041
+ readonly changeSetId: string;
5042
+ /**
5043
+ * Component identifier
5044
+ * @type {string}
5045
+ * @memberof ComponentsApiGetComponentResource
5046
+ */
5047
+ readonly componentId: string;
5048
+ }
4875
5049
  /**
4876
5050
  * Request parameters for listComponents operation in ComponentsApi.
4877
5051
  * @export
@@ -5143,6 +5317,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
5143
5317
  * @memberof ComponentsApi
5144
5318
  */
5145
5319
  getComponent(requestParameters: ComponentsApiGetComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentV1Response, any, {}>>;
5320
+ /**
5321
+ *
5322
+ * @summary Get a component resource by component Id
5323
+ * @param {ComponentsApiGetComponentResourceRequest} requestParameters Request parameters.
5324
+ * @param {*} [options] Override http request option.
5325
+ * @throws {RequiredError}
5326
+ * @memberof ComponentsApi
5327
+ */
5328
+ getComponentResource(requestParameters: ComponentsApiGetComponentResourceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentResourceDataV1Response, any, {}>>;
5146
5329
  /**
5147
5330
  *
5148
5331
  * @summary List all components
@@ -5198,6 +5381,181 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
5198
5381
  */
5199
5382
  upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpgradeComponentV1Response, any, {}>>;
5200
5383
  }
5384
+ /**
5385
+ * DebugFuncsApi - axios parameter creator
5386
+ * @export
5387
+ */
5388
+ export declare const DebugFuncsApiAxiosParamCreator: (configuration?: Configuration) => {
5389
+ /**
5390
+ *
5391
+ * @summary Execute a debug function in the context of a component
5392
+ * @param {string} workspaceId Workspace identifier
5393
+ * @param {string} changeSetId Change Set identifier
5394
+ * @param {ExecDebugFuncV1Request} execDebugFuncV1Request
5395
+ * @param {*} [options] Override http request option.
5396
+ * @throws {RequiredError}
5397
+ */
5398
+ execDebugFunc: (workspaceId: string, changeSetId: string, execDebugFuncV1Request: ExecDebugFuncV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5399
+ /**
5400
+ *
5401
+ * @summary Get debug funcs job state details
5402
+ * @param {string} workspaceId Workspace identifier
5403
+ * @param {string} changeSetId Change Set identifier
5404
+ * @param {string} debugFuncJobStateId Debug Func Job identifier
5405
+ * @param {*} [options] Override http request option.
5406
+ * @throws {RequiredError}
5407
+ */
5408
+ getDebugFuncState: (workspaceId: string, changeSetId: string, debugFuncJobStateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5409
+ };
5410
+ /**
5411
+ * DebugFuncsApi - functional programming interface
5412
+ * @export
5413
+ */
5414
+ export declare const DebugFuncsApiFp: (configuration?: Configuration) => {
5415
+ /**
5416
+ *
5417
+ * @summary Execute a debug function in the context of a component
5418
+ * @param {string} workspaceId Workspace identifier
5419
+ * @param {string} changeSetId Change Set identifier
5420
+ * @param {ExecDebugFuncV1Request} execDebugFuncV1Request
5421
+ * @param {*} [options] Override http request option.
5422
+ * @throws {RequiredError}
5423
+ */
5424
+ execDebugFunc(workspaceId: string, changeSetId: string, execDebugFuncV1Request: ExecDebugFuncV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecDebugFuncV1Response>>;
5425
+ /**
5426
+ *
5427
+ * @summary Get debug funcs job state details
5428
+ * @param {string} workspaceId Workspace identifier
5429
+ * @param {string} changeSetId Change Set identifier
5430
+ * @param {string} debugFuncJobStateId Debug Func Job identifier
5431
+ * @param {*} [options] Override http request option.
5432
+ * @throws {RequiredError}
5433
+ */
5434
+ getDebugFuncState(workspaceId: string, changeSetId: string, debugFuncJobStateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDebugFuncJobStateV1Response>>;
5435
+ };
5436
+ /**
5437
+ * DebugFuncsApi - factory interface
5438
+ * @export
5439
+ */
5440
+ export declare const DebugFuncsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
5441
+ /**
5442
+ *
5443
+ * @summary Execute a debug function in the context of a component
5444
+ * @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
5445
+ * @param {*} [options] Override http request option.
5446
+ * @throws {RequiredError}
5447
+ */
5448
+ execDebugFunc(requestParameters: DebugFuncsApiExecDebugFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecDebugFuncV1Response>;
5449
+ /**
5450
+ *
5451
+ * @summary Get debug funcs job state details
5452
+ * @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
5453
+ * @param {*} [options] Override http request option.
5454
+ * @throws {RequiredError}
5455
+ */
5456
+ getDebugFuncState(requestParameters: DebugFuncsApiGetDebugFuncStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDebugFuncJobStateV1Response>;
5457
+ };
5458
+ /**
5459
+ * DebugFuncsApi - interface
5460
+ * @export
5461
+ * @interface DebugFuncsApi
5462
+ */
5463
+ export interface DebugFuncsApiInterface {
5464
+ /**
5465
+ *
5466
+ * @summary Execute a debug function in the context of a component
5467
+ * @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
5468
+ * @param {*} [options] Override http request option.
5469
+ * @throws {RequiredError}
5470
+ * @memberof DebugFuncsApiInterface
5471
+ */
5472
+ execDebugFunc(requestParameters: DebugFuncsApiExecDebugFuncRequest, options?: RawAxiosRequestConfig): AxiosPromise<ExecDebugFuncV1Response>;
5473
+ /**
5474
+ *
5475
+ * @summary Get debug funcs job state details
5476
+ * @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
5477
+ * @param {*} [options] Override http request option.
5478
+ * @throws {RequiredError}
5479
+ * @memberof DebugFuncsApiInterface
5480
+ */
5481
+ getDebugFuncState(requestParameters: DebugFuncsApiGetDebugFuncStateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDebugFuncJobStateV1Response>;
5482
+ }
5483
+ /**
5484
+ * Request parameters for execDebugFunc operation in DebugFuncsApi.
5485
+ * @export
5486
+ * @interface DebugFuncsApiExecDebugFuncRequest
5487
+ */
5488
+ export interface DebugFuncsApiExecDebugFuncRequest {
5489
+ /**
5490
+ * Workspace identifier
5491
+ * @type {string}
5492
+ * @memberof DebugFuncsApiExecDebugFunc
5493
+ */
5494
+ readonly workspaceId: string;
5495
+ /**
5496
+ * Change Set identifier
5497
+ * @type {string}
5498
+ * @memberof DebugFuncsApiExecDebugFunc
5499
+ */
5500
+ readonly changeSetId: string;
5501
+ /**
5502
+ *
5503
+ * @type {ExecDebugFuncV1Request}
5504
+ * @memberof DebugFuncsApiExecDebugFunc
5505
+ */
5506
+ readonly execDebugFuncV1Request: ExecDebugFuncV1Request;
5507
+ }
5508
+ /**
5509
+ * Request parameters for getDebugFuncState operation in DebugFuncsApi.
5510
+ * @export
5511
+ * @interface DebugFuncsApiGetDebugFuncStateRequest
5512
+ */
5513
+ export interface DebugFuncsApiGetDebugFuncStateRequest {
5514
+ /**
5515
+ * Workspace identifier
5516
+ * @type {string}
5517
+ * @memberof DebugFuncsApiGetDebugFuncState
5518
+ */
5519
+ readonly workspaceId: string;
5520
+ /**
5521
+ * Change Set identifier
5522
+ * @type {string}
5523
+ * @memberof DebugFuncsApiGetDebugFuncState
5524
+ */
5525
+ readonly changeSetId: string;
5526
+ /**
5527
+ * Debug Func Job identifier
5528
+ * @type {string}
5529
+ * @memberof DebugFuncsApiGetDebugFuncState
5530
+ */
5531
+ readonly debugFuncJobStateId: string;
5532
+ }
5533
+ /**
5534
+ * DebugFuncsApi - object-oriented interface
5535
+ * @export
5536
+ * @class DebugFuncsApi
5537
+ * @extends {BaseAPI}
5538
+ */
5539
+ export declare class DebugFuncsApi extends BaseAPI implements DebugFuncsApiInterface {
5540
+ /**
5541
+ *
5542
+ * @summary Execute a debug function in the context of a component
5543
+ * @param {DebugFuncsApiExecDebugFuncRequest} requestParameters Request parameters.
5544
+ * @param {*} [options] Override http request option.
5545
+ * @throws {RequiredError}
5546
+ * @memberof DebugFuncsApi
5547
+ */
5548
+ execDebugFunc(requestParameters: DebugFuncsApiExecDebugFuncRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecDebugFuncV1Response, any, {}>>;
5549
+ /**
5550
+ *
5551
+ * @summary Get debug funcs job state details
5552
+ * @param {DebugFuncsApiGetDebugFuncStateRequest} requestParameters Request parameters.
5553
+ * @param {*} [options] Override http request option.
5554
+ * @throws {RequiredError}
5555
+ * @memberof DebugFuncsApi
5556
+ */
5557
+ getDebugFuncState(requestParameters: DebugFuncsApiGetDebugFuncStateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDebugFuncJobStateV1Response, any, {}>>;
5558
+ }
5201
5559
  /**
5202
5560
  * FuncsApi - axios parameter creator
5203
5561
  * @export
@@ -5900,7 +6258,7 @@ export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration
5900
6258
  listSchemas: (workspaceId: string, changeSetId: string, limit?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
5901
6259
  /**
5902
6260
  *
5903
- * @summary Complex search for shemas
6261
+ * @summary Complex search for schemas
5904
6262
  * @param {string} workspaceId Workspace identifier
5905
6263
  * @param {string} changeSetId Change Set identifier
5906
6264
  * @param {SearchSchemasV1Request} searchSchemasV1Request
@@ -6131,7 +6489,7 @@ export declare const SchemasApiFp: (configuration?: Configuration) => {
6131
6489
  listSchemas(workspaceId: string, changeSetId: string, limit?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSchemaV1Response>>;
6132
6490
  /**
6133
6491
  *
6134
- * @summary Complex search for shemas
6492
+ * @summary Complex search for schemas
6135
6493
  * @param {string} workspaceId Workspace identifier
6136
6494
  * @param {string} changeSetId Change Set identifier
6137
6495
  * @param {SearchSchemasV1Request} searchSchemasV1Request
@@ -6305,7 +6663,7 @@ export declare const SchemasApiFactory: (configuration?: Configuration, basePath
6305
6663
  listSchemas(requestParameters: SchemasApiListSchemasRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListSchemaV1Response>;
6306
6664
  /**
6307
6665
  *
6308
- * @summary Complex search for shemas
6666
+ * @summary Complex search for schemas
6309
6667
  * @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
6310
6668
  * @param {*} [options] Override http request option.
6311
6669
  * @throws {RequiredError}
@@ -6489,7 +6847,7 @@ export interface SchemasApiInterface {
6489
6847
  listSchemas(requestParameters: SchemasApiListSchemasRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListSchemaV1Response>;
6490
6848
  /**
6491
6849
  *
6492
- * @summary Complex search for shemas
6850
+ * @summary Complex search for schemas
6493
6851
  * @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
6494
6852
  * @param {*} [options] Override http request option.
6495
6853
  * @throws {RequiredError}
@@ -7327,7 +7685,7 @@ export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
7327
7685
  listSchemas(requestParameters: SchemasApiListSchemasRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSchemaV1Response, any, {}>>;
7328
7686
  /**
7329
7687
  *
7330
- * @summary Complex search for shemas
7688
+ * @summary Complex search for schemas
7331
7689
  * @param {SchemasApiSearchSchemasRequest} requestParameters Request parameters.
7332
7690
  * @param {*} [options] Override http request option.
7333
7691
  * @throws {RequiredError}