athenian 2.1.81

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.
Files changed (682) hide show
  1. checksums.yaml +7 -0
  2. data/CODE_OF_CONDUCT.md +84 -0
  3. data/Gemfile +7 -0
  4. data/Gemfile.lock +60 -0
  5. data/LICENSE.txt +21 -0
  6. data/README.md +76 -0
  7. data/Rakefile +10 -0
  8. data/athenian.gemspec +35 -0
  9. data/bin/console +15 -0
  10. data/bin/setup +8 -0
  11. data/docs/AcceptedInvitation.md +22 -0
  12. data/docs/Account.md +26 -0
  13. data/docs/AccountStatus.md +26 -0
  14. data/docs/AccountUserChangeRequest.md +22 -0
  15. data/docs/AlignApi.md +367 -0
  16. data/docs/CalculatedCodeCheckHistogram.md +28 -0
  17. data/docs/CalculatedCodeCheckMetrics.md +32 -0
  18. data/docs/CalculatedCodeCheckMetricsItem.md +26 -0
  19. data/docs/CalculatedDeploymentMetric.md +24 -0
  20. data/docs/CalculatedDeveloperMetrics.md +28 -0
  21. data/docs/CalculatedDeveloperMetricsItem.md +22 -0
  22. data/docs/CalculatedJIRAHistogram.md +28 -0
  23. data/docs/CalculatedJIRAMetricValues.md +26 -0
  24. data/docs/CalculatedLinearMetricValues.md +26 -0
  25. data/docs/CalculatedLinearMetricValuesConfidenceMinsInner.md +49 -0
  26. data/docs/CalculatedLinearMetricValuesValuesInner.md +51 -0
  27. data/docs/CalculatedPullRequestHistogram.md +28 -0
  28. data/docs/CalculatedPullRequestHistogramFrequenciesInner.md +49 -0
  29. data/docs/CalculatedPullRequestMetrics.md +32 -0
  30. data/docs/CalculatedPullRequestMetricsItem.md +22 -0
  31. data/docs/CalculatedReleaseMetric.md +30 -0
  32. data/docs/CodeBypassingPRsMeasurement.md +26 -0
  33. data/docs/CodeCheckHistogramDefinition.md +24 -0
  34. data/docs/CodeCheckHistogramsRequest.md +32 -0
  35. data/docs/CodeCheckMetricID.md +15 -0
  36. data/docs/CodeCheckMetricsRequest.md +34 -0
  37. data/docs/CodeCheckRunStatistics.md +40 -0
  38. data/docs/CodeCheckRunStatisticsMeanExecutionTime.md +15 -0
  39. data/docs/CodeCheckRunStatisticsMedianExecutionTime.md +15 -0
  40. data/docs/CodeCheckRunStatisticsStddevExecutionTime.md +15 -0
  41. data/docs/CodeFilter.md +34 -0
  42. data/docs/Commit.md +36 -0
  43. data/docs/CommitSignature.md +26 -0
  44. data/docs/CommitsList.md +20 -0
  45. data/docs/CommitsListInclude.md +20 -0
  46. data/docs/Contributor.md +26 -0
  47. data/docs/ContributorIdentity.md +20 -0
  48. data/docs/CreateTokenRequest.md +20 -0
  49. data/docs/CreatedIdentifier.md +18 -0
  50. data/docs/CreatedToken.md +20 -0
  51. data/docs/Datasource.md +15 -0
  52. data/docs/DeleteEventsCacheRequest.md +22 -0
  53. data/docs/DeployedComponent.md +20 -0
  54. data/docs/DeployedPullRequest.md +32 -0
  55. data/docs/DeployedPullRequestAllOf.md +18 -0
  56. data/docs/DeployedRelease.md +40 -0
  57. data/docs/DeploymentAnalysis.md +22 -0
  58. data/docs/DeploymentAnalysisCode.md +28 -0
  59. data/docs/DeploymentConclusion.md +15 -0
  60. data/docs/DeploymentMetricID.md +15 -0
  61. data/docs/DeploymentMetricsRequest.md +32 -0
  62. data/docs/DeploymentModifyLabelsRequest.md +20 -0
  63. data/docs/DeploymentNotification.md +32 -0
  64. data/docs/DeploymentWith.md +22 -0
  65. data/docs/DeveloperMetricID.md +15 -0
  66. data/docs/DeveloperMetricsRequest.md +30 -0
  67. data/docs/DeveloperSummary.md +26 -0
  68. data/docs/DeveloperUpdates.md +28 -0
  69. data/docs/DiffReleasesRequest.md +20 -0
  70. data/docs/DiffedReleases.md +20 -0
  71. data/docs/DiffedReleasesInclude.md +20 -0
  72. data/docs/EventsApi.md +370 -0
  73. data/docs/FilterApi.md +832 -0
  74. data/docs/FilterCodeChecksRequest.md +36 -0
  75. data/docs/FilterCommitsRequest.md +34 -0
  76. data/docs/FilterContributorsRequest.md +28 -0
  77. data/docs/FilterDeploymentsRequest.md +42 -0
  78. data/docs/FilterEnvironmentsRequest.md +26 -0
  79. data/docs/FilterJIRACommon.md +30 -0
  80. data/docs/FilterJIRAStuff.md +40 -0
  81. data/docs/FilterJIRAStuffWith.md +22 -0
  82. data/docs/FilterLabelsRequest.md +20 -0
  83. data/docs/FilterPullRequestsRequest.md +48 -0
  84. data/docs/FilterReleasesRequest.md +34 -0
  85. data/docs/FilterRepositoriesRequest.md +28 -0
  86. data/docs/FilteredCodeCheckRun.md +30 -0
  87. data/docs/FilteredCodeCheckRunPrsStats.md +40 -0
  88. data/docs/FilteredCodeCheckRunTotalStats.md +40 -0
  89. data/docs/FilteredCodeCheckRuns.md +20 -0
  90. data/docs/FilteredDeployment.md +38 -0
  91. data/docs/FilteredDeployments.md +20 -0
  92. data/docs/FilteredDeploymentsInclude.md +20 -0
  93. data/docs/FilteredEnvironment.md +24 -0
  94. data/docs/FilteredJIRAStuff.md +32 -0
  95. data/docs/FilteredLabel.md +24 -0
  96. data/docs/FilteredRelease.md +42 -0
  97. data/docs/ForSetCodeChecks.md +32 -0
  98. data/docs/ForSetCodeChecksJira.md +32 -0
  99. data/docs/ForSetDeployments.md +38 -0
  100. data/docs/ForSetDevelopers.md +30 -0
  101. data/docs/ForSetPullRequests.md +36 -0
  102. data/docs/GenericError.md +26 -0
  103. data/docs/GetApi.md +305 -0
  104. data/docs/GetDeploymentLabels200Response.md +18 -0
  105. data/docs/GetJIRAIssuesInclude.md +15 -0
  106. data/docs/GetJIRAIssuesRequest.md +22 -0
  107. data/docs/GetJIRAIssuesResponse.md +20 -0
  108. data/docs/GetJIRAIssuesResponseInclude.md +20 -0
  109. data/docs/GetPullRequestsRequest.md +22 -0
  110. data/docs/GetReleasesRequest.md +20 -0
  111. data/docs/GoalMetricParams.md +18 -0
  112. data/docs/GoalMetricParamsThreshold.md +49 -0
  113. data/docs/GoalTemplate.md +28 -0
  114. data/docs/GoalTemplateCreateRequest.md +26 -0
  115. data/docs/GoalTemplateMetric.md +51 -0
  116. data/docs/GoalTemplateUpdateRequest.md +24 -0
  117. data/docs/HistogramScale.md +15 -0
  118. data/docs/HistogramsApi.md +226 -0
  119. data/docs/IncludedDeployments.md +18 -0
  120. data/docs/IncludedJIRAIssues.md +18 -0
  121. data/docs/IncludedNativeUser.md +18 -0
  122. data/docs/IncludedNativeUsers.md +18 -0
  123. data/docs/InstallationProgress.md +26 -0
  124. data/docs/IntegrationsApi.md +157 -0
  125. data/docs/Interquartile.md +20 -0
  126. data/docs/InvalidRequestError.md +28 -0
  127. data/docs/InvalidRequestErrorAllOf.md +18 -0
  128. data/docs/InvitationCheckResult.md +22 -0
  129. data/docs/InvitationLink.md +18 -0
  130. data/docs/InvitedUser.md +20 -0
  131. data/docs/JIRAComment.md +22 -0
  132. data/docs/JIRAEpic.md +58 -0
  133. data/docs/JIRAEpicAllOf.md +22 -0
  134. data/docs/JIRAEpicChild.md +56 -0
  135. data/docs/JIRAEpicChildAllOf.md +20 -0
  136. data/docs/JIRAEpicIssueCommon.md +52 -0
  137. data/docs/JIRAFilter.md +32 -0
  138. data/docs/JIRAFilterReturn.md +15 -0
  139. data/docs/JIRAFilterWith.md +22 -0
  140. data/docs/JIRAHistogramDefinition.md +24 -0
  141. data/docs/JIRAHistogramsRequest.md +44 -0
  142. data/docs/JIRAInstallation.md +20 -0
  143. data/docs/JIRAIssue.md +56 -0
  144. data/docs/JIRAIssueAllOf.md +20 -0
  145. data/docs/JIRAIssueType.md +30 -0
  146. data/docs/JIRALabel.md +24 -0
  147. data/docs/JIRAMetricID.md +15 -0
  148. data/docs/JIRAMetricsRequest.md +50 -0
  149. data/docs/JIRAPriority.md +24 -0
  150. data/docs/JIRAProject.md +30 -0
  151. data/docs/JIRAProjectsRequest.md +20 -0
  152. data/docs/JIRAStatus.md +22 -0
  153. data/docs/JIRAStatusCategory.md +15 -0
  154. data/docs/JIRAUser.md +24 -0
  155. data/docs/LinkedJIRAIssue.md +26 -0
  156. data/docs/ListedToken.md +22 -0
  157. data/docs/LogicalDeploymentRules.md +20 -0
  158. data/docs/LogicalPRRules.md +20 -0
  159. data/docs/LogicalRepository.md +26 -0
  160. data/docs/LogicalRepositoryGetRequest.md +20 -0
  161. data/docs/LogicalRepositoryRequest.md +28 -0
  162. data/docs/MappedJIRAIdentity.md +24 -0
  163. data/docs/MappedJIRAIdentityChange.md +20 -0
  164. data/docs/MatchIdentitiesRequest.md +20 -0
  165. data/docs/MatchedIdentity.md +22 -0
  166. data/docs/MatchedIdentityTo.md +15 -0
  167. data/docs/MetricsApi.md +518 -0
  168. data/docs/NotifiedDeploymentsInner.md +20 -0
  169. data/docs/NotifyDeployments200Response.md +18 -0
  170. data/docs/Organization.md +22 -0
  171. data/docs/PaginatePullRequestsRequest.md +20 -0
  172. data/docs/PaginationApi.md +82 -0
  173. data/docs/PatchTokenRequest.md +18 -0
  174. data/docs/ProductFeature.md +20 -0
  175. data/docs/ProductFeatureParameters.md +51 -0
  176. data/docs/PullRequest.md +74 -0
  177. data/docs/PullRequestEvent.md +15 -0
  178. data/docs/PullRequestHistogramDefinition.md +24 -0
  179. data/docs/PullRequestHistogramsRequest.md +34 -0
  180. data/docs/PullRequestLabel.md +22 -0
  181. data/docs/PullRequestMetricID.md +15 -0
  182. data/docs/PullRequestMetricsRequest.md +36 -0
  183. data/docs/PullRequestNumbers.md +20 -0
  184. data/docs/PullRequestPaginationPlan.md +18 -0
  185. data/docs/PullRequestParticipant.md +20 -0
  186. data/docs/PullRequestSet.md +20 -0
  187. data/docs/PullRequestSetInclude.md +20 -0
  188. data/docs/PullRequestStage.md +15 -0
  189. data/docs/PullRequestWith.md +30 -0
  190. data/docs/RegistrationApi.md +420 -0
  191. data/docs/ReleaseDiff.md +22 -0
  192. data/docs/ReleaseMatchRequest.md +28 -0
  193. data/docs/ReleaseMatchSetting.md +26 -0
  194. data/docs/ReleaseMatchStrategy.md +15 -0
  195. data/docs/ReleaseMetricID.md +15 -0
  196. data/docs/ReleaseMetricsRequest.md +42 -0
  197. data/docs/ReleaseMetricsRequestForInner.md +49 -0
  198. data/docs/ReleaseNames.md +20 -0
  199. data/docs/ReleaseNotification.md +28 -0
  200. data/docs/ReleaseNotificationStatus.md +15 -0
  201. data/docs/ReleasePair.md +20 -0
  202. data/docs/ReleaseSet.md +20 -0
  203. data/docs/ReleaseSetInclude.md +22 -0
  204. data/docs/ReleaseWith.md +22 -0
  205. data/docs/ReleasedPullRequest.md +30 -0
  206. data/docs/ReleasedPullRequestAuthor.md +15 -0
  207. data/docs/ReposetApi.md +363 -0
  208. data/docs/RepositorySetCreateRequest.md +22 -0
  209. data/docs/RepositorySetListItem.md +26 -0
  210. data/docs/RepositorySetWithName.md +22 -0
  211. data/docs/SecurityApi.md +290 -0
  212. data/docs/SetMappedJIRAIdentitiesRequest.md +20 -0
  213. data/docs/SettingsApi.md +942 -0
  214. data/docs/Share.md +22 -0
  215. data/docs/StageTimings.md +26 -0
  216. data/docs/TableFetchingProgress.md +22 -0
  217. data/docs/Team.md +24 -0
  218. data/docs/TeamApi.md +440 -0
  219. data/docs/TeamCreateRequest.md +24 -0
  220. data/docs/TeamUpdateRequest.md +22 -0
  221. data/docs/User.md +34 -0
  222. data/docs/UserApi.md +431 -0
  223. data/docs/VersionApi.md +67 -0
  224. data/docs/Versions.md +20 -0
  225. data/docs/WithBothJiraAndJiragroups.md +20 -0
  226. data/docs/WorkType.md +22 -0
  227. data/docs/WorkTypeGetRequest.md +20 -0
  228. data/docs/WorkTypePutRequest.md +20 -0
  229. data/docs/WorkTypeRule.md +20 -0
  230. data/generator/generate_api.sh +37 -0
  231. data/generator/generator_config.yml +10 -0
  232. data/generator/openapi.yaml +11297 -0
  233. data/generator/openapi_generated.yaml +11139 -0
  234. data/generator/template/api_info.mustache +6 -0
  235. data/generator/template_data.json +3 -0
  236. data/lib/athenian/api/align_api.rb +335 -0
  237. data/lib/athenian/api/events_api.rb +334 -0
  238. data/lib/athenian/api/filter_api.rb +701 -0
  239. data/lib/athenian/api/get_api.rb +266 -0
  240. data/lib/athenian/api/histograms_api.rb +217 -0
  241. data/lib/athenian/api/integrations_api.rb +150 -0
  242. data/lib/athenian/api/metrics_api.rb +481 -0
  243. data/lib/athenian/api/pagination_api.rb +81 -0
  244. data/lib/athenian/api/registration_api.rb +395 -0
  245. data/lib/athenian/api/reposet_api.rb +332 -0
  246. data/lib/athenian/api/security_api.rb +271 -0
  247. data/lib/athenian/api/settings_api.rb +820 -0
  248. data/lib/athenian/api/team_api.rb +396 -0
  249. data/lib/athenian/api/user_api.rb +381 -0
  250. data/lib/athenian/api/version_api.rb +74 -0
  251. data/lib/athenian/api_client.rb +389 -0
  252. data/lib/athenian/api_error.rb +55 -0
  253. data/lib/athenian/configuration.rb +294 -0
  254. data/lib/athenian/models/accepted_invitation.rb +241 -0
  255. data/lib/athenian/models/account.rb +283 -0
  256. data/lib/athenian/models/account_status.rb +281 -0
  257. data/lib/athenian/models/account_user_change_request.rb +285 -0
  258. data/lib/athenian/models/calculated_code_check_histogram.rb +318 -0
  259. data/lib/athenian/models/calculated_code_check_metrics.rb +386 -0
  260. data/lib/athenian/models/calculated_code_check_metrics_item.rb +291 -0
  261. data/lib/athenian/models/calculated_deployment_metric.rb +268 -0
  262. data/lib/athenian/models/calculated_developer_metrics.rb +340 -0
  263. data/lib/athenian/models/calculated_developer_metrics_item.rb +252 -0
  264. data/lib/athenian/models/calculated_jira_histogram.rb +313 -0
  265. data/lib/athenian/models/calculated_jira_metric_values.rb +266 -0
  266. data/lib/athenian/models/calculated_linear_metric_values.rb +273 -0
  267. data/lib/athenian/models/calculated_linear_metric_values_confidence_mins_inner.rb +101 -0
  268. data/lib/athenian/models/calculated_linear_metric_values_values_inner.rb +102 -0
  269. data/lib/athenian/models/calculated_pull_request_histogram.rb +318 -0
  270. data/lib/athenian/models/calculated_pull_request_histogram_frequencies_inner.rb +101 -0
  271. data/lib/athenian/models/calculated_pull_request_metrics.rb +391 -0
  272. data/lib/athenian/models/calculated_pull_request_metrics_item.rb +247 -0
  273. data/lib/athenian/models/calculated_release_metric.rb +301 -0
  274. data/lib/athenian/models/code_bypassing_prs_measurement.rb +357 -0
  275. data/lib/athenian/models/code_check_histogram_definition.rb +303 -0
  276. data/lib/athenian/models/code_check_histograms_request.rb +365 -0
  277. data/lib/athenian/models/code_check_metric_id.rb +55 -0
  278. data/lib/athenian/models/code_check_metrics_request.rb +401 -0
  279. data/lib/athenian/models/code_check_run_statistics.rb +448 -0
  280. data/lib/athenian/models/code_check_run_statistics_mean_execution_time.rb +224 -0
  281. data/lib/athenian/models/code_check_run_statistics_median_execution_time.rb +224 -0
  282. data/lib/athenian/models/code_check_run_statistics_stddev_execution_time.rb +224 -0
  283. data/lib/athenian/models/code_filter.rb +351 -0
  284. data/lib/athenian/models/commit.rb +405 -0
  285. data/lib/athenian/models/commit_signature.rb +266 -0
  286. data/lib/athenian/models/commits_list.rb +236 -0
  287. data/lib/athenian/models/commits_list_include.rb +242 -0
  288. data/lib/athenian/models/contributor.rb +261 -0
  289. data/lib/athenian/models/contributor_identity.rb +230 -0
  290. data/lib/athenian/models/create_token_request.rb +235 -0
  291. data/lib/athenian/models/created_identifier.rb +220 -0
  292. data/lib/athenian/models/created_token.rb +236 -0
  293. data/lib/athenian/models/datasource.rb +37 -0
  294. data/lib/athenian/models/delete_events_cache_request.rb +277 -0
  295. data/lib/athenian/models/deployed_component.rb +255 -0
  296. data/lib/athenian/models/deployed_pull_request.rb +326 -0
  297. data/lib/athenian/models/deployed_pull_request_all_of.rb +220 -0
  298. data/lib/athenian/models/deployed_release.rb +488 -0
  299. data/lib/athenian/models/deployment_analysis.rb +244 -0
  300. data/lib/athenian/models/deployment_analysis_code.rb +303 -0
  301. data/lib/athenian/models/deployment_conclusion.rb +38 -0
  302. data/lib/athenian/models/deployment_metric_id.rb +52 -0
  303. data/lib/athenian/models/deployment_metrics_request.rb +391 -0
  304. data/lib/athenian/models/deployment_modify_labels_request.rb +227 -0
  305. data/lib/athenian/models/deployment_notification.rb +390 -0
  306. data/lib/athenian/models/deployment_with.rb +233 -0
  307. data/lib/athenian/models/developer_metric_id.rb +51 -0
  308. data/lib/athenian/models/developer_metrics_request.rb +355 -0
  309. data/lib/athenian/models/developer_summary.rb +271 -0
  310. data/lib/athenian/models/developer_updates.rb +356 -0
  311. data/lib/athenian/models/diff_releases_request.rb +237 -0
  312. data/lib/athenian/models/diffed_releases.rb +237 -0
  313. data/lib/athenian/models/diffed_releases_include.rb +242 -0
  314. data/lib/athenian/models/filter_code_checks_request.rb +356 -0
  315. data/lib/athenian/models/filter_commits_request.rb +385 -0
  316. data/lib/athenian/models/filter_contributors_request.rb +331 -0
  317. data/lib/athenian/models/filter_deployments_request.rb +383 -0
  318. data/lib/athenian/models/filter_environments_request.rb +294 -0
  319. data/lib/athenian/models/filter_jira_common.rb +318 -0
  320. data/lib/athenian/models/filter_jira_stuff.rb +373 -0
  321. data/lib/athenian/models/filter_jira_stuff_with.rb +248 -0
  322. data/lib/athenian/models/filter_labels_request.rb +233 -0
  323. data/lib/athenian/models/filter_pull_requests_request.rb +456 -0
  324. data/lib/athenian/models/filter_releases_request.rb +339 -0
  325. data/lib/athenian/models/filter_repositories_request.rb +307 -0
  326. data/lib/athenian/models/filtered_code_check_run.rb +306 -0
  327. data/lib/athenian/models/filtered_code_check_run_prs_stats.rb +454 -0
  328. data/lib/athenian/models/filtered_code_check_run_total_stats.rb +454 -0
  329. data/lib/athenian/models/filtered_code_check_runs.rb +240 -0
  330. data/lib/athenian/models/filtered_deployment.rb +436 -0
  331. data/lib/athenian/models/filtered_deployments.rb +237 -0
  332. data/lib/athenian/models/filtered_deployments_include.rb +243 -0
  333. data/lib/athenian/models/filtered_environment.rb +283 -0
  334. data/lib/athenian/models/filtered_jira_stuff.rb +334 -0
  335. data/lib/athenian/models/filtered_label.rb +298 -0
  336. data/lib/athenian/models/filtered_release.rb +483 -0
  337. data/lib/athenian/models/for_set_code_checks.rb +334 -0
  338. data/lib/athenian/models/for_set_code_checks_jira.rb +306 -0
  339. data/lib/athenian/models/for_set_deployments.rb +343 -0
  340. data/lib/athenian/models/for_set_developers.rb +288 -0
  341. data/lib/athenian/models/for_set_pull_requests.rb +371 -0
  342. data/lib/athenian/models/generic_error.rb +270 -0
  343. data/lib/athenian/models/get_deployment_labels200_response.rb +220 -0
  344. data/lib/athenian/models/get_jira_issues_include.rb +39 -0
  345. data/lib/athenian/models/get_jira_issues_request.rb +269 -0
  346. data/lib/athenian/models/get_jira_issues_response.rb +231 -0
  347. data/lib/athenian/models/get_jira_issues_response_include.rb +229 -0
  348. data/lib/athenian/models/get_pull_requests_request.rb +284 -0
  349. data/lib/athenian/models/get_releases_request.rb +238 -0
  350. data/lib/athenian/models/goal_metric_params.rb +215 -0
  351. data/lib/athenian/models/goal_metric_params_threshold.rb +101 -0
  352. data/lib/athenian/models/goal_template.rb +305 -0
  353. data/lib/athenian/models/goal_template_create_request.rb +290 -0
  354. data/lib/athenian/models/goal_template_metric.rb +102 -0
  355. data/lib/athenian/models/goal_template_update_request.rb +275 -0
  356. data/lib/athenian/models/histogram_scale.rb +37 -0
  357. data/lib/athenian/models/included_deployments.rb +218 -0
  358. data/lib/athenian/models/included_jira_issues.rb +218 -0
  359. data/lib/athenian/models/included_native_user.rb +220 -0
  360. data/lib/athenian/models/included_native_users.rb +223 -0
  361. data/lib/athenian/models/installation_progress.rb +283 -0
  362. data/lib/athenian/models/interquartile.rb +234 -0
  363. data/lib/athenian/models/invalid_request_error.rb +288 -0
  364. data/lib/athenian/models/invalid_request_error_all_of.rb +215 -0
  365. data/lib/athenian/models/invitation_check_result.rb +274 -0
  366. data/lib/athenian/models/invitation_link.rb +221 -0
  367. data/lib/athenian/models/invited_user.rb +235 -0
  368. data/lib/athenian/models/jira_comment.rb +250 -0
  369. data/lib/athenian/models/jira_epic.rb +487 -0
  370. data/lib/athenian/models/jira_epic_all_of.rb +247 -0
  371. data/lib/athenian/models/jira_epic_child.rb +475 -0
  372. data/lib/athenian/models/jira_epic_child_all_of.rb +235 -0
  373. data/lib/athenian/models/jira_epic_issue_common.rb +437 -0
  374. data/lib/athenian/models/jira_filter.rb +300 -0
  375. data/lib/athenian/models/jira_filter_return.rb +44 -0
  376. data/lib/athenian/models/jira_filter_with.rb +242 -0
  377. data/lib/athenian/models/jira_histogram_definition.rb +303 -0
  378. data/lib/athenian/models/jira_histograms_request.rb +436 -0
  379. data/lib/athenian/models/jira_installation.rb +238 -0
  380. data/lib/athenian/models/jira_issue.rb +471 -0
  381. data/lib/athenian/models/jira_issue_all_of.rb +232 -0
  382. data/lib/athenian/models/jira_issue_type.rb +330 -0
  383. data/lib/athenian/models/jira_label.rb +260 -0
  384. data/lib/athenian/models/jira_metric_id.rb +48 -0
  385. data/lib/athenian/models/jira_metrics_request.rb +495 -0
  386. data/lib/athenian/models/jira_priority.rb +306 -0
  387. data/lib/athenian/models/jira_project.rb +307 -0
  388. data/lib/athenian/models/jira_projects_request.rb +238 -0
  389. data/lib/athenian/models/jira_status.rb +272 -0
  390. data/lib/athenian/models/jira_status_category.rb +39 -0
  391. data/lib/athenian/models/jira_user.rb +294 -0
  392. data/lib/athenian/models/linked_jira_issue.rb +273 -0
  393. data/lib/athenian/models/listed_token.rb +251 -0
  394. data/lib/athenian/models/logical_deployment_rules.rb +228 -0
  395. data/lib/athenian/models/logical_pr_rules.rb +228 -0
  396. data/lib/athenian/models/logical_repository.rb +303 -0
  397. data/lib/athenian/models/logical_repository_get_request.rb +236 -0
  398. data/lib/athenian/models/logical_repository_request.rb +318 -0
  399. data/lib/athenian/models/mapped_jira_identity.rb +289 -0
  400. data/lib/athenian/models/mapped_jira_identity_change.rb +232 -0
  401. data/lib/athenian/models/match_identities_request.rb +237 -0
  402. data/lib/athenian/models/matched_identity.rb +277 -0
  403. data/lib/athenian/models/matched_identity_to.rb +224 -0
  404. data/lib/athenian/models/notified_deployments_inner.rb +235 -0
  405. data/lib/athenian/models/notify_deployments200_response.rb +222 -0
  406. data/lib/athenian/models/organization.rb +248 -0
  407. data/lib/athenian/models/paginate_pull_requests_request.rb +254 -0
  408. data/lib/athenian/models/patch_token_request.rb +216 -0
  409. data/lib/athenian/models/product_feature.rb +234 -0
  410. data/lib/athenian/models/product_feature_parameters.rb +102 -0
  411. data/lib/athenian/models/pull_request.rb +727 -0
  412. data/lib/athenian/models/pull_request_event.rb +45 -0
  413. data/lib/athenian/models/pull_request_histogram_definition.rb +303 -0
  414. data/lib/athenian/models/pull_request_histograms_request.rb +380 -0
  415. data/lib/athenian/models/pull_request_label.rb +265 -0
  416. data/lib/athenian/models/pull_request_metric_id.rb +105 -0
  417. data/lib/athenian/models/pull_request_metrics_request.rb +416 -0
  418. data/lib/athenian/models/pull_request_numbers.rb +237 -0
  419. data/lib/athenian/models/pull_request_pagination_plan.rb +218 -0
  420. data/lib/athenian/models/pull_request_participant.rb +259 -0
  421. data/lib/athenian/models/pull_request_set.rb +237 -0
  422. data/lib/athenian/models/pull_request_set_include.rb +242 -0
  423. data/lib/athenian/models/pull_request_stage.rb +43 -0
  424. data/lib/athenian/models/pull_request_with.rb +290 -0
  425. data/lib/athenian/models/release_diff.rb +251 -0
  426. data/lib/athenian/models/release_match_request.rb +304 -0
  427. data/lib/athenian/models/release_match_setting.rb +292 -0
  428. data/lib/athenian/models/release_match_strategy.rb +39 -0
  429. data/lib/athenian/models/release_metric_id.rb +60 -0
  430. data/lib/athenian/models/release_metrics_request.rb +448 -0
  431. data/lib/athenian/models/release_metrics_request_for_inner.rb +101 -0
  432. data/lib/athenian/models/release_names.rb +238 -0
  433. data/lib/athenian/models/release_notification.rb +322 -0
  434. data/lib/athenian/models/release_notification_status.rb +38 -0
  435. data/lib/athenian/models/release_pair.rb +236 -0
  436. data/lib/athenian/models/release_set.rb +227 -0
  437. data/lib/athenian/models/release_set_include.rb +255 -0
  438. data/lib/athenian/models/release_with.rb +233 -0
  439. data/lib/athenian/models/released_pull_request.rb +303 -0
  440. data/lib/athenian/models/released_pull_request_author.rb +224 -0
  441. data/lib/athenian/models/repository_set_create_request.rb +252 -0
  442. data/lib/athenian/models/repository_set_list_item.rb +271 -0
  443. data/lib/athenian/models/repository_set_with_name.rb +235 -0
  444. data/lib/athenian/models/set_mapped_jira_identities_request.rb +238 -0
  445. data/lib/athenian/models/share.rb +251 -0
  446. data/lib/athenian/models/stage_timings.rb +335 -0
  447. data/lib/athenian/models/table_fetching_progress.rb +289 -0
  448. data/lib/athenian/models/team.rb +264 -0
  449. data/lib/athenian/models/team_create_request.rb +264 -0
  450. data/lib/athenian/models/team_update_request.rb +249 -0
  451. data/lib/athenian/models/user.rb +313 -0
  452. data/lib/athenian/models/versions.rb +233 -0
  453. data/lib/athenian/models/with_both_jira_and_jiragroups.rb +226 -0
  454. data/lib/athenian/models/work_type.rb +292 -0
  455. data/lib/athenian/models/work_type_get_request.rb +255 -0
  456. data/lib/athenian/models/work_type_put_request.rb +235 -0
  457. data/lib/athenian/models/work_type_rule.rb +255 -0
  458. data/lib/athenian/version.rb +12 -0
  459. data/lib/athenian.rb +255 -0
  460. data/spec/api/align_api_spec.rb +89 -0
  461. data/spec/api/events_api_spec.rb +88 -0
  462. data/spec/api/filter_api_spec.rb +153 -0
  463. data/spec/api/get_api_spec.rb +76 -0
  464. data/spec/api/histograms_api_spec.rb +65 -0
  465. data/spec/api/integrations_api_spec.rb +55 -0
  466. data/spec/api/metrics_api_spec.rb +109 -0
  467. data/spec/api/pagination_api_spec.rb +43 -0
  468. data/spec/api/registration_api_spec.rb +98 -0
  469. data/spec/api/reposet_api_spec.rb +88 -0
  470. data/spec/api/security_api_spec.rb +77 -0
  471. data/spec/api/settings_api_spec.rb +175 -0
  472. data/spec/api/team_api_spec.rb +100 -0
  473. data/spec/api/user_api_spec.rb +97 -0
  474. data/spec/api/version_api_spec.rb +42 -0
  475. data/spec/api_client_spec.rb +225 -0
  476. data/spec/configuration_spec.rb +39 -0
  477. data/spec/models/accepted_invitation_spec.rb +43 -0
  478. data/spec/models/account_spec.rb +55 -0
  479. data/spec/models/account_status_spec.rb +55 -0
  480. data/spec/models/account_user_change_request_spec.rb +47 -0
  481. data/spec/models/calculated_code_check_histogram_spec.rb +61 -0
  482. data/spec/models/calculated_code_check_metrics_item_spec.rb +55 -0
  483. data/spec/models/calculated_code_check_metrics_spec.rb +73 -0
  484. data/spec/models/calculated_deployment_metric_spec.rb +49 -0
  485. data/spec/models/calculated_developer_metrics_item_spec.rb +43 -0
  486. data/spec/models/calculated_developer_metrics_spec.rb +61 -0
  487. data/spec/models/calculated_jira_histogram_spec.rb +61 -0
  488. data/spec/models/calculated_jira_metric_values_spec.rb +55 -0
  489. data/spec/models/calculated_linear_metric_values_confidence_mins_inner_spec.rb +28 -0
  490. data/spec/models/calculated_linear_metric_values_spec.rb +55 -0
  491. data/spec/models/calculated_linear_metric_values_values_inner_spec.rb +28 -0
  492. data/spec/models/calculated_pull_request_histogram_frequencies_inner_spec.rb +28 -0
  493. data/spec/models/calculated_pull_request_histogram_spec.rb +61 -0
  494. data/spec/models/calculated_pull_request_metrics_item_spec.rb +43 -0
  495. data/spec/models/calculated_pull_request_metrics_spec.rb +73 -0
  496. data/spec/models/calculated_release_metric_spec.rb +67 -0
  497. data/spec/models/code_bypassing_prs_measurement_spec.rb +55 -0
  498. data/spec/models/code_check_histogram_definition_spec.rb +49 -0
  499. data/spec/models/code_check_histograms_request_spec.rb +73 -0
  500. data/spec/models/code_check_metric_id_spec.rb +25 -0
  501. data/spec/models/code_check_metrics_request_spec.rb +79 -0
  502. data/spec/models/code_check_run_statistics_mean_execution_time_spec.rb +25 -0
  503. data/spec/models/code_check_run_statistics_median_execution_time_spec.rb +25 -0
  504. data/spec/models/code_check_run_statistics_spec.rb +97 -0
  505. data/spec/models/code_check_run_statistics_stddev_execution_time_spec.rb +25 -0
  506. data/spec/models/code_filter_spec.rb +79 -0
  507. data/spec/models/commit_signature_spec.rb +55 -0
  508. data/spec/models/commit_spec.rb +85 -0
  509. data/spec/models/commits_list_include_spec.rb +37 -0
  510. data/spec/models/commits_list_spec.rb +37 -0
  511. data/spec/models/contributor_identity_spec.rb +37 -0
  512. data/spec/models/contributor_spec.rb +55 -0
  513. data/spec/models/create_token_request_spec.rb +37 -0
  514. data/spec/models/created_identifier_spec.rb +31 -0
  515. data/spec/models/created_token_spec.rb +37 -0
  516. data/spec/models/datasource_spec.rb +25 -0
  517. data/spec/models/delete_events_cache_request_spec.rb +47 -0
  518. data/spec/models/deployed_component_spec.rb +37 -0
  519. data/spec/models/deployed_pull_request_all_of_spec.rb +31 -0
  520. data/spec/models/deployed_pull_request_spec.rb +73 -0
  521. data/spec/models/deployed_release_spec.rb +97 -0
  522. data/spec/models/deployment_analysis_code_spec.rb +61 -0
  523. data/spec/models/deployment_analysis_spec.rb +43 -0
  524. data/spec/models/deployment_conclusion_spec.rb +25 -0
  525. data/spec/models/deployment_metric_id_spec.rb +25 -0
  526. data/spec/models/deployment_metrics_request_spec.rb +73 -0
  527. data/spec/models/deployment_modify_labels_request_spec.rb +37 -0
  528. data/spec/models/deployment_notification_spec.rb +73 -0
  529. data/spec/models/deployment_with_spec.rb +43 -0
  530. data/spec/models/developer_metric_id_spec.rb +25 -0
  531. data/spec/models/developer_metrics_request_spec.rb +67 -0
  532. data/spec/models/developer_summary_spec.rb +55 -0
  533. data/spec/models/developer_updates_spec.rb +61 -0
  534. data/spec/models/diff_releases_request_spec.rb +37 -0
  535. data/spec/models/diffed_releases_include_spec.rb +37 -0
  536. data/spec/models/diffed_releases_spec.rb +37 -0
  537. data/spec/models/filter_code_checks_request_spec.rb +85 -0
  538. data/spec/models/filter_commits_request_spec.rb +83 -0
  539. data/spec/models/filter_contributors_request_spec.rb +65 -0
  540. data/spec/models/filter_deployments_request_spec.rb +103 -0
  541. data/spec/models/filter_environments_request_spec.rb +55 -0
  542. data/spec/models/filter_jira_common_spec.rb +67 -0
  543. data/spec/models/filter_jira_stuff_spec.rb +97 -0
  544. data/spec/models/filter_jira_stuff_with_spec.rb +43 -0
  545. data/spec/models/filter_labels_request_spec.rb +37 -0
  546. data/spec/models/filter_pull_requests_request_spec.rb +121 -0
  547. data/spec/models/filter_releases_request_spec.rb +79 -0
  548. data/spec/models/filter_repositories_request_spec.rb +61 -0
  549. data/spec/models/filtered_code_check_run_prs_stats_spec.rb +97 -0
  550. data/spec/models/filtered_code_check_run_spec.rb +67 -0
  551. data/spec/models/filtered_code_check_run_total_stats_spec.rb +97 -0
  552. data/spec/models/filtered_code_check_runs_spec.rb +37 -0
  553. data/spec/models/filtered_deployment_spec.rb +91 -0
  554. data/spec/models/filtered_deployments_include_spec.rb +37 -0
  555. data/spec/models/filtered_deployments_spec.rb +37 -0
  556. data/spec/models/filtered_environment_spec.rb +49 -0
  557. data/spec/models/filtered_jira_stuff_spec.rb +73 -0
  558. data/spec/models/filtered_label_spec.rb +49 -0
  559. data/spec/models/filtered_release_spec.rb +103 -0
  560. data/spec/models/for_set_code_checks_jira_spec.rb +73 -0
  561. data/spec/models/for_set_code_checks_spec.rb +73 -0
  562. data/spec/models/for_set_deployments_spec.rb +91 -0
  563. data/spec/models/for_set_developers_spec.rb +67 -0
  564. data/spec/models/for_set_pull_requests_spec.rb +85 -0
  565. data/spec/models/generic_error_spec.rb +55 -0
  566. data/spec/models/get_deployment_labels200_response_spec.rb +31 -0
  567. data/spec/models/get_jira_issues_include_spec.rb +25 -0
  568. data/spec/models/get_jira_issues_request_spec.rb +43 -0
  569. data/spec/models/get_jira_issues_response_include_spec.rb +37 -0
  570. data/spec/models/get_jira_issues_response_spec.rb +37 -0
  571. data/spec/models/get_pull_requests_request_spec.rb +43 -0
  572. data/spec/models/get_releases_request_spec.rb +37 -0
  573. data/spec/models/goal_metric_params_spec.rb +31 -0
  574. data/spec/models/goal_metric_params_threshold_spec.rb +28 -0
  575. data/spec/models/goal_template_create_request_spec.rb +55 -0
  576. data/spec/models/goal_template_metric_spec.rb +28 -0
  577. data/spec/models/goal_template_spec.rb +61 -0
  578. data/spec/models/goal_template_update_request_spec.rb +49 -0
  579. data/spec/models/histogram_scale_spec.rb +25 -0
  580. data/spec/models/included_deployments_spec.rb +31 -0
  581. data/spec/models/included_jira_issues_spec.rb +31 -0
  582. data/spec/models/included_native_user_spec.rb +31 -0
  583. data/spec/models/included_native_users_spec.rb +31 -0
  584. data/spec/models/installation_progress_spec.rb +55 -0
  585. data/spec/models/interquartile_spec.rb +37 -0
  586. data/spec/models/invalid_request_error_all_of_spec.rb +31 -0
  587. data/spec/models/invalid_request_error_spec.rb +61 -0
  588. data/spec/models/invitation_check_result_spec.rb +47 -0
  589. data/spec/models/invitation_link_spec.rb +31 -0
  590. data/spec/models/invited_user_spec.rb +37 -0
  591. data/spec/models/jira_comment_spec.rb +43 -0
  592. data/spec/models/jira_epic_all_of_spec.rb +43 -0
  593. data/spec/models/jira_epic_child_all_of_spec.rb +37 -0
  594. data/spec/models/jira_epic_child_spec.rb +145 -0
  595. data/spec/models/jira_epic_issue_common_spec.rb +133 -0
  596. data/spec/models/jira_epic_spec.rb +151 -0
  597. data/spec/models/jira_filter_return_spec.rb +25 -0
  598. data/spec/models/jira_filter_spec.rb +73 -0
  599. data/spec/models/jira_filter_with_spec.rb +43 -0
  600. data/spec/models/jira_histogram_definition_spec.rb +49 -0
  601. data/spec/models/jira_histograms_request_spec.rb +109 -0
  602. data/spec/models/jira_installation_spec.rb +37 -0
  603. data/spec/models/jira_issue_all_of_spec.rb +37 -0
  604. data/spec/models/jira_issue_spec.rb +145 -0
  605. data/spec/models/jira_issue_type_spec.rb +67 -0
  606. data/spec/models/jira_label_spec.rb +49 -0
  607. data/spec/models/jira_metric_id_spec.rb +25 -0
  608. data/spec/models/jira_metrics_request_spec.rb +127 -0
  609. data/spec/models/jira_priority_spec.rb +49 -0
  610. data/spec/models/jira_project_spec.rb +67 -0
  611. data/spec/models/jira_projects_request_spec.rb +37 -0
  612. data/spec/models/jira_status_category_spec.rb +25 -0
  613. data/spec/models/jira_status_spec.rb +43 -0
  614. data/spec/models/jira_user_spec.rb +53 -0
  615. data/spec/models/linked_jira_issue_spec.rb +55 -0
  616. data/spec/models/listed_token_spec.rb +43 -0
  617. data/spec/models/logical_deployment_rules_spec.rb +37 -0
  618. data/spec/models/logical_pr_rules_spec.rb +37 -0
  619. data/spec/models/logical_repository_get_request_spec.rb +37 -0
  620. data/spec/models/logical_repository_request_spec.rb +61 -0
  621. data/spec/models/logical_repository_spec.rb +55 -0
  622. data/spec/models/mapped_jira_identity_change_spec.rb +37 -0
  623. data/spec/models/mapped_jira_identity_spec.rb +49 -0
  624. data/spec/models/match_identities_request_spec.rb +37 -0
  625. data/spec/models/matched_identity_spec.rb +43 -0
  626. data/spec/models/matched_identity_to_spec.rb +25 -0
  627. data/spec/models/notified_deployments_inner_spec.rb +37 -0
  628. data/spec/models/notify_deployments200_response_spec.rb +31 -0
  629. data/spec/models/organization_spec.rb +43 -0
  630. data/spec/models/paginate_pull_requests_request_spec.rb +37 -0
  631. data/spec/models/patch_token_request_spec.rb +31 -0
  632. data/spec/models/product_feature_parameters_spec.rb +28 -0
  633. data/spec/models/product_feature_spec.rb +37 -0
  634. data/spec/models/pull_request_event_spec.rb +25 -0
  635. data/spec/models/pull_request_histogram_definition_spec.rb +49 -0
  636. data/spec/models/pull_request_histograms_request_spec.rb +79 -0
  637. data/spec/models/pull_request_label_spec.rb +43 -0
  638. data/spec/models/pull_request_metric_id_spec.rb +25 -0
  639. data/spec/models/pull_request_metrics_request_spec.rb +85 -0
  640. data/spec/models/pull_request_numbers_spec.rb +37 -0
  641. data/spec/models/pull_request_pagination_plan_spec.rb +31 -0
  642. data/spec/models/pull_request_participant_spec.rb +41 -0
  643. data/spec/models/pull_request_set_include_spec.rb +37 -0
  644. data/spec/models/pull_request_set_spec.rb +37 -0
  645. data/spec/models/pull_request_spec.rb +199 -0
  646. data/spec/models/pull_request_stage_spec.rb +25 -0
  647. data/spec/models/pull_request_with_spec.rb +67 -0
  648. data/spec/models/release_diff_spec.rb +43 -0
  649. data/spec/models/release_match_request_spec.rb +61 -0
  650. data/spec/models/release_match_setting_spec.rb +55 -0
  651. data/spec/models/release_match_strategy_spec.rb +25 -0
  652. data/spec/models/release_metric_id_spec.rb +25 -0
  653. data/spec/models/release_metrics_request_for_inner_spec.rb +28 -0
  654. data/spec/models/release_metrics_request_spec.rb +103 -0
  655. data/spec/models/release_names_spec.rb +37 -0
  656. data/spec/models/release_notification_spec.rb +61 -0
  657. data/spec/models/release_notification_status_spec.rb +25 -0
  658. data/spec/models/release_pair_spec.rb +37 -0
  659. data/spec/models/release_set_include_spec.rb +43 -0
  660. data/spec/models/release_set_spec.rb +37 -0
  661. data/spec/models/release_with_spec.rb +43 -0
  662. data/spec/models/released_pull_request_author_spec.rb +25 -0
  663. data/spec/models/released_pull_request_spec.rb +67 -0
  664. data/spec/models/repository_set_create_request_spec.rb +43 -0
  665. data/spec/models/repository_set_list_item_spec.rb +55 -0
  666. data/spec/models/repository_set_with_name_spec.rb +43 -0
  667. data/spec/models/set_mapped_jira_identities_request_spec.rb +37 -0
  668. data/spec/models/share_spec.rb +43 -0
  669. data/spec/models/stage_timings_spec.rb +55 -0
  670. data/spec/models/table_fetching_progress_spec.rb +43 -0
  671. data/spec/models/team_create_request_spec.rb +49 -0
  672. data/spec/models/team_spec.rb +49 -0
  673. data/spec/models/team_update_request_spec.rb +43 -0
  674. data/spec/models/user_spec.rb +79 -0
  675. data/spec/models/versions_spec.rb +37 -0
  676. data/spec/models/with_both_jira_and_jiragroups_spec.rb +37 -0
  677. data/spec/models/work_type_get_request_spec.rb +37 -0
  678. data/spec/models/work_type_put_request_spec.rb +37 -0
  679. data/spec/models/work_type_rule_spec.rb +37 -0
  680. data/spec/models/work_type_spec.rb +43 -0
  681. data/spec/spec_helper.rb +108 -0
  682. metadata +1000 -0
@@ -0,0 +1,942 @@
1
+ # Athenian::SettingsApi
2
+
3
+ All URIs are relative to *https://api.athenian.co/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**delete_logical_repository**](SettingsApi.md#delete_logical_repository) | **POST** /settings/logical_repository/delete | 🛡️ Delete a logical repository. |
8
+ | [**delete_work_type**](SettingsApi.md#delete_work_type) | **POST** /settings/work_type/delete | 👤 Remove the work type given the name. |
9
+ | [**get_jira_identities**](SettingsApi.md#get_jira_identities) | **GET** /settings/jira/identities/{id} | Fetch the GitHub<>JIRA user identity mapping. |
10
+ | [**get_jira_projects**](SettingsApi.md#get_jira_projects) | **GET** /settings/jira/projects/{id} | List the currently enabled JIRA project settings. |
11
+ | [**get_work_type**](SettingsApi.md#get_work_type) | **POST** /settings/work_type/get | Fetch the definition of the work type given the name. |
12
+ | [**list_logical_repositories**](SettingsApi.md#list_logical_repositories) | **GET** /settings/logical_repositories/{id} | List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. This feature is particularly useful to reap monorepos into separate, joint or disjoint parts. |
13
+ | [**list_release_match_settings**](SettingsApi.md#list_release_match_settings) | **GET** /settings/release_match/{id} | List the current release matching settings. Release settings are rules by which to mark releases in GitHub repositories. |
14
+ | [**list_work_types**](SettingsApi.md#list_work_types) | **GET** /settings/work_types/{id} | List the current work types - rule sets to group PRs, releases, etc. together. |
15
+ | [**set_jira_identities**](SettingsApi.md#set_jira_identities) | **PATCH** /settings/jira/identities | 👤 Add, remove or override GitHub<>JIRA user identity mapping. |
16
+ | [**set_jira_projects**](SettingsApi.md#set_jira_projects) | **PUT** /settings/jira/projects | 🛡️👤 Set the enabled JIRA projects. |
17
+ | [**set_logical_repository**](SettingsApi.md#set_logical_repository) | **PUT** /settings/logical_repository | 🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests. |
18
+ | [**set_release_match**](SettingsApi.md#set_release_match) | **PUT** /settings/release_match | 👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories. |
19
+ | [**set_work_type**](SettingsApi.md#set_work_type) | **PUT** /settings/work_type | 👤 Create or update a work type - a rule set to group PRs, releases, etc. together. |
20
+
21
+
22
+ ## delete_logical_repository
23
+
24
+ > Object delete_logical_repository(opts)
25
+
26
+ 🛡️ Delete a logical repository.
27
+
28
+ ### Examples
29
+
30
+ ```ruby
31
+ require 'time'
32
+ require 'athenian'
33
+ # setup authorization
34
+ Athenian.configure do |config|
35
+ # Configure API key authorization: apiKeyAuth
36
+ config.api_key['apiKeyAuth'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
39
+
40
+ # Configure Bearer authorization (JWT): bearerAuth
41
+ config.access_token = 'YOUR_BEARER_TOKEN'
42
+ end
43
+
44
+ api_instance = Athenian::SettingsApi.new
45
+ opts = {
46
+ body: Athenian::LogicalRepositoryGetRequest.new({account: 37, name: 'github.com/athenianco/athenian-webapp'}) # LogicalRepositoryGetRequest |
47
+ }
48
+
49
+ begin
50
+ # 🛡️ Delete a logical repository.
51
+ result = api_instance.delete_logical_repository(opts)
52
+ p result
53
+ rescue Athenian::ApiError => e
54
+ puts "Error when calling SettingsApi->delete_logical_repository: #{e}"
55
+ end
56
+ ```
57
+
58
+ #### Using the delete_logical_repository_with_http_info variant
59
+
60
+ This returns an Array which contains the response data, status code and headers.
61
+
62
+ > <Array(Object, Integer, Hash)> delete_logical_repository_with_http_info(opts)
63
+
64
+ ```ruby
65
+ begin
66
+ # 🛡️ Delete a logical repository.
67
+ data, status_code, headers = api_instance.delete_logical_repository_with_http_info(opts)
68
+ p status_code # => 2xx
69
+ p headers # => { ... }
70
+ p data # => Object
71
+ rescue Athenian::ApiError => e
72
+ puts "Error when calling SettingsApi->delete_logical_repository_with_http_info: #{e}"
73
+ end
74
+ ```
75
+
76
+ ### Parameters
77
+
78
+ | Name | Type | Description | Notes |
79
+ | ---- | ---- | ----------- | ----- |
80
+ | **body** | [**LogicalRepositoryGetRequest**](LogicalRepositoryGetRequest.md) | | [optional] |
81
+
82
+ ### Return type
83
+
84
+ **Object**
85
+
86
+ ### Authorization
87
+
88
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
89
+
90
+ ### HTTP request headers
91
+
92
+ - **Content-Type**: application/json
93
+ - **Accept**: application/json
94
+
95
+
96
+ ## delete_work_type
97
+
98
+ > Object delete_work_type(opts)
99
+
100
+ 👤 Remove the work type given the name.
101
+
102
+ ### Examples
103
+
104
+ ```ruby
105
+ require 'time'
106
+ require 'athenian'
107
+ # setup authorization
108
+ Athenian.configure do |config|
109
+ # Configure Bearer authorization (JWT): bearerAuth
110
+ config.access_token = 'YOUR_BEARER_TOKEN'
111
+ end
112
+
113
+ api_instance = Athenian::SettingsApi.new
114
+ opts = {
115
+ body: Athenian::WorkTypeGetRequest.new({account: 37, name: 'name_example'}) # WorkTypeGetRequest |
116
+ }
117
+
118
+ begin
119
+ # 👤 Remove the work type given the name.
120
+ result = api_instance.delete_work_type(opts)
121
+ p result
122
+ rescue Athenian::ApiError => e
123
+ puts "Error when calling SettingsApi->delete_work_type: #{e}"
124
+ end
125
+ ```
126
+
127
+ #### Using the delete_work_type_with_http_info variant
128
+
129
+ This returns an Array which contains the response data, status code and headers.
130
+
131
+ > <Array(Object, Integer, Hash)> delete_work_type_with_http_info(opts)
132
+
133
+ ```ruby
134
+ begin
135
+ # 👤 Remove the work type given the name.
136
+ data, status_code, headers = api_instance.delete_work_type_with_http_info(opts)
137
+ p status_code # => 2xx
138
+ p headers # => { ... }
139
+ p data # => Object
140
+ rescue Athenian::ApiError => e
141
+ puts "Error when calling SettingsApi->delete_work_type_with_http_info: #{e}"
142
+ end
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+ | Name | Type | Description | Notes |
148
+ | ---- | ---- | ----------- | ----- |
149
+ | **body** | [**WorkTypeGetRequest**](WorkTypeGetRequest.md) | | [optional] |
150
+
151
+ ### Return type
152
+
153
+ **Object**
154
+
155
+ ### Authorization
156
+
157
+ [bearerAuth](../README.md#bearerAuth)
158
+
159
+ ### HTTP request headers
160
+
161
+ - **Content-Type**: application/json
162
+ - **Accept**: application/json
163
+
164
+
165
+ ## get_jira_identities
166
+
167
+ > <Array<MappedJIRAIdentity>> get_jira_identities(id)
168
+
169
+ Fetch the GitHub<>JIRA user identity mapping.
170
+
171
+ ### Examples
172
+
173
+ ```ruby
174
+ require 'time'
175
+ require 'athenian'
176
+ # setup authorization
177
+ Athenian.configure do |config|
178
+ # Configure API key authorization: apiKeyAuth
179
+ config.api_key['apiKeyAuth'] = 'YOUR API KEY'
180
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
181
+ # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
182
+
183
+ # Configure Bearer authorization (JWT): bearerAuth
184
+ config.access_token = 'YOUR_BEARER_TOKEN'
185
+ end
186
+
187
+ api_instance = Athenian::SettingsApi.new
188
+ id = 56 # Integer | Numeric identifier of the account.
189
+
190
+ begin
191
+ # Fetch the GitHub<>JIRA user identity mapping.
192
+ result = api_instance.get_jira_identities(id)
193
+ p result
194
+ rescue Athenian::ApiError => e
195
+ puts "Error when calling SettingsApi->get_jira_identities: #{e}"
196
+ end
197
+ ```
198
+
199
+ #### Using the get_jira_identities_with_http_info variant
200
+
201
+ This returns an Array which contains the response data, status code and headers.
202
+
203
+ > <Array(<Array<MappedJIRAIdentity>>, Integer, Hash)> get_jira_identities_with_http_info(id)
204
+
205
+ ```ruby
206
+ begin
207
+ # Fetch the GitHub<>JIRA user identity mapping.
208
+ data, status_code, headers = api_instance.get_jira_identities_with_http_info(id)
209
+ p status_code # => 2xx
210
+ p headers # => { ... }
211
+ p data # => <Array<MappedJIRAIdentity>>
212
+ rescue Athenian::ApiError => e
213
+ puts "Error when calling SettingsApi->get_jira_identities_with_http_info: #{e}"
214
+ end
215
+ ```
216
+
217
+ ### Parameters
218
+
219
+ | Name | Type | Description | Notes |
220
+ | ---- | ---- | ----------- | ----- |
221
+ | **id** | **Integer** | Numeric identifier of the account. | |
222
+
223
+ ### Return type
224
+
225
+ [**Array&lt;MappedJIRAIdentity&gt;**](MappedJIRAIdentity.md)
226
+
227
+ ### Authorization
228
+
229
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
230
+
231
+ ### HTTP request headers
232
+
233
+ - **Content-Type**: Not defined
234
+ - **Accept**: application/json
235
+
236
+
237
+ ## get_jira_projects
238
+
239
+ > <Array<JIRAProject>> get_jira_projects(id)
240
+
241
+ List the currently enabled JIRA project settings.
242
+
243
+ ### Examples
244
+
245
+ ```ruby
246
+ require 'time'
247
+ require 'athenian'
248
+ # setup authorization
249
+ Athenian.configure do |config|
250
+ # Configure API key authorization: apiKeyAuth
251
+ config.api_key['apiKeyAuth'] = 'YOUR API KEY'
252
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
253
+ # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
254
+
255
+ # Configure Bearer authorization (JWT): bearerAuth
256
+ config.access_token = 'YOUR_BEARER_TOKEN'
257
+ end
258
+
259
+ api_instance = Athenian::SettingsApi.new
260
+ id = 56 # Integer | Numeric identifier of the account.
261
+
262
+ begin
263
+ # List the currently enabled JIRA project settings.
264
+ result = api_instance.get_jira_projects(id)
265
+ p result
266
+ rescue Athenian::ApiError => e
267
+ puts "Error when calling SettingsApi->get_jira_projects: #{e}"
268
+ end
269
+ ```
270
+
271
+ #### Using the get_jira_projects_with_http_info variant
272
+
273
+ This returns an Array which contains the response data, status code and headers.
274
+
275
+ > <Array(<Array<JIRAProject>>, Integer, Hash)> get_jira_projects_with_http_info(id)
276
+
277
+ ```ruby
278
+ begin
279
+ # List the currently enabled JIRA project settings.
280
+ data, status_code, headers = api_instance.get_jira_projects_with_http_info(id)
281
+ p status_code # => 2xx
282
+ p headers # => { ... }
283
+ p data # => <Array<JIRAProject>>
284
+ rescue Athenian::ApiError => e
285
+ puts "Error when calling SettingsApi->get_jira_projects_with_http_info: #{e}"
286
+ end
287
+ ```
288
+
289
+ ### Parameters
290
+
291
+ | Name | Type | Description | Notes |
292
+ | ---- | ---- | ----------- | ----- |
293
+ | **id** | **Integer** | Numeric identifier of the account. | |
294
+
295
+ ### Return type
296
+
297
+ [**Array&lt;JIRAProject&gt;**](JIRAProject.md)
298
+
299
+ ### Authorization
300
+
301
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
302
+
303
+ ### HTTP request headers
304
+
305
+ - **Content-Type**: Not defined
306
+ - **Accept**: application/json
307
+
308
+
309
+ ## get_work_type
310
+
311
+ > <WorkType> get_work_type(opts)
312
+
313
+ Fetch the definition of the work type given the name.
314
+
315
+ ### Examples
316
+
317
+ ```ruby
318
+ require 'time'
319
+ require 'athenian'
320
+ # setup authorization
321
+ Athenian.configure do |config|
322
+ # Configure API key authorization: apiKeyAuth
323
+ config.api_key['apiKeyAuth'] = 'YOUR API KEY'
324
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
325
+ # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
326
+
327
+ # Configure Bearer authorization (JWT): bearerAuth
328
+ config.access_token = 'YOUR_BEARER_TOKEN'
329
+ end
330
+
331
+ api_instance = Athenian::SettingsApi.new
332
+ opts = {
333
+ body: Athenian::WorkTypeGetRequest.new({account: 37, name: 'name_example'}) # WorkTypeGetRequest |
334
+ }
335
+
336
+ begin
337
+ # Fetch the definition of the work type given the name.
338
+ result = api_instance.get_work_type(opts)
339
+ p result
340
+ rescue Athenian::ApiError => e
341
+ puts "Error when calling SettingsApi->get_work_type: #{e}"
342
+ end
343
+ ```
344
+
345
+ #### Using the get_work_type_with_http_info variant
346
+
347
+ This returns an Array which contains the response data, status code and headers.
348
+
349
+ > <Array(<WorkType>, Integer, Hash)> get_work_type_with_http_info(opts)
350
+
351
+ ```ruby
352
+ begin
353
+ # Fetch the definition of the work type given the name.
354
+ data, status_code, headers = api_instance.get_work_type_with_http_info(opts)
355
+ p status_code # => 2xx
356
+ p headers # => { ... }
357
+ p data # => <WorkType>
358
+ rescue Athenian::ApiError => e
359
+ puts "Error when calling SettingsApi->get_work_type_with_http_info: #{e}"
360
+ end
361
+ ```
362
+
363
+ ### Parameters
364
+
365
+ | Name | Type | Description | Notes |
366
+ | ---- | ---- | ----------- | ----- |
367
+ | **body** | [**WorkTypeGetRequest**](WorkTypeGetRequest.md) | | [optional] |
368
+
369
+ ### Return type
370
+
371
+ [**WorkType**](WorkType.md)
372
+
373
+ ### Authorization
374
+
375
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
376
+
377
+ ### HTTP request headers
378
+
379
+ - **Content-Type**: application/json
380
+ - **Accept**: application/json
381
+
382
+
383
+ ## list_logical_repositories
384
+
385
+ > <Array<LogicalRepository>> list_logical_repositories(id)
386
+
387
+ List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. This feature is particularly useful to reap monorepos into separate, joint or disjoint parts.
388
+
389
+ ### Examples
390
+
391
+ ```ruby
392
+ require 'time'
393
+ require 'athenian'
394
+ # setup authorization
395
+ Athenian.configure do |config|
396
+ # Configure API key authorization: apiKeyAuth
397
+ config.api_key['apiKeyAuth'] = 'YOUR API KEY'
398
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
399
+ # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
400
+
401
+ # Configure Bearer authorization (JWT): bearerAuth
402
+ config.access_token = 'YOUR_BEARER_TOKEN'
403
+ end
404
+
405
+ api_instance = Athenian::SettingsApi.new
406
+ id = 56 # Integer | Numeric identifier of the account.
407
+
408
+ begin
409
+ # List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. This feature is particularly useful to reap monorepos into separate, joint or disjoint parts.
410
+ result = api_instance.list_logical_repositories(id)
411
+ p result
412
+ rescue Athenian::ApiError => e
413
+ puts "Error when calling SettingsApi->list_logical_repositories: #{e}"
414
+ end
415
+ ```
416
+
417
+ #### Using the list_logical_repositories_with_http_info variant
418
+
419
+ This returns an Array which contains the response data, status code and headers.
420
+
421
+ > <Array(<Array<LogicalRepository>>, Integer, Hash)> list_logical_repositories_with_http_info(id)
422
+
423
+ ```ruby
424
+ begin
425
+ # List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. This feature is particularly useful to reap monorepos into separate, joint or disjoint parts.
426
+ data, status_code, headers = api_instance.list_logical_repositories_with_http_info(id)
427
+ p status_code # => 2xx
428
+ p headers # => { ... }
429
+ p data # => <Array<LogicalRepository>>
430
+ rescue Athenian::ApiError => e
431
+ puts "Error when calling SettingsApi->list_logical_repositories_with_http_info: #{e}"
432
+ end
433
+ ```
434
+
435
+ ### Parameters
436
+
437
+ | Name | Type | Description | Notes |
438
+ | ---- | ---- | ----------- | ----- |
439
+ | **id** | **Integer** | Numeric identifier of the account. | |
440
+
441
+ ### Return type
442
+
443
+ [**Array&lt;LogicalRepository&gt;**](LogicalRepository.md)
444
+
445
+ ### Authorization
446
+
447
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
448
+
449
+ ### HTTP request headers
450
+
451
+ - **Content-Type**: Not defined
452
+ - **Accept**: application/json
453
+
454
+
455
+ ## list_release_match_settings
456
+
457
+ > <Hash<String, ReleaseMatchSetting>> list_release_match_settings(id)
458
+
459
+ List the current release matching settings. Release settings are rules by which to mark releases in GitHub repositories.
460
+
461
+ ### Examples
462
+
463
+ ```ruby
464
+ require 'time'
465
+ require 'athenian'
466
+ # setup authorization
467
+ Athenian.configure do |config|
468
+ # Configure API key authorization: apiKeyAuth
469
+ config.api_key['apiKeyAuth'] = 'YOUR API KEY'
470
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
471
+ # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
472
+
473
+ # Configure Bearer authorization (JWT): bearerAuth
474
+ config.access_token = 'YOUR_BEARER_TOKEN'
475
+ end
476
+
477
+ api_instance = Athenian::SettingsApi.new
478
+ id = 56 # Integer | Numeric identifier of the account.
479
+
480
+ begin
481
+ # List the current release matching settings. Release settings are rules by which to mark releases in GitHub repositories.
482
+ result = api_instance.list_release_match_settings(id)
483
+ p result
484
+ rescue Athenian::ApiError => e
485
+ puts "Error when calling SettingsApi->list_release_match_settings: #{e}"
486
+ end
487
+ ```
488
+
489
+ #### Using the list_release_match_settings_with_http_info variant
490
+
491
+ This returns an Array which contains the response data, status code and headers.
492
+
493
+ > <Array(<Hash<String, ReleaseMatchSetting>>, Integer, Hash)> list_release_match_settings_with_http_info(id)
494
+
495
+ ```ruby
496
+ begin
497
+ # List the current release matching settings. Release settings are rules by which to mark releases in GitHub repositories.
498
+ data, status_code, headers = api_instance.list_release_match_settings_with_http_info(id)
499
+ p status_code # => 2xx
500
+ p headers # => { ... }
501
+ p data # => <Hash<String, ReleaseMatchSetting>>
502
+ rescue Athenian::ApiError => e
503
+ puts "Error when calling SettingsApi->list_release_match_settings_with_http_info: #{e}"
504
+ end
505
+ ```
506
+
507
+ ### Parameters
508
+
509
+ | Name | Type | Description | Notes |
510
+ | ---- | ---- | ----------- | ----- |
511
+ | **id** | **Integer** | Numeric identifier of the account. | |
512
+
513
+ ### Return type
514
+
515
+ [**Hash&lt;String, ReleaseMatchSetting&gt;**](ReleaseMatchSetting.md)
516
+
517
+ ### Authorization
518
+
519
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
520
+
521
+ ### HTTP request headers
522
+
523
+ - **Content-Type**: Not defined
524
+ - **Accept**: application/json
525
+
526
+
527
+ ## list_work_types
528
+
529
+ > <Array<WorkType>> list_work_types(id)
530
+
531
+ List the current work types - rule sets to group PRs, releases, etc. together.
532
+
533
+ ### Examples
534
+
535
+ ```ruby
536
+ require 'time'
537
+ require 'athenian'
538
+ # setup authorization
539
+ Athenian.configure do |config|
540
+ # Configure API key authorization: apiKeyAuth
541
+ config.api_key['apiKeyAuth'] = 'YOUR API KEY'
542
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
543
+ # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
544
+
545
+ # Configure Bearer authorization (JWT): bearerAuth
546
+ config.access_token = 'YOUR_BEARER_TOKEN'
547
+ end
548
+
549
+ api_instance = Athenian::SettingsApi.new
550
+ id = 56 # Integer | Numeric identifier of the account.
551
+
552
+ begin
553
+ # List the current work types - rule sets to group PRs, releases, etc. together.
554
+ result = api_instance.list_work_types(id)
555
+ p result
556
+ rescue Athenian::ApiError => e
557
+ puts "Error when calling SettingsApi->list_work_types: #{e}"
558
+ end
559
+ ```
560
+
561
+ #### Using the list_work_types_with_http_info variant
562
+
563
+ This returns an Array which contains the response data, status code and headers.
564
+
565
+ > <Array(<Array<WorkType>>, Integer, Hash)> list_work_types_with_http_info(id)
566
+
567
+ ```ruby
568
+ begin
569
+ # List the current work types - rule sets to group PRs, releases, etc. together.
570
+ data, status_code, headers = api_instance.list_work_types_with_http_info(id)
571
+ p status_code # => 2xx
572
+ p headers # => { ... }
573
+ p data # => <Array<WorkType>>
574
+ rescue Athenian::ApiError => e
575
+ puts "Error when calling SettingsApi->list_work_types_with_http_info: #{e}"
576
+ end
577
+ ```
578
+
579
+ ### Parameters
580
+
581
+ | Name | Type | Description | Notes |
582
+ | ---- | ---- | ----------- | ----- |
583
+ | **id** | **Integer** | Numeric identifier of the account. | |
584
+
585
+ ### Return type
586
+
587
+ [**Array&lt;WorkType&gt;**](WorkType.md)
588
+
589
+ ### Authorization
590
+
591
+ [apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
592
+
593
+ ### HTTP request headers
594
+
595
+ - **Content-Type**: Not defined
596
+ - **Accept**: application/json
597
+
598
+
599
+ ## set_jira_identities
600
+
601
+ > <Array<MappedJIRAIdentity>> set_jira_identities(opts)
602
+
603
+ 👤 Add, remove or override GitHub<>JIRA user identity mapping.
604
+
605
+ ### Examples
606
+
607
+ ```ruby
608
+ require 'time'
609
+ require 'athenian'
610
+ # setup authorization
611
+ Athenian.configure do |config|
612
+ # Configure Bearer authorization (JWT): bearerAuth
613
+ config.access_token = 'YOUR_BEARER_TOKEN'
614
+ end
615
+
616
+ api_instance = Athenian::SettingsApi.new
617
+ opts = {
618
+ body: Athenian::SetMappedJIRAIdentitiesRequest.new({account: 37, changes: [Athenian::MappedJIRAIdentityChange.new({developer_id: 'github.com/vmarkovtsev', jira_name: 'jira_name_example'})]}) # SetMappedJIRAIdentitiesRequest |
619
+ }
620
+
621
+ begin
622
+ # 👤 Add, remove or override GitHub<>JIRA user identity mapping.
623
+ result = api_instance.set_jira_identities(opts)
624
+ p result
625
+ rescue Athenian::ApiError => e
626
+ puts "Error when calling SettingsApi->set_jira_identities: #{e}"
627
+ end
628
+ ```
629
+
630
+ #### Using the set_jira_identities_with_http_info variant
631
+
632
+ This returns an Array which contains the response data, status code and headers.
633
+
634
+ > <Array(<Array<MappedJIRAIdentity>>, Integer, Hash)> set_jira_identities_with_http_info(opts)
635
+
636
+ ```ruby
637
+ begin
638
+ # 👤 Add, remove or override GitHub<>JIRA user identity mapping.
639
+ data, status_code, headers = api_instance.set_jira_identities_with_http_info(opts)
640
+ p status_code # => 2xx
641
+ p headers # => { ... }
642
+ p data # => <Array<MappedJIRAIdentity>>
643
+ rescue Athenian::ApiError => e
644
+ puts "Error when calling SettingsApi->set_jira_identities_with_http_info: #{e}"
645
+ end
646
+ ```
647
+
648
+ ### Parameters
649
+
650
+ | Name | Type | Description | Notes |
651
+ | ---- | ---- | ----------- | ----- |
652
+ | **body** | [**SetMappedJIRAIdentitiesRequest**](SetMappedJIRAIdentitiesRequest.md) | | [optional] |
653
+
654
+ ### Return type
655
+
656
+ [**Array&lt;MappedJIRAIdentity&gt;**](MappedJIRAIdentity.md)
657
+
658
+ ### Authorization
659
+
660
+ [bearerAuth](../README.md#bearerAuth)
661
+
662
+ ### HTTP request headers
663
+
664
+ - **Content-Type**: application/json
665
+ - **Accept**: application/json
666
+
667
+
668
+ ## set_jira_projects
669
+
670
+ > <Array<JIRAProject>> set_jira_projects(opts)
671
+
672
+ 🛡️👤 Set the enabled JIRA projects.
673
+
674
+ ### Examples
675
+
676
+ ```ruby
677
+ require 'time'
678
+ require 'athenian'
679
+ # setup authorization
680
+ Athenian.configure do |config|
681
+ # Configure Bearer authorization (JWT): bearerAuth
682
+ config.access_token = 'YOUR_BEARER_TOKEN'
683
+ end
684
+
685
+ api_instance = Athenian::SettingsApi.new
686
+ opts = {
687
+ body: Athenian::JIRAProjectsRequest.new({account: 37, projects: { key: false}}) # JIRAProjectsRequest |
688
+ }
689
+
690
+ begin
691
+ # 🛡️👤 Set the enabled JIRA projects.
692
+ result = api_instance.set_jira_projects(opts)
693
+ p result
694
+ rescue Athenian::ApiError => e
695
+ puts "Error when calling SettingsApi->set_jira_projects: #{e}"
696
+ end
697
+ ```
698
+
699
+ #### Using the set_jira_projects_with_http_info variant
700
+
701
+ This returns an Array which contains the response data, status code and headers.
702
+
703
+ > <Array(<Array<JIRAProject>>, Integer, Hash)> set_jira_projects_with_http_info(opts)
704
+
705
+ ```ruby
706
+ begin
707
+ # 🛡️👤 Set the enabled JIRA projects.
708
+ data, status_code, headers = api_instance.set_jira_projects_with_http_info(opts)
709
+ p status_code # => 2xx
710
+ p headers # => { ... }
711
+ p data # => <Array<JIRAProject>>
712
+ rescue Athenian::ApiError => e
713
+ puts "Error when calling SettingsApi->set_jira_projects_with_http_info: #{e}"
714
+ end
715
+ ```
716
+
717
+ ### Parameters
718
+
719
+ | Name | Type | Description | Notes |
720
+ | ---- | ---- | ----------- | ----- |
721
+ | **body** | [**JIRAProjectsRequest**](JIRAProjectsRequest.md) | | [optional] |
722
+
723
+ ### Return type
724
+
725
+ [**Array&lt;JIRAProject&gt;**](JIRAProject.md)
726
+
727
+ ### Authorization
728
+
729
+ [bearerAuth](../README.md#bearerAuth)
730
+
731
+ ### HTTP request headers
732
+
733
+ - **Content-Type**: application/json
734
+ - **Accept**: application/json
735
+
736
+
737
+ ## set_logical_repository
738
+
739
+ > <LogicalRepository> set_logical_repository(opts)
740
+
741
+ 🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests.
742
+
743
+ ### Examples
744
+
745
+ ```ruby
746
+ require 'time'
747
+ require 'athenian'
748
+ # setup authorization
749
+ Athenian.configure do |config|
750
+ # Configure Bearer authorization (JWT): bearerAuth
751
+ config.access_token = 'YOUR_BEARER_TOKEN'
752
+ end
753
+
754
+ api_instance = Athenian::SettingsApi.new
755
+ opts = {
756
+ body: Athenian::LogicalRepositoryRequest.new({account: 37, name: 'name_example', parent: 'github.com/athenianco/athenian-webapp', prs: Athenian::LogicalPRRules.new, releases: Athenian::ReleaseMatchSetting.new({branches: '.*-production', tags: '.*', match: Athenian::ReleaseMatchStrategy::BRANCH})}) # LogicalRepositoryRequest |
757
+ }
758
+
759
+ begin
760
+ # 🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests.
761
+ result = api_instance.set_logical_repository(opts)
762
+ p result
763
+ rescue Athenian::ApiError => e
764
+ puts "Error when calling SettingsApi->set_logical_repository: #{e}"
765
+ end
766
+ ```
767
+
768
+ #### Using the set_logical_repository_with_http_info variant
769
+
770
+ This returns an Array which contains the response data, status code and headers.
771
+
772
+ > <Array(<LogicalRepository>, Integer, Hash)> set_logical_repository_with_http_info(opts)
773
+
774
+ ```ruby
775
+ begin
776
+ # 🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests.
777
+ data, status_code, headers = api_instance.set_logical_repository_with_http_info(opts)
778
+ p status_code # => 2xx
779
+ p headers # => { ... }
780
+ p data # => <LogicalRepository>
781
+ rescue Athenian::ApiError => e
782
+ puts "Error when calling SettingsApi->set_logical_repository_with_http_info: #{e}"
783
+ end
784
+ ```
785
+
786
+ ### Parameters
787
+
788
+ | Name | Type | Description | Notes |
789
+ | ---- | ---- | ----------- | ----- |
790
+ | **body** | [**LogicalRepositoryRequest**](LogicalRepositoryRequest.md) | | [optional] |
791
+
792
+ ### Return type
793
+
794
+ [**LogicalRepository**](LogicalRepository.md)
795
+
796
+ ### Authorization
797
+
798
+ [bearerAuth](../README.md#bearerAuth)
799
+
800
+ ### HTTP request headers
801
+
802
+ - **Content-Type**: application/json
803
+ - **Accept**: application/json
804
+
805
+
806
+ ## set_release_match
807
+
808
+ > Array&lt;String&gt; set_release_match(opts)
809
+
810
+ 👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories.
811
+
812
+ ### Examples
813
+
814
+ ```ruby
815
+ require 'time'
816
+ require 'athenian'
817
+ # setup authorization
818
+ Athenian.configure do |config|
819
+ # Configure Bearer authorization (JWT): bearerAuth
820
+ config.access_token = 'YOUR_BEARER_TOKEN'
821
+ end
822
+
823
+ api_instance = Athenian::SettingsApi.new
824
+ opts = {
825
+ body: Athenian::ReleaseMatchRequest.new({account: 37, repositories: ["github.com/athenianco/athenian-webapp", "github.com/athenianco/athenian-api"], match: Athenian::ReleaseMatchStrategy::BRANCH}) # ReleaseMatchRequest |
826
+ }
827
+
828
+ begin
829
+ # 👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories.
830
+ result = api_instance.set_release_match(opts)
831
+ p result
832
+ rescue Athenian::ApiError => e
833
+ puts "Error when calling SettingsApi->set_release_match: #{e}"
834
+ end
835
+ ```
836
+
837
+ #### Using the set_release_match_with_http_info variant
838
+
839
+ This returns an Array which contains the response data, status code and headers.
840
+
841
+ > <Array(Array&lt;String&gt;, Integer, Hash)> set_release_match_with_http_info(opts)
842
+
843
+ ```ruby
844
+ begin
845
+ # 👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories.
846
+ data, status_code, headers = api_instance.set_release_match_with_http_info(opts)
847
+ p status_code # => 2xx
848
+ p headers # => { ... }
849
+ p data # => Array&lt;String&gt;
850
+ rescue Athenian::ApiError => e
851
+ puts "Error when calling SettingsApi->set_release_match_with_http_info: #{e}"
852
+ end
853
+ ```
854
+
855
+ ### Parameters
856
+
857
+ | Name | Type | Description | Notes |
858
+ | ---- | ---- | ----------- | ----- |
859
+ | **body** | [**ReleaseMatchRequest**](ReleaseMatchRequest.md) | | [optional] |
860
+
861
+ ### Return type
862
+
863
+ **Array&lt;String&gt;**
864
+
865
+ ### Authorization
866
+
867
+ [bearerAuth](../README.md#bearerAuth)
868
+
869
+ ### HTTP request headers
870
+
871
+ - **Content-Type**: application/json
872
+ - **Accept**: application/json
873
+
874
+
875
+ ## set_work_type
876
+
877
+ > <WorkType> set_work_type(opts)
878
+
879
+ 👤 Create or update a work type - a rule set to group PRs, releases, etc. together.
880
+
881
+ ### Examples
882
+
883
+ ```ruby
884
+ require 'time'
885
+ require 'athenian'
886
+ # setup authorization
887
+ Athenian.configure do |config|
888
+ # Configure Bearer authorization (JWT): bearerAuth
889
+ config.access_token = 'YOUR_BEARER_TOKEN'
890
+ end
891
+
892
+ api_instance = Athenian::SettingsApi.new
893
+ opts = {
894
+ body: Athenian::WorkTypePutRequest.new({account: 37, work_type: Athenian::WorkType.new({name: 'name_example', color: 'color_example', rules: [Athenian::WorkTypeRule.new({name: 'name_example', body: 3.56})]})}) # WorkTypePutRequest |
895
+ }
896
+
897
+ begin
898
+ # 👤 Create or update a work type - a rule set to group PRs, releases, etc. together.
899
+ result = api_instance.set_work_type(opts)
900
+ p result
901
+ rescue Athenian::ApiError => e
902
+ puts "Error when calling SettingsApi->set_work_type: #{e}"
903
+ end
904
+ ```
905
+
906
+ #### Using the set_work_type_with_http_info variant
907
+
908
+ This returns an Array which contains the response data, status code and headers.
909
+
910
+ > <Array(<WorkType>, Integer, Hash)> set_work_type_with_http_info(opts)
911
+
912
+ ```ruby
913
+ begin
914
+ # 👤 Create or update a work type - a rule set to group PRs, releases, etc. together.
915
+ data, status_code, headers = api_instance.set_work_type_with_http_info(opts)
916
+ p status_code # => 2xx
917
+ p headers # => { ... }
918
+ p data # => <WorkType>
919
+ rescue Athenian::ApiError => e
920
+ puts "Error when calling SettingsApi->set_work_type_with_http_info: #{e}"
921
+ end
922
+ ```
923
+
924
+ ### Parameters
925
+
926
+ | Name | Type | Description | Notes |
927
+ | ---- | ---- | ----------- | ----- |
928
+ | **body** | [**WorkTypePutRequest**](WorkTypePutRequest.md) | | [optional] |
929
+
930
+ ### Return type
931
+
932
+ [**WorkType**](WorkType.md)
933
+
934
+ ### Authorization
935
+
936
+ [bearerAuth](../README.md#bearerAuth)
937
+
938
+ ### HTTP request headers
939
+
940
+ - **Content-Type**: application/json
941
+ - **Accept**: application/json
942
+