athenian 2.1.81

data/docs/IntegrationsApi.md

@@ -0,0 +1,157 @@
+# Athenian::IntegrationsApi
+
+All URIs are relative to *https://api.athenian.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_everything**](IntegrationsApi.md#get_everything) | **GET** /get/export | Download all the data collected by Athenian for custom analysis. |
+| [**match_identities**](IntegrationsApi.md#match_identities) | **POST** /match/identities | Match provided people names/logins/emails to the account's GitHub organization members. |
+
+
+## get_everything
+
+> File get_everything(opts)
+
+Download all the data collected by Athenian for custom analysis.
+
+### 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::IntegrationsApi.new
+opts = {
+  account: 56, # Integer | Numeric identifier of the account. Raises HTTP 400 if the user belongs to more than one account.
+  format: 'parquet' # String | Output file format. The default is `parquet`.
+}
+
+begin
+  # Download all the data collected by Athenian for custom analysis.
+  result = api_instance.get_everything(opts)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling IntegrationsApi->get_everything: #{e}"
+end
+```
+
+#### Using the get_everything_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_everything_with_http_info(opts)
+
+```ruby
+begin
+  # Download all the data collected by Athenian for custom analysis.
+  data, status_code, headers = api_instance.get_everything_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Athenian::ApiError => e
+  puts "Error when calling IntegrationsApi->get_everything_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Numeric identifier of the account. Raises HTTP 400 if the user belongs to more than one account. | [optional] |
+| **format** | **String** | Output file format. The default is &#x60;parquet&#x60;. | [optional] |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/zip, application/json
+
+
+## match_identities
+
+> <Array<MatchedIdentity>> match_identities(body)
+
+Match provided people names/logins/emails to the account's GitHub organization members.
+
+### 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::IntegrationsApi.new
+body = Athenian::MatchIdentitiesRequest.new({account: 37, identities: [Athenian::ContributorIdentity.new]}) # MatchIdentitiesRequest | 
+
+begin
+  # Match provided people names/logins/emails to the account's GitHub organization members.
+  result = api_instance.match_identities(body)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling IntegrationsApi->match_identities: #{e}"
+end
+```
+
+#### Using the match_identities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<MatchedIdentity>>, Integer, Hash)> match_identities_with_http_info(body)
+
+```ruby
+begin
+  # Match provided people names/logins/emails to the account's GitHub organization members.
+  data, status_code, headers = api_instance.match_identities_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<MatchedIdentity>>
+rescue Athenian::ApiError => e
+  puts "Error when calling IntegrationsApi->match_identities_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**MatchIdentitiesRequest**](MatchIdentitiesRequest.md) |  |  |
+
+### Return type
+
+[**Array&lt;MatchedIdentity&gt;**](MatchedIdentity.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Interquartile.md

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

data/docs/InvalidRequestError.md

@@ -0,0 +1,28 @@
+# Athenian::InvalidRequestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | **String** | Human-readable explanation specific to this occurrence of the problem. | [optional] |
+| **instance** | **String** | URI reference that identifies the specific occurrence of the problem. It is `null` for 4xx, Sentry event ID for 5xx. | [optional] |
+| **status** | **Integer** | Duplicated HTTP status code. |  |
+| **title** | **String** | Short, human-readable summary of the problem type. |  |
+| **type** | **String** | URI reference that identifies the problem type (RFC 7807). |  |
+| **pointer** | **String** | Path to the offending request item. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::InvalidRequestError.new(
+  detail: Unsupported metric: pr-xxx-time,
+  instance: 2763c4eabd7240f59829ee1a02546293,
+  status: 400,
+  title: Bad request syntax or unsupported method.,
+  type: /errors/InvalidRequestError,
+  pointer: .granularity
+)
+```
+

data/docs/InvalidRequestErrorAllOf.md

@@ -0,0 +1,18 @@
+# Athenian::InvalidRequestErrorAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pointer** | **String** | Path to the offending request item. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::InvalidRequestErrorAllOf.new(
+  pointer: .granularity
+)
+```
+

data/docs/InvitationCheckResult.md

@@ -0,0 +1,22 @@
+# Athenian::InvitationCheckResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | **Boolean** | Value indicating whether the invitation is still enabled. | [optional] |
+| **type** | **String** | Invited user's account membership status. | [optional] |
+| **valid** | **Boolean** | Value indicating whether the invitation URL is correctly formed. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::InvitationCheckResult.new(
+  active: null,
+  type: null,
+  valid: null
+)
+```
+

data/docs/InvitationLink.md

@@ -0,0 +1,18 @@
+# Athenian::InvitationLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Invitation URL. Users are supposed to click it and become admins or regular account members. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::InvitationLink.new(
+  url: null
+)
+```
+

data/docs/InvitedUser.md

@@ -0,0 +1,20 @@
+# Athenian::InvitedUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Joined account ID. |  |
+| **user** | [**User**](User.md) |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::InvitedUser.new(
+  account: null,
+  user: null
+)
+```
+

data/docs/JIRAComment.md

@@ -0,0 +1,22 @@
+# Athenian::JIRAComment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **author** | **String** | The name of the user who created the comment. |  |
+| **created** | **Time** | The date and time at which the comment was created. |  |
+| **rendered_body** | **String** | The comment text. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAComment.new(
+  author: null,
+  created: null,
+  rendered_body: null
+)
+```
+

data/docs/JIRAEpic.md

@@ -0,0 +1,58 @@
+# Athenian::JIRAEpic
+
+## 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 epic exists. |  |
+| **children** | [**Array<JIRAEpicChild>**](JIRAEpicChild.md) | Details about the child issues. | [optional] |
+| **prs** | **Integer** | Overall number of mapped pull requests (including the children). |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAEpic.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,
+  children: null,
+  prs: null
+)
+```
+

data/docs/JIRAEpicAllOf.md

@@ -0,0 +1,22 @@
+# Athenian::JIRAEpicAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **project** | **String** | Identifier of the project where this epic exists. |  |
+| **children** | [**Array<JIRAEpicChild>**](JIRAEpicChild.md) | Details about the child issues. | [optional] |
+| **prs** | **Integer** | Overall number of mapped pull requests (including the children). |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAEpicAllOf.new(
+  project: null,
+  children: null,
+  prs: null
+)
+```
+

data/docs/JIRAEpicChild.md

@@ -0,0 +1,56 @@
+# Athenian::JIRAEpicChild
+
+## 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. |  |
+| **subtasks** | **Integer** | Number of sub-tasks. |  |
+| **prs** | **Integer** | Number of mapped pull requests. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAEpicChild.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,
+  subtasks: null,
+  prs: null
+)
+```
+

data/docs/JIRAEpicChildAllOf.md

@@ -0,0 +1,20 @@
+# Athenian::JIRAEpicChildAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subtasks** | **Integer** | Number of sub-tasks. |  |
+| **prs** | **Integer** | Number of mapped pull requests. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAEpicChildAllOf.new(
+  subtasks: null,
+  prs: null
+)
+```
+

data/docs/JIRAEpicIssueCommon.md

@@ -0,0 +1,52 @@
+# Athenian::JIRAEpicIssueCommon
+
+## 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. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAEpicIssueCommon.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
+)
+```
+

data/docs/JIRAFilter.md

@@ -0,0 +1,32 @@
+# Athenian::JIRAFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **epics** | **Array<String>** | JIRA issues must be included in the epics from the list. | [optional] |
+| **labels_include** | **Array<String>** | Only issues having at least one label from the list will be included Several labels may be concatenated by a comma `,` so that all of them are required.  | [optional] |
+| **labels_exclude** | **Array<String>** | Issues having one label from the list will be excluded. | [optional] |
+| **issue_types** | **Array<String>** | Issues must have one of the given types, e.g. Bug, Task, Design Document, etc.  | [optional] |
+| **priorities** | **Array<String>** | Issues must have a priority from the given list. | [optional] |
+| **projects** | **Array<String>** | Issues must be contained in a project in the given project keys list. | [optional] |
+| **status_categories** | [**Array<JIRAStatusCategory>**](JIRAStatusCategory.md) | The JIRA issues must have a status belonging to one of these categories. | [optional] |
+| **unmapped** | **Boolean** | Select PRs that are not mapped to any JIRA issue. May not be specified with anything else. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAFilter.new(
+  epics: null,
+  labels_include: null,
+  labels_exclude: null,
+  issue_types: null,
+  priorities: null,
+  projects: null,
+  status_categories: null,
+  unmapped: null
+)
+```
+

data/docs/JIRAFilterReturn.md

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

data/docs/JIRAFilterWith.md

@@ -0,0 +1,22 @@
+# Athenian::JIRAFilterWith
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assignees** | **Array<String>** | Selected issue assignee users. `null` means unassigned. | [optional] |
+| **reporters** | **Array<String>** | Selected issue reporter users. | [optional] |
+| **commenters** | **Array<String>** | Selected issue commenter users. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAFilterWith.new(
+  assignees: null,
+  reporters: null,
+  commenters: null
+)
+```
+

data/docs/JIRAHistogramDefinition.md

@@ -0,0 +1,24 @@
+# Athenian::JIRAHistogramDefinition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metric** | [**JIRAMetricID**](JIRAMetricID.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::JIRAHistogramDefinition.new(
+  metric: null,
+  scale: null,
+  bins: null,
+  ticks: null
+)
+```
+

data/docs/JIRAHistogramsRequest.md

@@ -0,0 +1,44 @@
+# Athenian::JIRAHistogramsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **priorities** | **Array<String>** | Selected issue priorities. | [optional] |
+| **types** | **Array<String>** | Selected issue types. | [optional] |
+| **epics** | [**Array<JIRAEpic>**](JIRAEpic.md) |  | [optional] |
+| **labels_include** | **Array<String>** | PRs must relate to at least one JIRA issue label from the list. Several labels may be concatenated by a comma `,` so that all of them are required. | [optional] |
+| **labels_exclude** | **Array<String>** | PRs cannot relate to JIRA issue labels from the list. | [optional] |
+| **with** | [**Array<JIRAFilterWith>**](JIRAFilterWith.md) | Groups of issue participants. The histograms will be calculated for each group. | [optional] |
+| **projects** | **Array<String>** | Issues must belong to these JIRA projects. | [optional] |
+| **histograms** | [**Array<JIRAHistogramDefinition>**](JIRAHistogramDefinition.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 issues with the last update older than `date_from` should 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. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::JIRAHistogramsRequest.new(
+  priorities: null,
+  types: null,
+  epics: null,
+  labels_include: null,
+  labels_exclude: null,
+  with: null,
+  projects: null,
+  histograms: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  exclude_inactive: null,
+  quantiles: [0,0.95],
+  account: null
+)
+```
+