athenian 2.1.81

data/docs/ProductFeature.md

@@ -0,0 +1,20 @@
+# Athenian::ProductFeature
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **parameters** | [**ProductFeatureParameters**](ProductFeatureParameters.md) |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::ProductFeature.new(
+  name: null,
+  parameters: null
+)
+```
+

data/docs/ProductFeatureParameters.md

@@ -0,0 +1,51 @@
+# Athenian::ProductFeatureParameters
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'athenian'
+
+Athenian::ProductFeatureParameters.openapi_one_of
+# =>
+# [
+#   :'Float',
+#   :'Object',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'athenian'
+
+Athenian::ProductFeatureParameters.build(data)
+# => #<Float:0x00007fdd4aab02a0>
+
+Athenian::ProductFeatureParameters.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`
+- `Object`
+- `String`
+- `nil` (if no type matches)
+

data/docs/PullRequest.md

@@ -0,0 +1,74 @@
+# Athenian::PullRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **repository** | **String** | PR is/was open in this repository. |  |
+| **number** | **Integer** | PR number. |  |
+| **title** | **String** | Title of the PR. |  |
+| **size_added** | **Integer** | Overall number of lines added. |  |
+| **size_removed** | **Integer** | Overall number of lines removed. |  |
+| **files_changed** | **Integer** | Number of files changed in this PR. |  |
+| **created** | **Time** | When this PR was created. |  |
+| **updated** | **Time** | When this PR was last updated. |  |
+| **closed** | **Time** | When this PR was last closed. | [optional] |
+| **comments** | **Integer** | Number of *regular* (not review) comments in this PR. |  |
+| **commits** | **Integer** | Number of commits in this PR. |  |
+| **review_requested** | **Time** | When was the first time the author of this PR requested a review. | [optional] |
+| **first_review** | **Time** | When the first review of this PR happened. | [optional] |
+| **approved** | **Time** | When this PR was approved. | [optional] |
+| **review_comments** | **Integer** | Number of review comments this PR received. A review comment is left at a specific line in a specific file. In other words: review summaries are *not* considered review comments; refer to `reviews`. Comments by the PR author are considered as `comments`, not as `review_comments`. | [optional] |
+| **reviews** | **Integer** | Number of times this PR was reviewed. Reviews by the PR author are not taken into account. | [optional] |
+| **merged** | **Time** | When this PR was merged. | [optional] |
+| **merged_with_failed_check_runs** | **Array<String>** | PR was merged with these failed check runs. | [optional] |
+| **released** | **Time** | When this PR was released. | [optional] |
+| **release_url** | **String** | URL of the earliest release that includes this merged PR. | [optional] |
+| **deployments** | **Array<String>** | List of deployments that contain this PR. | [optional] |
+| **stage_timings** | [**StageTimings**](StageTimings.md) |  |  |
+| **events_time_machine** | [**Array<PullRequestEvent>**](PullRequestEvent.md) | List of PR events which happened until `date_to`. `date_from` does not matter. | [optional] |
+| **stages_time_machine** | [**Array<PullRequestStage>**](PullRequestStage.md) | List of PR stages as of `date_to` (normally, of length 1). | [optional] |
+| **events_now** | [**Array<PullRequestEvent>**](PullRequestEvent.md) | List of PR events that ever happened. |  |
+| **stages_now** | [**Array<PullRequestStage>**](PullRequestStage.md) | List of current PR stages (normally, of length 1). |  |
+| **participants** | [**Array<PullRequestParticipant>**](PullRequestParticipant.md) | List of developers related to this PR. |  |
+| **labels** | [**Array<PullRequestLabel>**](PullRequestLabel.md) | List of PR labels. | [optional] |
+| **jira** | [**Array<LinkedJIRAIssue>**](LinkedJIRAIssue.md) | List of linked JIRA issues. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequest.new(
+  repository: null,
+  number: null,
+  title: null,
+  size_added: null,
+  size_removed: null,
+  files_changed: null,
+  created: null,
+  updated: null,
+  closed: null,
+  comments: null,
+  commits: null,
+  review_requested: null,
+  first_review: null,
+  approved: null,
+  review_comments: null,
+  reviews: null,
+  merged: null,
+  merged_with_failed_check_runs: null,
+  released: null,
+  release_url: null,
+  deployments: null,
+  stage_timings: null,
+  events_time_machine: null,
+  stages_time_machine: null,
+  events_now: null,
+  stages_now: null,
+  participants: null,
+  labels: null,
+  jira: null
+)
+```
+

data/docs/PullRequestEvent.md

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

data/docs/PullRequestHistogramDefinition.md

@@ -0,0 +1,24 @@
+# Athenian::PullRequestHistogramDefinition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metric** | [**PullRequestMetricID**](PullRequestMetricID.md) |  |  |
+| **scale** | [**HistogramScale**](HistogramScale.md) |  | [optional] |
+| **bins** | **Integer** | Number of bars in the histogram. 0 or null means automatic. | [optional] |
+| **ticks** | [**Array<GoalMetricParamsThreshold>**](GoalMetricParamsThreshold.md) | Alternatively to `bins` and `scale`, set the X axis bar borders manually. Only one of two may be specified. The ticks are automatically prepended the distribution minimum and appended the distribution maximum. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestHistogramDefinition.new(
+  metric: null,
+  scale: null,
+  bins: null,
+  ticks: null
+)
+```
+

data/docs/PullRequestHistogramsRequest.md

@@ -0,0 +1,34 @@
+# Athenian::PullRequestHistogramsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_for** | [**Array<ForSetPullRequests>**](ForSetPullRequests.md) | Sets of developers and repositories for which to calculate the histograms. The aggregation is `AND` between repositories and developers. The aggregation is `OR` inside both repositories and developers. |  |
+| **histograms** | [**Array<PullRequestHistogramDefinition>**](PullRequestHistogramDefinition.md) | Histogram parameters for each wanted topic. |  |
+| **date_from** | **Date** | Date from when to start measuring the distribution. |  |
+| **date_to** | **Date** | Date until which to measure the distribution. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **exclude_inactive** | **Boolean** | Value indicating whether PRs without events in the given time frame shall be ignored. |  |
+| **quantiles** | **Array<Float>** | Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting. | [optional] |
+| **account** | **Integer** | Session account ID. |  |
+| **fresh** | **Boolean** | Force histograms calculation on the most up to date data. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestHistogramsRequest.new(
+  _for: null,
+  histograms: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  exclude_inactive: null,
+  quantiles: [0,0.95],
+  account: null,
+  fresh: null
+)
+```
+

data/docs/PullRequestLabel.md

@@ -0,0 +1,22 @@
+# Athenian::PullRequestLabel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **color** | **String** | RGB 24-bit color in hex. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestLabel.new(
+  name: null,
+  description: null,
+  color: null
+)
+```
+

data/docs/PullRequestMetricID.md

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

data/docs/PullRequestMetricsRequest.md

@@ -0,0 +1,36 @@
+# Athenian::PullRequestMetricsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_for** | [**Array<ForSetPullRequests>**](ForSetPullRequests.md) | Sets of developers and repositories for which to calculate the metrics. The aggregation is `AND` between repositories and developers. The aggregation is `OR` inside both repositories and developers. |  |
+| **metrics** | [**Array<PullRequestMetricID>**](PullRequestMetricID.md) | Requested metric identifiers. |  |
+| **date_from** | **Date** | Date from when to start measuring the metrics. |  |
+| **date_to** | **Date** | Date until which to measure the metrics. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **granularities** | **Array<String>** | The splits of the specified time range. |  |
+| **quantiles** | **Array<Float>** | Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting. | [optional] |
+| **exclude_inactive** | **Boolean** | Value indicating whether PRs without events in the given time frame shall be ignored. |  |
+| **account** | **Integer** | Session account ID. |  |
+| **fresh** | **Boolean** | Force metrics calculation on the most up to date data. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestMetricsRequest.new(
+  _for: null,
+  metrics: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  granularities: null,
+  quantiles: [0,0.95],
+  exclude_inactive: null,
+  account: null,
+  fresh: null
+)
+```
+

data/docs/PullRequestNumbers.md

@@ -0,0 +1,20 @@
+# Athenian::PullRequestNumbers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **repository** | **String** | Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No \".git\" should be appended. We support a special syntax for repository sets: \"{reposet id}\" adds all the repositories from the given set.  |  |
+| **numbers** | **Array<Integer>** |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestNumbers.new(
+  repository: github.com/athenianco/athenian-webapp,
+  numbers: null
+)
+```
+

data/docs/PullRequestPaginationPlan.md

@@ -0,0 +1,18 @@
+# Athenian::PullRequestPaginationPlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **updated** | **Array<Date>** | Split borders in *descending* order. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestPaginationPlan.new(
+  updated: null
+)
+```
+

data/docs/PullRequestParticipant.md

@@ -0,0 +1,20 @@
+# Athenian::PullRequestParticipant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Person identifier. |  |
+| **status** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestParticipant.new(
+  id: github.com/vmarkovtsev,
+  status: null
+)
+```
+

data/docs/PullRequestSet.md

@@ -0,0 +1,20 @@
+# Athenian::PullRequestSet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include** | [**PullRequestSetInclude**](PullRequestSetInclude.md) |  |  |
+| **data** | [**Array<PullRequest>**](PullRequest.md) | List of matched pull requests. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestSet.new(
+  include: null,
+  data: null
+)
+```
+

data/docs/PullRequestSetInclude.md

@@ -0,0 +1,20 @@
+# Athenian::PullRequestSetInclude
+
+## 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\". |  |
+| **deployments** | [**Hash<String, DeploymentNotification>**](DeploymentNotification.md) | Mapping deployment names to their details. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestSetInclude.new(
+  users: null,
+  deployments: null
+)
+```
+

data/docs/PullRequestStage.md

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

data/docs/PullRequestWith.md

@@ -0,0 +1,30 @@
+# Athenian::PullRequestWith
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **author** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **reviewer** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **commit_author** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **commit_committer** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **commenter** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **merger** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **releaser** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::PullRequestWith.new(
+  author: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  reviewer: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  commit_author: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  commit_committer: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  commenter: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  merger: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  releaser: ["github.com/vmarkovtsev","github.com/dpordomingo"]
+)
+```
+