system-initiative-api-client 1.12.0 → 1.13.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
@@ -320,6 +320,12 @@ export interface ChangeSetViewV1 {
320
320
  * @interface ComponentDetailsV1
321
321
  */
322
322
  export interface ComponentDetailsV1 {
323
+ /**
324
+ *
325
+ * @type {Array<FunctionRelationshipV1>}
326
+ * @memberof ComponentDetailsV1
327
+ */
328
+ 'actionFunctions'?: Array<FunctionRelationshipV1>;
323
329
  /**
324
330
  *
325
331
  * @type {any}
@@ -332,18 +338,72 @@ export interface ComponentDetailsV1 {
332
338
  * @memberof ComponentDetailsV1
333
339
  */
334
340
  'componentId': string;
341
+ /**
342
+ *
343
+ * @type {string}
344
+ * @memberof ComponentDetailsV1
345
+ */
346
+ 'diffStatus'?: string | null;
347
+ /**
348
+ *
349
+ * @type {boolean}
350
+ * @memberof ComponentDetailsV1
351
+ */
352
+ 'hasDiff'?: boolean | null;
353
+ /**
354
+ *
355
+ * @type {boolean}
356
+ * @memberof ComponentDetailsV1
357
+ */
358
+ 'hasResource'?: boolean | null;
359
+ /**
360
+ *
361
+ * @type {Array<FunctionRelationshipV1>}
362
+ * @memberof ComponentDetailsV1
363
+ */
364
+ 'managementFunctions'?: Array<FunctionRelationshipV1>;
365
+ /**
366
+ *
367
+ * @type {Array<ManagementRelationshipV1>}
368
+ * @memberof ComponentDetailsV1
369
+ */
370
+ 'manages'?: Array<ManagementRelationshipV1>;
335
371
  /**
336
372
  *
337
373
  * @type {string}
338
374
  * @memberof ComponentDetailsV1
339
375
  */
340
376
  'name': string;
377
+ /**
378
+ *
379
+ * @type {Array<FunctionRelationshipV1>}
380
+ * @memberof ComponentDetailsV1
381
+ */
382
+ 'qualificationFunctions'?: Array<FunctionRelationshipV1>;
383
+ /**
384
+ *
385
+ * @type {string}
386
+ * @memberof ComponentDetailsV1
387
+ */
388
+ 'resourceId'?: string | null;
389
+ /**
390
+ *
391
+ * @type {string}
392
+ * @memberof ComponentDetailsV1
393
+ */
394
+ 'resourceStatus'?: string | null;
341
395
  /**
342
396
  *
343
397
  * @type {string}
344
398
  * @memberof ComponentDetailsV1
345
399
  */
346
400
  'schemaName': string;
401
+ /**
402
+ *
403
+ * @type {Array<SubscriptionRelationshipV1>}
404
+ * @memberof ComponentDetailsV1
405
+ */
406
+ 'subscriptions'?: Array<SubscriptionRelationshipV1>;
347
407
  }
348
408
  /**
349
409
  * @type ComponentPropKey
@@ -1134,6 +1194,12 @@ export interface CreateVariantQualificationFuncV1Response {
1134
1194
  * @interface CreateWorkspaceRequest
1135
1195
  */
1136
1196
  export interface CreateWorkspaceRequest {
1197
+ /**
1198
+ *
1199
+ * @type {boolean}
1200
+ * @memberof CreateWorkspaceRequest
1201
+ */
1202
+ 'createSetupToken'?: boolean | null;
1137
1203
  /**
1138
1204
  *
1139
1205
  * @type {string}
@@ -1420,6 +1486,31 @@ export interface ExecuteManagementFunctionV1Response {
1420
1486
  */
1421
1487
  'status': string;
1422
1488
  }
1489
+ /**
1490
+ *
1491
+ * @export
1492
+ * @interface ExecutionHistoryEntry
1493
+ */
1494
+ export interface ExecutionHistoryEntry {
1495
+ /**
1496
+ *
1497
+ * @type {string}
1498
+ * @memberof ExecutionHistoryEntry
1499
+ */
1500
+ 'funcRunId': string;
1501
+ /**
1502
+ *
1503
+ * @type {string}
1504
+ * @memberof ExecutionHistoryEntry
1505
+ */
1506
+ 'startedAt': string;
1507
+ /**
1508
+ *
1509
+ * @type {string}
1510
+ * @memberof ExecutionHistoryEntry
1511
+ */
1512
+ 'state': string;
1513
+ }
1423
1514
  /**
1424
1515
  *
1425
1516
  * @export
@@ -1721,6 +1812,68 @@ export interface FuncRunViewV1 {
1721
1812
  */
1722
1813
  'updatedAt': string;
1723
1814
  }
1815
+ /**
1816
+ *
1817
+ * @export
1818
+ * @interface FunctionExecutionStatusV1
1819
+ */
1820
+ export interface FunctionExecutionStatusV1 {
1821
+ /**
1822
+ *
1823
+ * @type {string}
1824
+ * @memberof FunctionExecutionStatusV1
1825
+ */
1826
+ 'actionId'?: string | null;
1827
+ /**
1828
+ *
1829
+ * @type {string}
1830
+ * @memberof FunctionExecutionStatusV1
1831
+ */
1832
+ 'funcRunId'?: string | null;
1833
+ /**
1834
+ *
1835
+ * @type {boolean}
1836
+ * @memberof FunctionExecutionStatusV1
1837
+ */
1838
+ 'hasActiveRun': boolean;
1839
+ /**
1840
+ *
1841
+ * @type {string}
1842
+ * @memberof FunctionExecutionStatusV1
1843
+ */
1844
+ 'state': string;
1845
+ }
1846
+ /**
1847
+ *
1848
+ * @export
1849
+ * @interface FunctionRelationshipV1
1850
+ */
1851
+ export interface FunctionRelationshipV1 {
1852
+ /**
1853
+ *
1854
+ * @type {Array<string>}
1855
+ * @memberof FunctionRelationshipV1
1856
+ */
1857
+ 'dependsOn'?: Array<string>;
1858
+ /**
1859
+ *
1860
+ * @type {Array<ExecutionHistoryEntry>}
1861
+ * @memberof FunctionRelationshipV1
1862
+ */
1863
+ 'executionHistory'?: Array<ExecutionHistoryEntry>;
1864
+ /**
1865
+ *
1866
+ * @type {FunctionExecutionStatusV1}
1867
+ * @memberof FunctionRelationshipV1
1868
+ */
1869
+ 'executionStatus'?: FunctionExecutionStatusV1 | null;
1870
+ /**
1871
+ *
1872
+ * @type {string}
1873
+ * @memberof FunctionRelationshipV1
1874
+ */
1875
+ 'functionName': string;
1876
+ }
1724
1877
  /**
1725
1878
  *
1726
1879
  * @export
@@ -2261,6 +2414,25 @@ export interface ManagementFunctionReferenceOneOf1 {
2261
2414
  */
2262
2415
  'managementPrototypeId': string;
2263
2416
  }
2417
+ /**
2418
+ *
2419
+ * @export
2420
+ * @interface ManagementRelationshipV1
2421
+ */
2422
+ export interface ManagementRelationshipV1 {
2423
+ /**
2424
+ *
2425
+ * @type {string}
2426
+ * @memberof ManagementRelationshipV1
2427
+ */
2428
+ 'toComponentId': string;
2429
+ /**
2430
+ *
2431
+ * @type {string}
2432
+ * @memberof ManagementRelationshipV1
2433
+ */
2434
+ 'toComponentName': string;
2435
+ }
2264
2436
  /**
2265
2437
  *
2266
2438
  * @export
@@ -2934,6 +3106,43 @@ export interface SourceViewV1 {
2934
3106
  */
2935
3107
  'propPath': string;
2936
3108
  }
3109
+ /**
3110
+ *
3111
+ * @export
3112
+ * @interface SubscriptionRelationshipV1
3113
+ */
3114
+ export interface SubscriptionRelationshipV1 {
3115
+ /**
3116
+ *
3117
+ * @type {any}
3118
+ * @memberof SubscriptionRelationshipV1
3119
+ */
3120
+ 'currentValue'?: any;
3121
+ /**
3122
+ *
3123
+ * @type {string}
3124
+ * @memberof SubscriptionRelationshipV1
3125
+ */
3126
+ 'fromPath': string;
3127
+ /**
3128
+ *
3129
+ * @type {string}
3130
+ * @memberof SubscriptionRelationshipV1
3131
+ */
3132
+ 'toComponentId': string;
3133
+ /**
3134
+ *
3135
+ * @type {string}
3136
+ * @memberof SubscriptionRelationshipV1
3137
+ */
3138
+ 'toComponentName': string;
3139
+ /**
3140
+ *
3141
+ * @type {string}
3142
+ * @memberof SubscriptionRelationshipV1
3143
+ */
3144
+ 'toPath': string;
3145
+ }
2937
3146
  /**
2938
3147
  *
2939
3148
  * @export
@@ -3230,6 +3439,50 @@ export interface UpgradeComponentV1Response {
3230
3439
  */
3231
3440
  'component': ComponentViewV1;
3232
3441
  }
3442
+ /**
3443
+ * The request payload for uploading a policy report
3444
+ * @export
3445
+ * @interface UploadPolicyReportV1Request
3446
+ */
3447
+ export interface UploadPolicyReportV1Request {
3448
+ /**
3449
+ * The unique name of the policy report.
3450
+ * @type {string}
3451
+ * @memberof UploadPolicyReportV1Request
3452
+ */
3453
+ 'name': string;
3454
+ /**
3455
+ * The policy document that was used for evaluation.
3456
+ * @type {string}
3457
+ * @memberof UploadPolicyReportV1Request
3458
+ */
3459
+ 'policy': string;
3460
+ /**
3461
+ * The contents of the report.
3462
+ * @type {string}
3463
+ * @memberof UploadPolicyReportV1Request
3464
+ */
3465
+ 'report': string;
3466
+ /**
3467
+ * Whether the policy check passed or failed.
3468
+ * @type {string}
3469
+ * @memberof UploadPolicyReportV1Request
3470
+ */
3471
+ 'result': string;
3472
+ }
3473
+ /**
3474
+ * The response payload after uploading a policy report.
3475
+ * @export
3476
+ * @interface UploadPolicyReportV1Response
3477
+ */
3478
+ export interface UploadPolicyReportV1Response {
3479
+ /**
3480
+ * The ID of the created policy report.
3481
+ * @type {string}
3482
+ * @memberof UploadPolicyReportV1Response
3483
+ */
3484
+ 'id': string;
3485
+ }
3233
3486
  /**
3234
3487
  *
3235
3488
  * @export
@@ -4330,10 +4583,20 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
4330
4583
  * @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
4331
4584
  * @param {string} [cursor] Cursor for pagination (ComponentId of the last item from previous page)
4332
4585
  * @param {boolean} [includeCodegen] Allow returning the codegen for the cloudformation template for the component (if it exists)
4586
+ * @param {boolean} [includeAll] Include all graph summary data (equivalent to enabling all include options)
4587
+ * @param {boolean} [includeFunctions] Include all function types (action, management, qualification)
4588
+ * @param {boolean} [includeSubscriptions] Include subscription relationships
4589
+ * @param {boolean} [includeManages] Include management relationships
4590
+ * @param {boolean} [includeActionFunctions] Include action function relationships
4591
+ * @param {boolean} [includeManagementFunctions] Include management function relationships
4592
+ * @param {boolean} [includeQualificationFunctions] Include qualification function relationships
4593
+ * @param {boolean} [includeResourceInfo] Include resource information (resource ID and status)
4594
+ * @param {boolean} [includeDiffStatus] Include component diff status vs HEAD (Added/Modified/None)
4595
+ * @param {boolean} [includeExecutionHistory] Include last 10 execution history entries for each function
4333
4596
  * @param {*} [options] Override http request option.
4334
4597
  * @throws {RequiredError}
4335
4598
  */
4336
- listComponents: (workspaceId: string, changeSetId: string, limit?: string, cursor?: string, includeCodegen?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4599
+ listComponents: (workspaceId: string, changeSetId: string, limit?: string, cursor?: string, includeCodegen?: boolean, includeAll?: boolean, includeFunctions?: boolean, includeSubscriptions?: boolean, includeManages?: boolean, includeActionFunctions?: boolean, includeManagementFunctions?: boolean, includeQualificationFunctions?: boolean, includeResourceInfo?: boolean, includeDiffStatus?: boolean, includeExecutionHistory?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
4337
4600
  /**
4338
4601
  *
4339
4602
  * @summary Putting a component under the management of another component
@@ -4503,10 +4766,20 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
4503
4766
  * @param {string} [limit] Maximum number of results to return (default: 50, max: 300)
4504
4767
  * @param {string} [cursor] Cursor for pagination (ComponentId of the last item from previous page)
4505
4768
  * @param {boolean} [includeCodegen] Allow returning the codegen for the cloudformation template for the component (if it exists)
4769
+ * @param {boolean} [includeAll] Include all graph summary data (equivalent to enabling all include options)
4770
+ * @param {boolean} [includeFunctions] Include all function types (action, management, qualification)
4771
+ * @param {boolean} [includeSubscriptions] Include subscription relationships
4772
+ * @param {boolean} [includeManages] Include management relationships
4773
+ * @param {boolean} [includeActionFunctions] Include action function relationships
4774
+ * @param {boolean} [includeManagementFunctions] Include management function relationships
4775
+ * @param {boolean} [includeQualificationFunctions] Include qualification function relationships
4776
+ * @param {boolean} [includeResourceInfo] Include resource information (resource ID and status)
4777
+ * @param {boolean} [includeDiffStatus] Include component diff status vs HEAD (Added/Modified/None)
4778
+ * @param {boolean} [includeExecutionHistory] Include last 10 execution history entries for each function
4506
4779
  * @param {*} [options] Override http request option.
4507
4780
  * @throws {RequiredError}
4508
4781
  */
4509
- listComponents(workspaceId: string, changeSetId: string, limit?: string, cursor?: string, includeCodegen?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListComponentsV1Response>>;
4782
+ listComponents(workspaceId: string, changeSetId: string, limit?: string, cursor?: string, includeCodegen?: boolean, includeAll?: boolean, includeFunctions?: boolean, includeSubscriptions?: boolean, includeManages?: boolean, includeActionFunctions?: boolean, includeManagementFunctions?: boolean, includeQualificationFunctions?: boolean, includeResourceInfo?: boolean, includeDiffStatus?: boolean, includeExecutionHistory?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListComponentsV1Response>>;
4510
4783
  /**
4511
4784
  *
4512
4785
  * @summary Putting a component under the management of another component
@@ -5149,6 +5422,66 @@ export interface ComponentsApiListComponentsRequest {
5149
5422
  * @memberof ComponentsApiListComponents
5150
5423
  */
5151
5424
  readonly includeCodegen?: boolean;
5425
+ /**
5426
+ * Include all graph summary data (equivalent to enabling all include options)
5427
+ * @type {boolean}
5428
+ * @memberof ComponentsApiListComponents
5429
+ */
5430
+ readonly includeAll?: boolean;
5431
+ /**
5432
+ * Include all function types (action, management, qualification)
5433
+ * @type {boolean}
5434
+ * @memberof ComponentsApiListComponents
5435
+ */
5436
+ readonly includeFunctions?: boolean;
5437
+ /**
5438
+ * Include subscription relationships
5439
+ * @type {boolean}
5440
+ * @memberof ComponentsApiListComponents
5441
+ */
5442
+ readonly includeSubscriptions?: boolean;
5443
+ /**
5444
+ * Include management relationships
5445
+ * @type {boolean}
5446
+ * @memberof ComponentsApiListComponents
5447
+ */
5448
+ readonly includeManages?: boolean;
5449
+ /**
5450
+ * Include action function relationships
5451
+ * @type {boolean}
5452
+ * @memberof ComponentsApiListComponents
5453
+ */
5454
+ readonly includeActionFunctions?: boolean;
5455
+ /**
5456
+ * Include management function relationships
5457
+ * @type {boolean}
5458
+ * @memberof ComponentsApiListComponents
5459
+ */
5460
+ readonly includeManagementFunctions?: boolean;
5461
+ /**
5462
+ * Include qualification function relationships
5463
+ * @type {boolean}
5464
+ * @memberof ComponentsApiListComponents
5465
+ */
5466
+ readonly includeQualificationFunctions?: boolean;
5467
+ /**
5468
+ * Include resource information (resource ID and status)
5469
+ * @type {boolean}
5470
+ * @memberof ComponentsApiListComponents
5471
+ */
5472
+ readonly includeResourceInfo?: boolean;
5473
+ /**
5474
+ * Include component diff status vs HEAD (Added/Modified/None)
5475
+ * @type {boolean}
5476
+ * @memberof ComponentsApiListComponents
5477
+ */
5478
+ readonly includeDiffStatus?: boolean;
5479
+ /**
5480
+ * Include last 10 execution history entries for each function
5481
+ * @type {boolean}
5482
+ * @memberof ComponentsApiListComponents
5483
+ */
5484
+ readonly includeExecutionHistory?: boolean;
5152
5485
  }
5153
5486
  /**
5154
5487
  * Request parameters for manageComponent operation in ComponentsApi.
@@ -6122,6 +6455,110 @@ export declare class ManagementFuncsApi extends BaseAPI implements ManagementFun
6122
6455
  */
6123
6456
  getManagementFuncRunState(requestParameters: ManagementFuncsApiGetManagementFuncRunStateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetManagementFuncJobStateV1Response, any, {}>>;
6124
6457
  }
6458
+ /**
6459
+ * PolicyReportsApi - axios parameter creator
6460
+ * @export
6461
+ */
6462
+ export declare const PolicyReportsApiAxiosParamCreator: (configuration?: Configuration) => {
6463
+ /**
6464
+ *
6465
+ * @summary Upload a policy report
6466
+ * @param {string} workspaceId Workspace identifier
6467
+ * @param {string} changeSetId Change Set identifier
6468
+ * @param {UploadPolicyReportV1Request} uploadPolicyReportV1Request
6469
+ * @param {*} [options] Override http request option.
6470
+ * @throws {RequiredError}
6471
+ */
6472
+ uploadPolicyReport: (workspaceId: string, changeSetId: string, uploadPolicyReportV1Request: UploadPolicyReportV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
6473
+ };
6474
+ /**
6475
+ * PolicyReportsApi - functional programming interface
6476
+ * @export
6477
+ */
6478
+ export declare const PolicyReportsApiFp: (configuration?: Configuration) => {
6479
+ /**
6480
+ *
6481
+ * @summary Upload a policy report
6482
+ * @param {string} workspaceId Workspace identifier
6483
+ * @param {string} changeSetId Change Set identifier
6484
+ * @param {UploadPolicyReportV1Request} uploadPolicyReportV1Request
6485
+ * @param {*} [options] Override http request option.
6486
+ * @throws {RequiredError}
6487
+ */
6488
+ uploadPolicyReport(workspaceId: string, changeSetId: string, uploadPolicyReportV1Request: UploadPolicyReportV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadPolicyReportV1Response>>;
6489
+ };
6490
+ /**
6491
+ * PolicyReportsApi - factory interface
6492
+ * @export
6493
+ */
6494
+ export declare const PolicyReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
6495
+ /**
6496
+ *
6497
+ * @summary Upload a policy report
6498
+ * @param {PolicyReportsApiUploadPolicyReportRequest} requestParameters Request parameters.
6499
+ * @param {*} [options] Override http request option.
6500
+ * @throws {RequiredError}
6501
+ */
6502
+ uploadPolicyReport(requestParameters: PolicyReportsApiUploadPolicyReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadPolicyReportV1Response>;
6503
+ };
6504
+ /**
6505
+ * PolicyReportsApi - interface
6506
+ * @export
6507
+ * @interface PolicyReportsApi
6508
+ */
6509
+ export interface PolicyReportsApiInterface {
6510
+ /**
6511
+ *
6512
+ * @summary Upload a policy report
6513
+ * @param {PolicyReportsApiUploadPolicyReportRequest} requestParameters Request parameters.
6514
+ * @param {*} [options] Override http request option.
6515
+ * @throws {RequiredError}
6516
+ * @memberof PolicyReportsApiInterface
6517
+ */
6518
+ uploadPolicyReport(requestParameters: PolicyReportsApiUploadPolicyReportRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadPolicyReportV1Response>;
6519
+ }
6520
+ /**
6521
+ * Request parameters for uploadPolicyReport operation in PolicyReportsApi.
6522
+ * @export
6523
+ * @interface PolicyReportsApiUploadPolicyReportRequest
6524
+ */
6525
+ export interface PolicyReportsApiUploadPolicyReportRequest {
6526
+ /**
6527
+ * Workspace identifier
6528
+ * @type {string}
6529
+ * @memberof PolicyReportsApiUploadPolicyReport
6530
+ */
6531
+ readonly workspaceId: string;
6532
+ /**
6533
+ * Change Set identifier
6534
+ * @type {string}
6535
+ * @memberof PolicyReportsApiUploadPolicyReport
6536
+ */
6537
+ readonly changeSetId: string;
6538
+ /**
6539
+ *
6540
+ * @type {UploadPolicyReportV1Request}
6541
+ * @memberof PolicyReportsApiUploadPolicyReport
6542
+ */
6543
+ readonly uploadPolicyReportV1Request: UploadPolicyReportV1Request;
6544
+ }
6545
+ /**
6546
+ * PolicyReportsApi - object-oriented interface
6547
+ * @export
6548
+ * @class PolicyReportsApi
6549
+ * @extends {BaseAPI}
6550
+ */
6551
+ export declare class PolicyReportsApi extends BaseAPI implements PolicyReportsApiInterface {
6552
+ /**
6553
+ *
6554
+ * @summary Upload a policy report
6555
+ * @param {PolicyReportsApiUploadPolicyReportRequest} requestParameters Request parameters.
6556
+ * @param {*} [options] Override http request option.
6557
+ * @throws {RequiredError}
6558
+ * @memberof PolicyReportsApi
6559
+ */
6560
+ uploadPolicyReport(requestParameters: PolicyReportsApiUploadPolicyReportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadPolicyReportV1Response, any, {}>>;
6561
+ }
6125
6562
  /**
6126
6563
  * RootApi - axios parameter creator
6127
6564
  * @export