@stack-spot/portal-network 0.198.3 → 0.199.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/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.199.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.198.4...portal-network@v0.199.0) (2025-11-25)
4
+
5
+
6
+ ### Features
7
+
8
+ * Adds analytics modules execution times queries ([#1821](https://github.com/stack-spot/portal-commons/issues/1821)) ([56c568d](https://github.com/stack-spot/portal-commons/commit/56c568d1a8d2c18ab8dbfd1f5881e78ec893f733))
9
+ * Adds module docs API support ([#1809](https://github.com/stack-spot/portal-commons/issues/1809)) ([f8238d6](https://github.com/stack-spot/portal-commons/commit/f8238d6c772118d95f2f5436b4957d97c4113a08))
10
+
11
+ ## [0.198.4](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.198.3...portal-network@v0.198.4) (2025-11-24)
12
+
13
+
14
+ ### Bug Fixes
15
+
16
+ * agents v3 ([#1817](https://github.com/stack-spot/portal-commons/issues/1817)) ([3202548](https://github.com/stack-spot/portal-commons/commit/3202548501b50e3ebb06490ea03dc0de62540775))
17
+
3
18
  ## [0.198.3](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.198.2...portal-network@v0.198.3) (2025-11-24)
4
19
 
5
20
 
@@ -7,7 +7,7 @@
7
7
  import * as Oazapfts from "@oazapfts/runtime";
8
8
  export declare const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders>;
9
9
  export declare const servers: {};
10
- export type CodeShiftRole = "list-applications" | "create-application" | "list-repository" | "create-repository" | "delete-repository" | "dispatch-module" | "create-module" | "account-settings" | "list-integration" | "create-integration" | "delete-integration" | "list-program-group" | "create-program-group" | "delete-program-group" | "view-analytics" | "account-discovery-repos";
10
+ export type CodeShiftRole = "list-applications" | "create-application" | "list-repository" | "create-repository" | "delete-repository" | "dispatch-module" | "create-module" | "account-settings" | "list-integration" | "create-integration" | "delete-integration" | "list-program-group" | "create-program-group" | "delete-program-group" | "view-analytics" | "account-discovery-repos" | "account-validate-repos";
11
11
  export type RolesResponse = {
12
12
  result: boolean;
13
13
  };
@@ -61,11 +61,17 @@ export type GitAction = {
61
61
  directory: string;
62
62
  };
63
63
  export type ModuleVisibility = "Personal" | "Account";
64
+ export type UserRequest = {
65
+ /** User ID */
66
+ id: string;
67
+ /** User username */
68
+ username: string;
69
+ /** User email */
70
+ email: string;
71
+ };
64
72
  export type ModulePermission = "read" | "write";
65
73
  export type SharedUserRequest = {
66
- /** Email of user to share with */
67
- email: string;
68
- /** Permission to grant: 'read' or 'write' */
74
+ user: UserRequest;
69
75
  permission: ModulePermission;
70
76
  };
71
77
  export type CreateModuleRequest = {
@@ -185,6 +191,9 @@ export type SharedPermissionResponse = {
185
191
  /** Permission type: 'read' (view/execute) or 'write' (edit/manage) */
186
192
  permission: ModulePermission;
187
193
  };
194
+ export type UserResponse = {
195
+ name: string;
196
+ };
188
197
  export type GetModuleResponse = {
189
198
  /** Module ID */
190
199
  id: string;
@@ -221,6 +230,7 @@ export type GetModuleResponse = {
221
230
  totalUsage: number;
222
231
  /** Module users */
223
232
  totalUsers: number;
233
+ createdBy: UserResponse | null;
224
234
  };
225
235
  export type ExternalItemsModel = {
226
236
  source: string;
@@ -238,7 +248,7 @@ export type OutputModel = {
238
248
  };
239
249
  export type InputModel = {
240
250
  label: string;
241
- name: string;
251
+ name: string | null;
242
252
  "type": string;
243
253
  required: boolean;
244
254
  pattern: string | null;
@@ -262,6 +272,9 @@ export type GetModuleInputsResponse = {
262
272
  inputs: InputModel[];
263
273
  computedInputs: ComputedInputModel[] | null;
264
274
  };
275
+ export type GetModuleDocsResponse = {
276
+ content: string;
277
+ };
265
278
  export type Mode = "scan" | "fix";
266
279
  export type ModuleDispatchRequest = {
267
280
  /** Module mode */
@@ -296,6 +309,9 @@ export type TargetFilesRequest = {
296
309
  details?: string | null;
297
310
  dependsOn?: DependsOnRequest[] | null;
298
311
  issues?: IssuesRequest[] | null;
312
+ totalTokenSent?: number | null;
313
+ totalTokenReceived?: number | null;
314
+ modified?: boolean | null;
299
315
  };
300
316
  export type LanguageInfoRequest = {
301
317
  bytes: number;
@@ -337,7 +353,7 @@ export type ExecutionResponse = {
337
353
  status: string | null;
338
354
  conclusion: string | null;
339
355
  };
340
- export type UserResponse = {
356
+ export type UserResponse2 = {
341
357
  id: string;
342
358
  name: string;
343
359
  email: string;
@@ -366,6 +382,9 @@ export type TargetFilesResponse = {
366
382
  details?: string | null;
367
383
  dependsOn?: DependsOnResponse[] | null;
368
384
  issues?: IssuesResponse[] | null;
385
+ totalTokenSent?: number | null;
386
+ totalTokenReceived?: number | null;
387
+ modified?: boolean | null;
369
388
  };
370
389
  export type ReportStatus = "waiting_dispatch" | "waiting_runner" | "dispatch_failure" | "in_progress" | "suspended" | "error" | "success" | "cancelled";
371
390
  export type PullRequestResponse = {
@@ -382,7 +401,7 @@ export type CustomerRatingResponse = {
382
401
  report_id: string;
383
402
  score: number;
384
403
  commentary: string | null;
385
- created_by: UserResponse;
404
+ created_by: UserResponse2;
386
405
  created_at: string;
387
406
  };
388
407
  export type LanguageResponse = {
@@ -400,7 +419,7 @@ export type GetReportResponse = {
400
419
  mode: string;
401
420
  sourceBranch: string | null;
402
421
  targetBranch?: string | null;
403
- createdBy: UserResponse;
422
+ createdBy: UserResponse2;
404
423
  createdAt: string;
405
424
  updatedAt: string;
406
425
  filesCount: number | null;
@@ -437,7 +456,7 @@ export type GetReportResponseRead = {
437
456
  mode: string;
438
457
  sourceBranch: string | null;
439
458
  targetBranch?: string | null;
440
- createdBy: UserResponse;
459
+ createdBy: UserResponse2;
441
460
  createdAt: string;
442
461
  updatedAt: string;
443
462
  filesCount: number | null;
@@ -485,7 +504,7 @@ export type ModuleResponse3 = {
485
504
  id: string;
486
505
  name: string;
487
506
  };
488
- export type UserResponse2 = {
507
+ export type UserResponse3 = {
489
508
  id: string;
490
509
  name: string;
491
510
  email: string;
@@ -498,7 +517,7 @@ export type ReportResponse = {
498
517
  mode: string;
499
518
  sourceBranch: string;
500
519
  targetBranch?: string | null;
501
- createdBy: UserResponse2;
520
+ createdBy: UserResponse3;
502
521
  createdAt: string;
503
522
  updatedAt: string;
504
523
  filesCount: number | null;
@@ -515,7 +534,7 @@ export type ReportResponseRead = {
515
534
  mode: string;
516
535
  sourceBranch: string;
517
536
  targetBranch?: string | null;
518
- createdBy: UserResponse2;
537
+ createdBy: UserResponse3;
519
538
  createdAt: string;
520
539
  updatedAt: string;
521
540
  filesCount: number | null;
@@ -549,7 +568,7 @@ export type CreateRepositoryRequest = {
549
568
  defaultBranch: string;
550
569
  tags?: string[] | null;
551
570
  };
552
- export type UserResponse3 = {
571
+ export type UserResponse4 = {
553
572
  id: string;
554
573
  name: string;
555
574
  email: string;
@@ -562,7 +581,7 @@ export type ReportResponse2 = {
562
581
  moduleId: string;
563
582
  sourceBranch: string;
564
583
  targetBranch?: string | null;
565
- createdBy: UserResponse3 | null;
584
+ createdBy: UserResponse4 | null;
566
585
  createdAt: string;
567
586
  updatedAt: string;
568
587
  filesCount: number | null;
@@ -579,7 +598,7 @@ export type ReportResponseRead2 = {
579
598
  moduleId: string;
580
599
  sourceBranch: string;
581
600
  targetBranch?: string | null;
582
- createdBy: UserResponse3 | null;
601
+ createdBy: UserResponse4 | null;
583
602
  createdAt: string;
584
603
  updatedAt: string;
585
604
  filesCount: number | null;
@@ -643,6 +662,15 @@ export type PutRepositoryRequest = {
643
662
  export type ValidateScmUrlRequest = {
644
663
  url?: string | null;
645
664
  };
665
+ export type ValidateScmUrlResponse = {
666
+ url: string;
667
+ name: string | null;
668
+ id: string | null;
669
+ defaultBranch: string | null;
670
+ lastCommitDate: string | null;
671
+ archived: boolean | null;
672
+ visibility: string | null;
673
+ };
646
674
  export type GetAccountSettingsRequest = {
647
675
  maxSimultaneousExecution: number | null;
648
676
  createRepositoryValidateBranch: boolean | null;
@@ -703,7 +731,7 @@ export type BodyCreateProgramGroupServiceV1ProgramGroupsPost = {
703
731
  export type CreateProgramGroupResponse = {
704
732
  id: string;
705
733
  };
706
- export type UserResponse4 = {
734
+ export type UserResponse5 = {
707
735
  id: string;
708
736
  name: string;
709
737
  email: string;
@@ -714,7 +742,7 @@ export type ReportResponse3 = {
714
742
  execution: ExecutionResponse | null;
715
743
  mode: string;
716
744
  moduleId: string;
717
- createdBy: UserResponse4 | null;
745
+ createdBy: UserResponse5 | null;
718
746
  createdAt: string;
719
747
  updatedAt: string;
720
748
  filesCount: number | null;
@@ -729,7 +757,7 @@ export type ReportResponseRead3 = {
729
757
  execution: ExecutionResponse | null;
730
758
  mode: string;
731
759
  moduleId: string;
732
- createdBy: UserResponse4 | null;
760
+ createdBy: UserResponse5 | null;
733
761
  createdAt: string;
734
762
  updatedAt: string;
735
763
  filesCount: number | null;
@@ -794,7 +822,7 @@ export type ModuleResponse4 = {
794
822
  id: string;
795
823
  name: string;
796
824
  };
797
- export type UserResponse5 = {
825
+ export type UserResponse6 = {
798
826
  id: string;
799
827
  name: string;
800
828
  email: string;
@@ -805,7 +833,7 @@ export type ReportResponse4 = {
805
833
  "module": ModuleResponse4;
806
834
  execution: ExecutionResponse | null;
807
835
  mode: string;
808
- createdBy: UserResponse5;
836
+ createdBy: UserResponse6;
809
837
  createdAt: string;
810
838
  updatedAt: string;
811
839
  filesCount: number | null;
@@ -820,7 +848,7 @@ export type ReportResponseRead4 = {
820
848
  "module": ModuleResponse4;
821
849
  execution: ExecutionResponse | null;
822
850
  mode: string;
823
- createdBy: UserResponse5;
851
+ createdBy: UserResponse6;
824
852
  createdAt: string;
825
853
  updatedAt: string;
826
854
  filesCount: number | null;
@@ -1071,6 +1099,9 @@ export type ProgramGroupsTargetDetailsResponse = {
1071
1099
  [key: string]: any;
1072
1100
  } | null;
1073
1101
  customerScore?: number | null;
1102
+ totalTokenSent: number | null;
1103
+ totalTokenReceived: number | null;
1104
+ modified: boolean | null;
1074
1105
  };
1075
1106
  export type AnalyticsProgramGroupsTargetDetailsResponse = {
1076
1107
  totalComponents?: number;
@@ -1091,6 +1122,9 @@ export type RepositoryTargetDetailsItemResponse = {
1091
1122
  reportCreatedAt: string | null;
1092
1123
  reportId: string | null;
1093
1124
  customerScore?: number | null;
1125
+ totalTokenSent: number | null;
1126
+ totalTokenReceived: number | null;
1127
+ modified: boolean | null;
1094
1128
  };
1095
1129
  export type AnalyticsRepositoryTargetDetailsResponse = {
1096
1130
  totalFiles?: number;
@@ -1098,13 +1132,51 @@ export type AnalyticsRepositoryTargetDetailsResponse = {
1098
1132
  totalItems?: number;
1099
1133
  items?: RepositoryTargetDetailsItemResponse[];
1100
1134
  };
1101
- export type UserResponse6 = {
1135
+ export type ModuleExecutionTimesDetailsResponse = {
1136
+ /** Name of the module */
1137
+ moduleName: string;
1138
+ /** Version of the module */
1139
+ moduleVersion: string;
1140
+ /** Average queue time in seconds */
1141
+ queueTimeAvg: number;
1142
+ /** 95th percentile queue time in seconds */
1143
+ queueTimeP95: number;
1144
+ /** Average execution time in seconds */
1145
+ executionTimeAvg: number;
1146
+ /** 95th percentile execution time in seconds */
1147
+ executionTimeP95: number;
1148
+ /** Average total time in seconds */
1149
+ totalTimeAvg: number;
1150
+ /** 95th percentile total time in seconds */
1151
+ totalTimeP95: number;
1152
+ /** Number of executions */
1153
+ executionCount: number | null;
1154
+ };
1155
+ export type AnalyticsModuleExecutionTimesResponse = {
1156
+ /** Total number of modules analyzed */
1157
+ modulesCount?: number;
1158
+ /** Overall average queue time */
1159
+ queueTimeAvg: number | null;
1160
+ /** Overall 95th percentile queue time */
1161
+ queueTimeP95: number | null;
1162
+ /** Overall average execution time */
1163
+ executionTimeAvg: number | null;
1164
+ /** Overall 95th percentile execution time */
1165
+ executionTimeP95: number | null;
1166
+ /** Overall average total time */
1167
+ totalTimeAvg: number | null;
1168
+ /** Overall 95th percentile total time */
1169
+ totalTimeP95: number | null;
1170
+ /** Detailed metrics per module */
1171
+ items?: ModuleExecutionTimesDetailsResponse[];
1172
+ };
1173
+ export type UserResponse7 = {
1102
1174
  id: string;
1103
1175
  name: string;
1104
1176
  email: string;
1105
1177
  };
1106
1178
  export type ListUserResponse = {
1107
- items: UserResponse6[];
1179
+ items: UserResponse7[];
1108
1180
  itemsCount: number;
1109
1181
  };
1110
1182
  export type SearchReposInScmRequest = {
@@ -1149,6 +1221,52 @@ export type ResponseSearchRepoByIdResponseRead = {
1149
1221
  exceptions: HttpErrorResponseRead[];
1150
1222
  items?: SearchRepoByIdResponse[];
1151
1223
  };
1224
+ export type BodyCreateReposBatchServiceV2ReposBatchPost = {
1225
+ file: Blob;
1226
+ };
1227
+ export type CreateRepoBatchResponse = {
1228
+ id: string;
1229
+ };
1230
+ export type ImportStatus = "COMPLETED" | "PENDING";
1231
+ export type ValidateRepositoryStatus = "PENDING" | "SUCCESS" | "FAILURE" | "CONFLICT";
1232
+ export type BatchRepositoryResponse = {
1233
+ repositoryId: string | null;
1234
+ repositoryUrl: string;
1235
+ repositoryBranch: string;
1236
+ repositoryTags: string[];
1237
+ status: ValidateRepositoryStatus;
1238
+ line: number;
1239
+ repositoryName: string | null;
1240
+ repositoryArchived: boolean | null;
1241
+ repositoryPushedAt: string | null;
1242
+ repositoryVisibility: string | null;
1243
+ exceptions: HttpErrorResponse[];
1244
+ };
1245
+ export type BatchRepositoryResponseRead = {
1246
+ repositoryId: string | null;
1247
+ repositoryUrl: string;
1248
+ repositoryBranch: string;
1249
+ repositoryTags: string[];
1250
+ status: ValidateRepositoryStatus;
1251
+ line: number;
1252
+ repositoryName: string | null;
1253
+ repositoryArchived: boolean | null;
1254
+ repositoryPushedAt: string | null;
1255
+ repositoryVisibility: string | null;
1256
+ exceptions: HttpErrorResponseRead[];
1257
+ };
1258
+ export type GetImportResultResponse = {
1259
+ status: ImportStatus;
1260
+ totalItems: number;
1261
+ items: BatchRepositoryResponse[];
1262
+ repositoriesIds: string[];
1263
+ };
1264
+ export type GetImportResultResponseRead = {
1265
+ status: ImportStatus;
1266
+ totalItems: number;
1267
+ items: BatchRepositoryResponseRead[];
1268
+ repositoriesIds: string[];
1269
+ };
1152
1270
  /**
1153
1271
  * Check Role Route
1154
1272
  */
@@ -1225,6 +1343,14 @@ export declare function getModuleInputsV1ModulesModuleIdInputsGet({ moduleId, au
1225
1343
  moduleId: string;
1226
1344
  authorization: string;
1227
1345
  }, opts?: Oazapfts.RequestOpts): Promise<GetModuleInputsResponse | null>;
1346
+ /**
1347
+ * Get Module Docs
1348
+ */
1349
+ export declare function getModuleDocsV1ModulesModuleIdDocsGet({ moduleId, language, authorization }: {
1350
+ moduleId: string;
1351
+ language?: "pt-br" | "en-us";
1352
+ authorization: string;
1353
+ }, opts?: Oazapfts.RequestOpts): Promise<GetModuleDocsResponse | null>;
1228
1354
  /**
1229
1355
  * Dispatch Module Service
1230
1356
  */
@@ -1379,10 +1505,11 @@ export declare function updateRepositoryServiceV1ReposRepositoryIdPut({ reposito
1379
1505
  /**
1380
1506
  * Validate Scm Url Service
1381
1507
  */
1382
- export declare function validateScmUrlServiceV1ReposValidateScmUrlPost({ authorization, validateScmUrlRequest }: {
1508
+ export declare function validateScmUrlServiceV1ReposValidateScmUrlPost({ raiseConflict, authorization, validateScmUrlRequest }: {
1509
+ raiseConflict?: boolean;
1383
1510
  authorization: string;
1384
1511
  validateScmUrlRequest: ValidateScmUrlRequest;
1385
- }, opts?: Oazapfts.RequestOpts): Promise<any>;
1512
+ }, opts?: Oazapfts.RequestOpts): Promise<ValidateScmUrlResponse>;
1386
1513
  /**
1387
1514
  * Get Account Settings
1388
1515
  */
@@ -1830,6 +1957,35 @@ export declare function analyticsRepositoryTargetDetailsDownloadV1AnalyticsRepos
1830
1957
  extension?: "csv" | "xlsx";
1831
1958
  authorization: string;
1832
1959
  }, opts?: Oazapfts.RequestOpts): Promise<any>;
1960
+ /**
1961
+ * Analytics Module Execution Times Report
1962
+ */
1963
+ export declare function analyticsModuleExecutionTimesReportV1AnalyticsModulesExecutionTimesGet({ pageSize, page, moduleId, version, mode, startDate, endDate, orderBy, orderDirection, authorization }: {
1964
+ pageSize?: number;
1965
+ page?: number;
1966
+ moduleId?: string[] | null;
1967
+ version?: string[] | null;
1968
+ mode?: ("scan" | "fix") | null;
1969
+ startDate?: string;
1970
+ endDate?: string;
1971
+ orderBy?: ("moduleName" | "moduleVersion" | "queueTimeAvg" | "queueTimeP95" | "executionTimeAvg" | "executionTimeP95" | "totalTimeAvg" | "totalTimeP95" | "executionCount") | null;
1972
+ orderDirection?: ("ASC" | "DESC") | null;
1973
+ authorization: string;
1974
+ }, opts?: Oazapfts.RequestOpts): Promise<AnalyticsModuleExecutionTimesResponse>;
1975
+ /**
1976
+ * Analytics Module Execution Times Download
1977
+ */
1978
+ export declare function analyticsModuleExecutionTimesDownloadV1AnalyticsModulesExecutionTimesDownloadGet({ moduleId, version, mode, startDate, endDate, orderBy, orderDirection, extension, authorization }: {
1979
+ moduleId?: string[] | null;
1980
+ version?: string[] | null;
1981
+ mode?: ("scan" | "fix") | null;
1982
+ startDate?: string;
1983
+ endDate?: string;
1984
+ orderBy?: ("moduleName" | "moduleVersion" | "queueTimeAvg" | "queueTimeP95" | "executionTimeAvg" | "executionTimeP95" | "totalTimeAvg" | "totalTimeP95" | "executionCount") | null;
1985
+ orderDirection?: ("ASC" | "DESC") | null;
1986
+ extension?: "csv" | "xlsx";
1987
+ authorization: string;
1988
+ }, opts?: Oazapfts.RequestOpts): Promise<any>;
1833
1989
  /**
1834
1990
  * List User Service
1835
1991
  */
@@ -1865,7 +2021,34 @@ export declare function downloadSearchReposScmV2V2ReposSearchScmSearchIdDownload
1865
2021
  searchId: string;
1866
2022
  extension?: "csv" | "xlsx";
1867
2023
  authorization: string;
1868
- }, opts?: Oazapfts.RequestOpts): Promise<ResponseSearchRepoByIdResponseRead>;
2024
+ }, opts?: Oazapfts.RequestOpts): Promise<any>;
2025
+ /**
2026
+ * Create Repos Batch Service
2027
+ */
2028
+ export declare function createReposBatchServiceV2ReposBatchPost({ tags, authorization, fastapiCompatV2BodyCreateReposBatchServiceV2ReposBatchPost }: {
2029
+ tags?: string[] | null;
2030
+ authorization: string;
2031
+ fastapiCompatV2BodyCreateReposBatchServiceV2ReposBatchPost: BodyCreateReposBatchServiceV2ReposBatchPost;
2032
+ }, opts?: Oazapfts.RequestOpts): Promise<CreateRepoBatchResponse>;
2033
+ /**
2034
+ * Get Import Result
2035
+ */
2036
+ export declare function getImportResultV2ReposBatchImportIdGet({ importId, pageSize, page, authorization }: {
2037
+ importId: string;
2038
+ pageSize?: number;
2039
+ page?: number;
2040
+ authorization: string;
2041
+ }, opts?: Oazapfts.RequestOpts): Promise<GetImportResultResponseRead>;
2042
+ /**
2043
+ * Download Import Result
2044
+ */
2045
+ export declare function downloadImportResultV2ReposBatchImportIdDownloadGet({ importId, language, status, extension, authorization }: {
2046
+ importId: string;
2047
+ language?: "ptBr" | "enUs";
2048
+ status?: ValidateRepositoryStatus | null;
2049
+ extension?: "csv" | "xlsx";
2050
+ authorization: string;
2051
+ }, opts?: Oazapfts.RequestOpts): Promise<any>;
1869
2052
  /**
1870
2053
  * Pat Health Check
1871
2054
  */