athenian 2.1.81

data/docs/GetJIRAIssuesResponseInclude.md

@@ -0,0 +1,20 @@
+# Athenian::GetJIRAIssuesResponseInclude
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **github_users** | [**Hash<String, IncludedNativeUser>**](IncludedNativeUser.md) | Mapping with details of the GitHub users mentioned in the linked pull requests.  | [optional] |
+| **jira_users** | [**Array<JIRAUser>**](JIRAUser.md) | Mentioned users in the returned isssues. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::GetJIRAIssuesResponseInclude.new(
+  github_users: null,
+  jira_users: null
+)
+```
+

data/docs/GetPullRequestsRequest.md

@@ -0,0 +1,22 @@
+# Athenian::GetPullRequestsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account ID. |  |
+| **prs** | [**Array<PullRequestNumbers>**](PullRequestNumbers.md) | List of repositories and PR numbers to list. |  |
+| **environments** | **Array<String>** | Deployment environments to apply. If omitted, any deployment counts. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::GetPullRequestsRequest.new(
+  account: null,
+  prs: null,
+  environments: null
+)
+```
+

data/docs/GetReleasesRequest.md

@@ -0,0 +1,20 @@
+# Athenian::GetReleasesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account ID. |  |
+| **releases** | [**Array<ReleaseNames>**](ReleaseNames.md) | List of repositories and release names to list. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::GetReleasesRequest.new(
+  account: null,
+  releases: null
+)
+```
+

data/docs/GoalMetricParams.md

@@ -0,0 +1,18 @@
+# Athenian::GoalMetricParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **threshold** | [**GoalMetricParamsThreshold**](GoalMetricParamsThreshold.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::GoalMetricParams.new(
+  threshold: null
+)
+```
+

data/docs/GoalMetricParamsThreshold.md

@@ -0,0 +1,49 @@
+# Athenian::GoalMetricParamsThreshold
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'athenian'
+
+Athenian::GoalMetricParamsThreshold.openapi_one_of
+# =>
+# [
+#   :'Float',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'athenian'
+
+Athenian::GoalMetricParamsThreshold.build(data)
+# => #<Float:0x00007fdd4aab02a0>
+
+Athenian::GoalMetricParamsThreshold.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Float`
+- `String`
+- `nil` (if no type matches)
+

data/docs/GoalTemplate.md

@@ -0,0 +1,28 @@
+# Athenian::GoalTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available** | **Boolean** | Whether the templates is avaiable for use. |  |
+| **id** | **Integer** | Identifier of the template. |  |
+| **metric** | [**GoalTemplateMetric**](GoalTemplateMetric.md) |  |  |
+| **metric_params** | [**GoalMetricParams**](GoalMetricParams.md) |  | [optional] |
+| **name** | **String** | Name of the template. |  |
+| **repositories** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::GoalTemplate.new(
+  available: null,
+  id: null,
+  metric: null,
+  metric_params: null,
+  name: Untitled Template,
+  repositories: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"]
+)
+```
+

data/docs/GoalTemplateCreateRequest.md

@@ -0,0 +1,26 @@
+# Athenian::GoalTemplateCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account identifier. That account will own the created goal template. |  |
+| **metric** | [**GoalTemplateMetric**](GoalTemplateMetric.md) |  |  |
+| **metric_params** | [**GoalMetricParams**](GoalMetricParams.md) |  | [optional] |
+| **name** | **String** | Name of the template. |  |
+| **repositories** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::GoalTemplateCreateRequest.new(
+  account: null,
+  metric: null,
+  metric_params: null,
+  name: Untitled Template,
+  repositories: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"]
+)
+```
+

data/docs/GoalTemplateMetric.md

@@ -0,0 +1,51 @@
+# Athenian::GoalTemplateMetric
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'athenian'
+
+Athenian::GoalTemplateMetric.openapi_one_of
+# =>
+# [
+#   :'JIRAMetricID',
+#   :'PullRequestMetricID',
+#   :'ReleaseMetricID'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'athenian'
+
+Athenian::GoalTemplateMetric.build(data)
+# => #<JIRAMetricID:0x00007fdd4aab02a0>
+
+Athenian::GoalTemplateMetric.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `JIRAMetricID`
+- `PullRequestMetricID`
+- `ReleaseMetricID`
+- `nil` (if no type matches)
+

data/docs/GoalTemplateUpdateRequest.md

@@ -0,0 +1,24 @@
+# Athenian::GoalTemplateUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the template. |  |
+| **metric** | [**GoalTemplateMetric**](GoalTemplateMetric.md) |  |  |
+| **metric_params** | [**GoalMetricParams**](GoalMetricParams.md) |  | [optional] |
+| **repositories** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::GoalTemplateUpdateRequest.new(
+  name: Untitled Template,
+  metric: null,
+  metric_params: null,
+  repositories: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"]
+)
+```
+

data/docs/HistogramScale.md

@@ -0,0 +1,15 @@
+# Athenian::HistogramScale
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::HistogramScale.new()
+```
+

data/docs/HistogramsApi.md

@@ -0,0 +1,226 @@
+# Athenian::HistogramsApi
+
+All URIs are relative to *https://api.athenian.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**calc_histogram_code_checks**](HistogramsApi.md#calc_histogram_code_checks) | **POST** /histograms/code_checks | Calculate histograms on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc. |
+| [**calc_histogram_jira**](HistogramsApi.md#calc_histogram_jira) | **POST** /histograms/jira | Calculate histograms over JIRA issue activities. |
+| [**calc_histogram_prs**](HistogramsApi.md#calc_histogram_prs) | **POST** /histograms/pull_requests | Calculate histograms over PR distributions. |
+
+
+## calc_histogram_code_checks
+
+> <Array<CalculatedCodeCheckHistogram>> calc_histogram_code_checks(body)
+
+Calculate histograms on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc.
+
+### Examples
+
+```ruby
+require 'time'
+require 'athenian'
+# setup authorization
+Athenian.configure do |config|
+  # Configure API key authorization: apiKeyAuth
+  config.api_key['apiKeyAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Athenian::HistogramsApi.new
+body = Athenian::CodeCheckHistogramsRequest.new({_for: [Athenian::ForSetCodeChecks.new({repositories: ["github.com/athenianco/athenian-webapp", "github.com/athenianco/athenian-api"]})], histograms: [Athenian::CodeCheckHistogramDefinition.new({metric: Athenian::CodeCheckMetricID::SUITES_COUNT})], date_from: Date.today, date_to: Date.today, account: 37}) # CodeCheckHistogramsRequest | Select the check runs of interest and the metrics to calculate.
+
+begin
+  # Calculate histograms on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc.
+  result = api_instance.calc_histogram_code_checks(body)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling HistogramsApi->calc_histogram_code_checks: #{e}"
+end
+```
+
+#### Using the calc_histogram_code_checks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CalculatedCodeCheckHistogram>>, Integer, Hash)> calc_histogram_code_checks_with_http_info(body)
+
+```ruby
+begin
+  # Calculate histograms on continuous integration runs, such as GitHub Actions, Jenkins, Circle, etc.
+  data, status_code, headers = api_instance.calc_histogram_code_checks_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CalculatedCodeCheckHistogram>>
+rescue Athenian::ApiError => e
+  puts "Error when calling HistogramsApi->calc_histogram_code_checks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**CodeCheckHistogramsRequest**](CodeCheckHistogramsRequest.md) | Select the check runs of interest and the metrics to calculate. |  |
+
+### Return type
+
+[**Array&lt;CalculatedCodeCheckHistogram&gt;**](CalculatedCodeCheckHistogram.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## calc_histogram_jira
+
+> <Array<CalculatedJIRAHistogram>> calc_histogram_jira(body)
+
+Calculate histograms over JIRA issue activities.
+
+### Examples
+
+```ruby
+require 'time'
+require 'athenian'
+# setup authorization
+Athenian.configure do |config|
+  # Configure API key authorization: apiKeyAuth
+  config.api_key['apiKeyAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Athenian::HistogramsApi.new
+body = Athenian::JIRAHistogramsRequest.new({histograms: [Athenian::JIRAHistogramDefinition.new({metric: Athenian::JIRAMetricID::OPEN})], date_from: Date.today, date_to: Date.today, exclude_inactive: false, account: 37}) # JIRAHistogramsRequest | Query for selecting JIRA issues and binned activities.
+
+begin
+  # Calculate histograms over JIRA issue activities.
+  result = api_instance.calc_histogram_jira(body)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling HistogramsApi->calc_histogram_jira: #{e}"
+end
+```
+
+#### Using the calc_histogram_jira_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CalculatedJIRAHistogram>>, Integer, Hash)> calc_histogram_jira_with_http_info(body)
+
+```ruby
+begin
+  # Calculate histograms over JIRA issue activities.
+  data, status_code, headers = api_instance.calc_histogram_jira_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CalculatedJIRAHistogram>>
+rescue Athenian::ApiError => e
+  puts "Error when calling HistogramsApi->calc_histogram_jira_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**JIRAHistogramsRequest**](JIRAHistogramsRequest.md) | Query for selecting JIRA issues and binned activities. |  |
+
+### Return type
+
+[**Array&lt;CalculatedJIRAHistogram&gt;**](CalculatedJIRAHistogram.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## calc_histogram_prs
+
+> <Array<CalculatedPullRequestHistogram>> calc_histogram_prs(body)
+
+Calculate histograms over PR distributions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'athenian'
+# setup authorization
+Athenian.configure do |config|
+  # Configure API key authorization: apiKeyAuth
+  config.api_key['apiKeyAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKeyAuth'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Athenian::HistogramsApi.new
+body = Athenian::PullRequestHistogramsRequest.new({_for: [Athenian::ForSetPullRequests.new], histograms: [Athenian::PullRequestHistogramDefinition.new({metric: Athenian::PullRequestMetricID::WIP_TIME})], date_from: Date.today, date_to: Date.today, exclude_inactive: false, account: 37}) # PullRequestHistogramsRequest | Desired histogram definitions.
+
+begin
+  # Calculate histograms over PR distributions.
+  result = api_instance.calc_histogram_prs(body)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling HistogramsApi->calc_histogram_prs: #{e}"
+end
+```
+
+#### Using the calc_histogram_prs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<CalculatedPullRequestHistogram>>, Integer, Hash)> calc_histogram_prs_with_http_info(body)
+
+```ruby
+begin
+  # Calculate histograms over PR distributions.
+  data, status_code, headers = api_instance.calc_histogram_prs_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<CalculatedPullRequestHistogram>>
+rescue Athenian::ApiError => e
+  puts "Error when calling HistogramsApi->calc_histogram_prs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**PullRequestHistogramsRequest**](PullRequestHistogramsRequest.md) | Desired histogram definitions. |  |
+
+### Return type
+
+[**Array&lt;CalculatedPullRequestHistogram&gt;**](CalculatedPullRequestHistogram.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/IncludedDeployments.md

@@ -0,0 +1,18 @@
+# Athenian::IncludedDeployments
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deployments** | [**Hash<String, DeploymentNotification>**](DeploymentNotification.md) | Mapping deployment names to their details. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::IncludedDeployments.new(
+  deployments: null
+)
+```
+

data/docs/IncludedJIRAIssues.md

@@ -0,0 +1,18 @@
+# Athenian::IncludedJIRAIssues
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **jira** | [**Hash<String, LinkedJIRAIssue>**](LinkedJIRAIssue.md) | Mapping JIRA issue ID -> details. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::IncludedJIRAIssues.new(
+  jira: null
+)
+```
+

data/docs/IncludedNativeUser.md

@@ -0,0 +1,18 @@
+# Athenian::IncludedNativeUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **avatar** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::IncludedNativeUser.new(
+  avatar: null
+)
+```
+

data/docs/IncludedNativeUsers.md

@@ -0,0 +1,18 @@
+# Athenian::IncludedNativeUsers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **users** | [**Hash<String, IncludedNativeUser>**](IncludedNativeUser.md) | Mapping user native (e.g., GitHub) login ID -> user details. The users are mentioned in the PRs from \"PullRequestSet.data\" or in the commits from \"FilterCommitsRequest.data\". |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::IncludedNativeUsers.new(
+  users: null
+)
+```
+

data/docs/InstallationProgress.md

@@ -0,0 +1,26 @@
+# Athenian::InstallationProgress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **started_date** | **Time** | Date and time when the historical data collection began. |  |
+| **finished_date** | **Time** | Date and time when the historical data collection ended. |  |
+| **owner** | **String** | Login of the person who installed the metadata. | [optional] |
+| **repositories** | **Integer** | Number of discovered repositories. | [optional] |
+| **tables** | [**Array<TableFetchingProgress>**](TableFetchingProgress.md) |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::InstallationProgress.new(
+  started_date: null,
+  finished_date: null,
+  owner: null,
+  repositories: null,
+  tables: [{"fetched":50,"name":"Commit","total":100},{"fetched":0,"total":200,"name":"PullRequest"}]
+)
+```
+