athenian 2.1.81

data/docs/CreatedIdentifier.md

@@ -0,0 +1,18 @@
+# Athenian::CreatedIdentifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Identifier of the created entity. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::CreatedIdentifier.new(
+  id: 777
+)
+```
+

data/docs/CreatedToken.md

@@ -0,0 +1,20 @@
+# Athenian::CreatedToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Token identifier - can be used in `/token/{id}` DELETE. |  |
+| **token** | **String** | Secret token - not stored server-side! |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::CreatedToken.new(
+  id: null,
+  token: null
+)
+```
+

data/docs/Datasource.md

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

data/docs/DeleteEventsCacheRequest.md

@@ -0,0 +1,22 @@
+# Athenian::DeleteEventsCacheRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account ID. |  |
+| **repositories** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. |  |
+| **targets** | **Array<String>** | Parts of the precomputed cache to reset. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeleteEventsCacheRequest.new(
+  account: null,
+  repositories: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  targets: null
+)
+```
+

data/docs/DeployedComponent.md

@@ -0,0 +1,20 @@
+# Athenian::DeployedComponent
+
+## 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.  |  |
+| **reference** | **String** | We accept three ways to define a Git reference: 1. Tag name. 2. Full commit hash (40 characters). 3. Short commit hash (7 characters).  We ignore the reference while we cannot find it in our database. There can be two reasons: - There is a mistake or a typo in the provided data. - We are temporarily unable to synchronize with GitHub.  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeployedComponent.new(
+  repository: github.com/athenianco/athenian-webapp,
+  reference: null
+)
+```
+

data/docs/DeployedPullRequest.md

@@ -0,0 +1,32 @@
+# Athenian::DeployedPullRequest
+
+## 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.  |  |
+| **additions** | **Integer** |  |  |
+| **author** | [**ReleasedPullRequestAuthor**](ReleasedPullRequestAuthor.md) |  |  |
+| **created** | **Time** | When this PR was created. |  |
+| **deletions** | **Integer** |  |  |
+| **jira** | **Array<String>** | Mapped JIRA issue IDs. | [optional] |
+| **number** | **Integer** |  |  |
+| **title** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeployedPullRequest.new(
+  repository: github.com/athenianco/athenian-webapp,
+  additions: null,
+  author: null,
+  created: null,
+  deletions: null,
+  jira: null,
+  number: null,
+  title: null
+)
+```
+

data/docs/DeployedPullRequestAllOf.md

@@ -0,0 +1,18 @@
+# Athenian::DeployedPullRequestAllOf
+
+## 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.  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeployedPullRequestAllOf.new(
+  repository: github.com/athenianco/athenian-webapp
+)
+```
+

data/docs/DeployedRelease.md

@@ -0,0 +1,40 @@
+# Athenian::DeployedRelease
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added_lines** | **Integer** | Cumulative number of lines inserted since the previous release. |  |
+| **age** | **String** | Time since the previous release /\\d+s/. |  |
+| **commits** | **Integer** | Number of commits since the previous release. |  |
+| **commit_authors** | **Array<String>** | List of released commit authors' logins. |  |
+| **deleted_lines** | **Integer** | Cumulative number of lines removed since the previous release. |  |
+| **name** | **String** | Title of the release. |  |
+| **prs** | **Integer** | Number of deployed pull requests. |  |
+| **published** | **Time** | When the release was created. |  |
+| **publisher** | **String** | Login of the person who created the release. |  |
+| **repository** | **String** | Name of the repository where the release exists. |  |
+| **sha** | **String** | Release commit hash. |  |
+| **url** | **String** | Link to the release. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeployedRelease.new(
+  added_lines: null,
+  age: null,
+  commits: null,
+  commit_authors: null,
+  deleted_lines: null,
+  name: null,
+  prs: null,
+  published: null,
+  publisher: null,
+  repository: null,
+  sha: null,
+  url: null
+)
+```
+

data/docs/DeploymentAnalysis.md

@@ -0,0 +1,22 @@
+# Athenian::DeploymentAnalysis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | [**DeploymentAnalysisCode**](DeploymentAnalysisCode.md) |  |  |
+| **prs** | [**Array<DeployedPullRequest>**](DeployedPullRequest.md) | List of deployed pull requests. | [optional] |
+| **releases** | [**Array<DeployedRelease>**](DeployedRelease.md) | Deployed releases. The format matches `FilteredRelease` except that `prs` is the number of released pull requests instead of a list. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeploymentAnalysis.new(
+  code: null,
+  prs: null,
+  releases: null
+)
+```
+

data/docs/DeploymentAnalysisCode.md

@@ -0,0 +1,28 @@
+# Athenian::DeploymentAnalysisCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prs** | **Hash<String, Integer>** | Number of deployed pull requests per repository. |  |
+| **lines_prs** | **Hash<String, Integer>** | Number of changed lines in the deployed PRs per repository. |  |
+| **lines_overall** | **Hash<String, Integer>** | Number of changed lines in the deployment per repository. |  |
+| **commits_prs** | **Hash<String, Integer>** | Number of deployed PR commits per repository. |  |
+| **commits_overall** | **Hash<String, Integer>** | Number of deployed commits per repository. |  |
+| **jira** | **Hash<String, Array<String>>** | JIRA issues mentioned in the deployed PRs. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeploymentAnalysisCode.new(
+  prs: null,
+  lines_prs: null,
+  lines_overall: null,
+  commits_prs: null,
+  commits_overall: null,
+  jira: null
+)
+```
+

data/docs/DeploymentConclusion.md

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

data/docs/DeploymentMetricID.md

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

data/docs/DeploymentMetricsRequest.md

@@ -0,0 +1,32 @@
+# Athenian::DeploymentMetricsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_for** | [**Array<ForSetDeployments>**](ForSetDeployments.md) | Sets of filters for which to calculate the metrics. The aggregation is `AND` between individual properties like `repositories` or `with`. The aggregation is `OR` inside each property. |  |
+| **metrics** | [**Array<DeploymentMetricID>**](DeploymentMetricID.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] |
+| **account** | **Integer** | Session account ID. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeploymentMetricsRequest.new(
+  _for: null,
+  metrics: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  granularities: null,
+  quantiles: [0,0.95],
+  account: null
+)
+```
+

data/docs/DeploymentModifyLabelsRequest.md

@@ -0,0 +1,20 @@
+# Athenian::DeploymentModifyLabelsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delete** | **Array<String>** | Delete the labels with the given keys.  Unexisting labels are ignored. | [optional] |
+| **upsert** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeploymentModifyLabelsRequest.new(
+  delete: null,
+  upsert: null
+)
+```
+

data/docs/DeploymentNotification.md

@@ -0,0 +1,32 @@
+# Athenian::DeploymentNotification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **components** | [**Array<DeployedComponent>**](DeployedComponent.md) | List of deployed software version. Each item identifies a Git reference in a repository, either a tag or a commit hash.  |  |
+| **environment** | **String** | Name of the environment where the deployment happened. |  |
+| **name** | **String** | Name of the deployment. If is not specified, we generate our own by the template `<environment shortcut>-<date>-<hash of the components>`. The value may not contain \\n - new line character, and ' - single quote. | [optional] |
+| **url** | **String** | URL pointing at the internal details of the deployment. | [optional] |
+| **date_started** | **Time** | Timestamp of when the deployment procedure launched. |  |
+| **date_finished** | **Time** | Timestamp of when the deployment procedure completed. |  |
+| **conclusion** | [**DeploymentConclusion**](DeploymentConclusion.md) |  |  |
+| **labels** | **Object** | Arbitrary key-value metadata that associates with the deployment. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeploymentNotification.new(
+  components: null,
+  environment: null,
+  name: null,
+  url: null,
+  date_started: null,
+  date_finished: null,
+  conclusion: null,
+  labels: null
+)
+```
+

data/docs/DeploymentWith.md

@@ -0,0 +1,22 @@
+# Athenian::DeploymentWith
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pr_author** | **Array** |  | [optional] |
+| **commit_author** | **Array** |  | [optional] |
+| **releaser** | **Array** |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeploymentWith.new(
+  pr_author: null,
+  commit_author: null,
+  releaser: null
+)
+```
+

data/docs/DeveloperMetricID.md

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

data/docs/DeveloperMetricsRequest.md

@@ -0,0 +1,30 @@
+# Athenian::DeveloperMetricsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_for** | [**Array<ForSetDevelopers>**](ForSetDevelopers.md) | Sets of developers and repositories to calculate the metrics for. |  |
+| **metrics** | [**Array<DeveloperMetricID>**](DeveloperMetricID.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] |
+| **account** | **Integer** | Session account ID. |  |
+| **granularities** | **Array<String>** | The splits of the specified time range. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeveloperMetricsRequest.new(
+  _for: null,
+  metrics: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  account: null,
+  granularities: null
+)
+```
+

data/docs/DeveloperSummary.md

@@ -0,0 +1,26 @@
+# Athenian::DeveloperSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **login** | **String** | Developer's login name. |  |
+| **name** | **String** | Developer's full name. |  |
+| **avatar** | **String** | Developer's avatar URL. |  |
+| **updates** | [**DeveloperUpdates**](DeveloperUpdates.md) |  |  |
+| **jira_user** | **String** | Mapped JIRA user name. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeveloperSummary.new(
+  login: github.com/gkwillie,
+  name: Groundskeeper Willie,
+  avatar: https://avatars0.githubusercontent.com/u/60340680?v=4,
+  updates: null,
+  jira_user: null
+)
+```
+

data/docs/DeveloperUpdates.md

@@ -0,0 +1,28 @@
+# Athenian::DeveloperUpdates
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prs** | **Integer** | How many PRs authored by this developer updated. Note: this is not the same as the number of PRs this developer opened. Note: the update origin is not necessarily this developer. | [optional] |
+| **reviewer** | **Integer** | How many reviews this developer submitted. Note: this is not the same as the number of unique PRs reviewed. | [optional] |
+| **commit_author** | **Integer** | How many commits this developer authored. | [optional] |
+| **commit_committer** | **Integer** | How many commits this developer pushed. | [optional] |
+| **commenter** | **Integer** | How many regular PR comments this developer left. Note: issues are not taken into account, only the PRs. | [optional] |
+| **releaser** | **Integer** | How many releases this developer created. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DeveloperUpdates.new(
+  prs: null,
+  reviewer: null,
+  commit_author: null,
+  commit_committer: null,
+  commenter: null,
+  releaser: null
+)
+```
+

data/docs/DiffReleasesRequest.md

@@ -0,0 +1,20 @@
+# Athenian::DiffReleasesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** |  |  |
+| **borders** | **Hash<String, Array<ReleasePair>>** | Mapping from repository names to analyzed release pairs. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DiffReleasesRequest.new(
+  account: null,
+  borders: null
+)
+```
+

data/docs/DiffedReleases.md

@@ -0,0 +1,20 @@
+# Athenian::DiffedReleases
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **include** | [**DiffedReleasesInclude**](DiffedReleasesInclude.md) |  |  |
+| **data** | **Hash<String, Array<ReleaseDiff>>** | Mapping from repository names to diff results. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DiffedReleases.new(
+  include: null,
+  data: null
+)
+```
+

data/docs/DiffedReleasesInclude.md

@@ -0,0 +1,20 @@
+# Athenian::DiffedReleasesInclude
+
+## 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\". |  |
+| **jira** | [**Hash<String, LinkedJIRAIssue>**](LinkedJIRAIssue.md) | Mapping JIRA issue ID -> details. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::DiffedReleasesInclude.new(
+  users: null,
+  jira: null
+)
+```
+