athenian 2.1.81

data/docs/JIRAInstallation.md

@@ -0,0 +1,20 @@
+# Athenian::JIRAInstallation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | JIRA base URL. |  |
+| **projects** | **Array<String>** | List of accessible project keys. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAInstallation.new(
+  url: null,
+  projects: null
+)
+```
+

data/docs/JIRAIssue.md

@@ -0,0 +1,56 @@
+# Athenian::JIRAIssue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | JIRA issue key `PROJECT-###`. |  |
+| **title** | **String** | Title of this issue. |  |
+| **created** | **Time** | When this issue was created. |  |
+| **updated** | **Time** | When this issue was last updated. |  |
+| **work_began** | **Time** | When the issue entered the \"In Progress\" stage or received a PR. This timestamp can be missing and is always less than or equal to `resolved`. | [optional] |
+| **resolved** | **Time** | When the issue finished: the stage is \"Done\" and all PRs are either released or rejected. This timestamp can be missing and is always greater than or equal to `work_began`. | [optional] |
+| **lead_time** | **Object** |  | [optional] |
+| **life_time** | **Object** |  |  |
+| **reporter** | **String** | Name of the person who reported the issue. |  |
+| **assignee** | **String** | Name of the assigned person. | [optional] |
+| **comments** | **Integer** | Number of comments in the issue excluding sub-tasks and children. |  |
+| **comment_list** | [**Array<JIRAComment>**](JIRAComment.md) | The list of comments for the issue. | [optional] |
+| **priority** | **String** | Name of the priority. The details are returned in `FilteredJIRAStuff.priorities`. |  |
+| **rendered_description** | **String** | The description of the issue rendered as HTML. | [optional] |
+| **status** | **String** | Name of the status. The details are returned in `FilteredJIRAStuff.statuses`. |  |
+| **story_points** | **Float** | Value of the \"story points\" field. | [optional] |
+| **type** | **String** | Name of the issue type. The details are returned in `FilteredJIRAStuff.issue_types`. |  |
+| **url** | **String** | Link to the issue in JIRA web application. |  |
+| **project** | **String** | Identifier of the project where this issue exists. |  |
+| **prs** | [**Array<PullRequest>**](PullRequest.md) | Details about the mapped PRs. `jira` field is unfilled. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAIssue.new(
+  id: null,
+  title: null,
+  created: null,
+  updated: null,
+  work_began: null,
+  resolved: null,
+  lead_time: null,
+  life_time: null,
+  reporter: null,
+  assignee: null,
+  comments: null,
+  comment_list: null,
+  priority: null,
+  rendered_description: null,
+  status: null,
+  story_points: null,
+  type: null,
+  url: null,
+  project: null,
+  prs: null
+)
+```
+

data/docs/JIRAIssueAllOf.md

@@ -0,0 +1,20 @@
+# Athenian::JIRAIssueAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project** | **String** | Identifier of the project where this issue exists. |  |
+| **prs** | [**Array<PullRequest>**](PullRequest.md) | Details about the mapped PRs. `jira` field is unfilled. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAIssueAllOf.new(
+  project: null,
+  prs: null
+)
+```
+

data/docs/JIRAIssueType.md

@@ -0,0 +1,30 @@
+# Athenian::JIRAIssueType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the issue type. |  |
+| **normalized_name** | **String** | Normalized name of the issue type. For example, \"Sub-tásks\" becomes \"subtask\". |  |
+| **count** | **Integer** | Number of issues that satisfy the filters and belong to this type. |  |
+| **image** | **String** | Icon URL. |  |
+| **project** | **String** | Bound project identifier. |  |
+| **is_subtask** | **Boolean** | Value indicating whether this issue type refers to a sub-task. |  |
+| **is_epic** | **Boolean** | Value indicating whether this issue type refers to an epic. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAIssueType.new(
+  name: null,
+  normalized_name: null,
+  count: null,
+  image: null,
+  project: null,
+  is_subtask: null,
+  is_epic: null
+)
+```
+

data/docs/JIRALabel.md

@@ -0,0 +1,24 @@
+# Athenian::JIRALabel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** |  |  |
+| **last_used** | **Time** | When this label was last assigned to an issue. |  |
+| **issues_count** | **Integer** | In how many issues (in the specified time interval) this label was used. |  |
+| **kind** | **String** | Label kind - \"Label\", \"Component\", etc. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRALabel.new(
+  title: null,
+  last_used: null,
+  issues_count: null,
+  kind: null
+)
+```
+

data/docs/JIRAMetricID.md

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

data/docs/JIRAMetricsRequest.md

@@ -0,0 +1,50 @@
+# Athenian::JIRAMetricsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **date_from** | **Date** | Issues must be resolved after this date. |  |
+| **date_to** | **Date** | Issues must be created before this date. |  |
+| **_for** | [**Array<JIRAFilter>**](JIRAFilter.md) | Calculate metrics separately for each JIRA Filter in the list. Not compatible with other jira filters in the request:   `priorities`, `types`, `labels_include`, `labels_exclude`, `epics`, `projects`.  | [optional] |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **priorities** | **Array<String>** | Selected issue priorities. | [optional] |
+| **types** | **Array<String>** | Selected issue types. | [optional] |
+| **labels_include** | **Array<String>** | JIRA issues must contain at least one label from the list. Several labels may be concatenated by a comma `,` so that all of them are required. | [optional] |
+| **labels_exclude** | **Array<String>** | JIRA issues may not contain labels from this list. | [optional] |
+| **exclude_inactive** | **Boolean** | Value indicating whether issues with the last update older than `date_from` should be ignored. If `date_from` and `date_to` are `null`, does nothing. |  |
+| **epics** | **Array<String>** | JIRA issues must be attached to any of the epic IDs from this list. | [optional] |
+| **with** | [**Array<JIRAFilterWith>**](JIRAFilterWith.md) | Groups of issue participants. The metrics will be calculated for each group. | [optional] |
+| **projects** | **Array<String>** | Issues must belong to these JIRA projects. | [optional] |
+| **metrics** | [**Array<JIRAMetricID>**](JIRAMetricID.md) | List of measured metrics. |  |
+| **quantiles** | **Array<Float>** | Cut the distributions at certain quantiles. The default values are [0, 1] which means no cutting. | [optional] |
+| **granularities** | **Array<String>** | The splits of the specified time range. |  |
+| **group_by_jira_label** | **Boolean** | Value indicating whether the metrics should be grouped by assigned JIRA issue label. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAMetricsRequest.new(
+  account: null,
+  date_from: null,
+  date_to: null,
+  _for: null,
+  timezone: null,
+  priorities: null,
+  types: null,
+  labels_include: null,
+  labels_exclude: null,
+  exclude_inactive: null,
+  epics: null,
+  with: null,
+  projects: null,
+  metrics: null,
+  quantiles: [0,0.95],
+  granularities: null,
+  group_by_jira_label: null
+)
+```
+

data/docs/JIRAPriority.md

@@ -0,0 +1,24 @@
+# Athenian::JIRAPriority
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the priority. |  |
+| **image** | **String** | URL of the picture that indicates the priority. |  |
+| **rank** | **Integer** | Measure of importance (smaller is more important). |  |
+| **color** | **String** | RGB 24-bit color in hex. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAPriority.new(
+  name: null,
+  image: null,
+  rank: null,
+  color: null
+)
+```
+

data/docs/JIRAProject.md

@@ -0,0 +1,30 @@
+# Athenian::JIRAProject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Long name of the project. |  |
+| **key** | **String** | Short prefix of the project. |  |
+| **id** | **String** | Internal project identifier that corresponds to `project` in `/filter/jira`. Note: this is a string even though this looks like an integer. That's what JIRA API sends us.  |  |
+| **avatar_url** | **String** | Avatar URL of the project. |  |
+| **enabled** | **Boolean** | Indicates whether this project is enabled for analysis. |  |
+| **issues_count** | **Integer** | Total number of issues in the project. |  |
+| **last_update** | **Time** | Timestamp of the last event in the project. Can be `null` if there are no issues.  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAProject.new(
+  name: null,
+  key: null,
+  id: null,
+  avatar_url: null,
+  enabled: null,
+  issues_count: null,
+  last_update: null
+)
+```
+

data/docs/JIRAProjectsRequest.md

@@ -0,0 +1,20 @@
+# Athenian::JIRAProjectsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account ID. |  |
+| **projects** | **Hash<String, Boolean>** | Map from project keys to their enabled/disabled flags. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAProjectsRequest.new(
+  account: null,
+  projects: null
+)
+```
+

data/docs/JIRAStatus.md

@@ -0,0 +1,22 @@
+# Athenian::JIRAStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Exact status name. |  |
+| **stage** | [**JIRAStatusCategory**](JIRAStatusCategory.md) |  |  |
+| **project** | **String** | Identifier of the project where this status exists. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAStatus.new(
+  name: null,
+  stage: null,
+  project: null
+)
+```
+

data/docs/JIRAStatusCategory.md

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

data/docs/JIRAUser.md

@@ -0,0 +1,24 @@
+# Athenian::JIRAUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Full name of the user. |  |
+| **avatar** | **String** | User's profile picture URL. |  |
+| **type** | **String** | * `atlassian` indicates a regular account backed by a human. * `app` indicates a service account. * `customer` indicates an external service desk account. |  |
+| **developer** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAUser.new(
+  name: null,
+  avatar: null,
+  type: null,
+  developer: null
+)
+```
+

data/docs/LinkedJIRAIssue.md

@@ -0,0 +1,26 @@
+# Athenian::LinkedJIRAIssue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | JIRA issue key `PROJECT-###`. |  |
+| **title** | **String** | Title of this issue. |  |
+| **epic** | **String** | Identifier of the epic that owns this issue. | [optional] |
+| **labels** | **Array<String>** | List of JIRA labels in this issue. | [optional] |
+| **type** | **String** | Type of this issue. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::LinkedJIRAIssue.new(
+  id: null,
+  title: null,
+  epic: null,
+  labels: null,
+  type: null
+)
+```
+

data/docs/ListedToken.md

@@ -0,0 +1,22 @@
+# Athenian::ListedToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Token identifier - can be used in `/token/{id}` DELETE. |  |
+| **name** | **String** | Name of the token (see `/token/create`). |  |
+| **last_used** | **Time** | When this token was used last time. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::ListedToken.new(
+  id: null,
+  name: null,
+  last_used: null
+)
+```
+

data/docs/LogicalDeploymentRules.md

@@ -0,0 +1,20 @@
+# Athenian::LogicalDeploymentRules
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Regular expression to match the deployment name. It must be a match starting from the start of the string.  | [optional] |
+| **labels_include** | **Hash<String, Array<String>>** | Match deployments labeled by any key and having at least one value in the list.  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::LogicalDeploymentRules.new(
+  title: .*[Aa]lpha,
+  labels_include: null
+)
+```
+

data/docs/LogicalPRRules.md

@@ -0,0 +1,20 @@
+# Athenian::LogicalPRRules
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Regular expression to match the PR title. It must be a match starting from the start of the string.  | [optional] |
+| **labels_include** | **Array<String>** | Any matching label puts the PR into the logical repository. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::LogicalPRRules.new(
+  title: .*[Cc]omponent [Aa]lpha,
+  labels_include: null
+)
+```
+

data/docs/LogicalRepository.md

@@ -0,0 +1,26 @@
+# Athenian::LogicalRepository
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The logical part of the repository name. Compared to GitHub repository name requirements, we additionally allow / to express the hierarchy further.  |  |
+| **parent** | **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.  |  |
+| **prs** | [**LogicalPRRules**](LogicalPRRules.md) |  |  |
+| **releases** | [**ReleaseMatchSetting**](ReleaseMatchSetting.md) |  |  |
+| **deployments** | [**LogicalDeploymentRules**](LogicalDeploymentRules.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::LogicalRepository.new(
+  name: null,
+  parent: github.com/athenianco/athenian-webapp,
+  prs: null,
+  releases: null,
+  deployments: null
+)
+```
+

data/docs/LogicalRepositoryGetRequest.md

@@ -0,0 +1,20 @@
+# Athenian::LogicalRepositoryGetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account ID. |  |
+| **name** | **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::LogicalRepositoryGetRequest.new(
+  account: null,
+  name: github.com/athenianco/athenian-webapp
+)
+```
+

data/docs/LogicalRepositoryRequest.md

@@ -0,0 +1,28 @@
+# Athenian::LogicalRepositoryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account ID. |  |
+| **name** | **String** | The logical part of the repository name. Compared to GitHub repository name requirements, we additionally allow / to express the hierarchy further.  |  |
+| **parent** | **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.  |  |
+| **prs** | [**LogicalPRRules**](LogicalPRRules.md) |  |  |
+| **releases** | [**ReleaseMatchSetting**](ReleaseMatchSetting.md) |  |  |
+| **deployments** | [**LogicalDeploymentRules**](LogicalDeploymentRules.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::LogicalRepositoryRequest.new(
+  account: null,
+  name: null,
+  parent: github.com/athenianco/athenian-webapp,
+  prs: null,
+  releases: null,
+  deployments: null
+)
+```
+

data/docs/MappedJIRAIdentity.md

@@ -0,0 +1,24 @@
+# Athenian::MappedJIRAIdentity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **developer_id** | [**ReleasedPullRequestAuthor**](ReleasedPullRequestAuthor.md) |  |  |
+| **developer_name** | **String** | Full name of the mapped GitHub user. |  |
+| **jira_name** | **String** | Full name of the mapped JIRA user. |  |
+| **confidence** | **Float** | Value from 0 to 1 indicating how similar are the users. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::MappedJIRAIdentity.new(
+  developer_id: null,
+  developer_name: null,
+  jira_name: null,
+  confidence: null
+)
+```
+

data/docs/MappedJIRAIdentityChange.md

@@ -0,0 +1,20 @@
+# Athenian::MappedJIRAIdentityChange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **developer_id** | **String** | User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part.  |  |
+| **jira_name** | **String** | Full name of the mapped JIRA user. `null` means the removal. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::MappedJIRAIdentityChange.new(
+  developer_id: github.com/vmarkovtsev,
+  jira_name: null
+)
+```
+

data/docs/MatchIdentitiesRequest.md

@@ -0,0 +1,20 @@
+# Athenian::MatchIdentitiesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | User's account ID. |  |
+| **identities** | [**Array<ContributorIdentity>**](ContributorIdentity.md) |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::MatchIdentitiesRequest.new(
+  account: null,
+  identities: null
+)
+```
+

data/docs/MatchedIdentity.md

@@ -0,0 +1,22 @@
+# Athenian::MatchedIdentity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | [**ContributorIdentity**](ContributorIdentity.md) |  |  |
+| **to** | [**MatchedIdentityTo**](MatchedIdentityTo.md) |  |  |
+| **confidence** | **Float** | Value from 0 to 1 indicating how similar are the users. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::MatchedIdentity.new(
+  from: null,
+  to: null,
+  confidence: null
+)
+```
+

data/docs/MatchedIdentityTo.md

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