athenian 2.1.81

data/docs/RegistrationApi.md

@@ -0,0 +1,420 @@
+# Athenian::RegistrationApi
+
+All URIs are relative to *https://api.athenian.co/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**accept_invitation**](RegistrationApi.md#accept_invitation) | **PUT** /invite/accept | 👤 Accept the account membership invitation and finish registration. The user must be already authorized in Auth0. |
+| [**check_invitation**](RegistrationApi.md#check_invitation) | **POST** /invite/check | Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled. |
+| [**eval_jira_progress**](RegistrationApi.md#eval_jira_progress) | **GET** /invite/jira_progress/{id} | Return the current JIRA installation progress in Athenian. |
+| [**eval_metadata_progress**](RegistrationApi.md#eval_metadata_progress) | **GET** /invite/progress/{id} | Return the current GitHub installation progress in Athenian. |
+| [**gen_jira_link**](RegistrationApi.md#gen_jira_link) | **GET** /invite/jira/{id} | 👤 Generate a JIRA integration installation link. The caller must be an admin of the specified account. |
+| [**gen_user_invitation**](RegistrationApi.md#gen_user_invitation) | **GET** /invite/generate/{id} | 👤 Create an account invitation link for regular users. The caller must be an admin of the specified account. The link is persistent, so multiple calls return the same result.  |
+
+
+## accept_invitation
+
+> <InvitedUser> accept_invitation(body)
+
+👤 Accept the account membership invitation and finish registration. The user must be already authorized in Auth0.
+
+### Examples
+
+```ruby
+require 'time'
+require 'athenian'
+# setup authorization
+Athenian.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Athenian::RegistrationApi.new
+body = Athenian::AcceptedInvitation.new({url: 'url_example'}) # AcceptedInvitation | Accepted invitation details.
+
+begin
+  # 👤 Accept the account membership invitation and finish registration. The user must be already authorized in Auth0.
+  result = api_instance.accept_invitation(body)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->accept_invitation: #{e}"
+end
+```
+
+#### Using the accept_invitation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvitedUser>, Integer, Hash)> accept_invitation_with_http_info(body)
+
+```ruby
+begin
+  # 👤 Accept the account membership invitation and finish registration. The user must be already authorized in Auth0.
+  data, status_code, headers = api_instance.accept_invitation_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvitedUser>
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->accept_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**AcceptedInvitation**](AcceptedInvitation.md) | Accepted invitation details. |  |
+
+### Return type
+
+[**InvitedUser**](InvitedUser.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## check_invitation
+
+> <InvitationCheckResult> check_invitation(body)
+
+Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.
+
+### Examples
+
+```ruby
+require 'time'
+require 'athenian'
+
+api_instance = Athenian::RegistrationApi.new
+body = Athenian::InvitationLink.new({url: 'url_example'}) # InvitationLink | Checked invitation details.
+
+begin
+  # Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.
+  result = api_instance.check_invitation(body)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->check_invitation: #{e}"
+end
+```
+
+#### Using the check_invitation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvitationCheckResult>, Integer, Hash)> check_invitation_with_http_info(body)
+
+```ruby
+begin
+  # Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.
+  data, status_code, headers = api_instance.check_invitation_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvitationCheckResult>
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->check_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**InvitationLink**](InvitationLink.md) | Checked invitation details. |  |
+
+### Return type
+
+[**InvitationCheckResult**](InvitationCheckResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## eval_jira_progress
+
+> <InstallationProgress> eval_jira_progress(id)
+
+Return the current JIRA installation progress in Athenian.
+
+### 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::RegistrationApi.new
+id = 56 # Integer | Numeric identifier of the account that is installing JIRA.
+
+begin
+  # Return the current JIRA installation progress in Athenian.
+  result = api_instance.eval_jira_progress(id)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->eval_jira_progress: #{e}"
+end
+```
+
+#### Using the eval_jira_progress_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InstallationProgress>, Integer, Hash)> eval_jira_progress_with_http_info(id)
+
+```ruby
+begin
+  # Return the current JIRA installation progress in Athenian.
+  data, status_code, headers = api_instance.eval_jira_progress_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InstallationProgress>
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->eval_jira_progress_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Numeric identifier of the account that is installing JIRA. |  |
+
+### Return type
+
+[**InstallationProgress**](InstallationProgress.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## eval_metadata_progress
+
+> <InstallationProgress> eval_metadata_progress(id)
+
+Return the current GitHub installation progress in Athenian.
+
+### 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::RegistrationApi.new
+id = 56 # Integer | Numeric identifier of the account that is installing GitHub.
+
+begin
+  # Return the current GitHub installation progress in Athenian.
+  result = api_instance.eval_metadata_progress(id)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->eval_metadata_progress: #{e}"
+end
+```
+
+#### Using the eval_metadata_progress_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InstallationProgress>, Integer, Hash)> eval_metadata_progress_with_http_info(id)
+
+```ruby
+begin
+  # Return the current GitHub installation progress in Athenian.
+  data, status_code, headers = api_instance.eval_metadata_progress_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InstallationProgress>
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->eval_metadata_progress_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Numeric identifier of the account that is installing GitHub. |  |
+
+### Return type
+
+[**InstallationProgress**](InstallationProgress.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## gen_jira_link
+
+> <InvitationLink> gen_jira_link(id)
+
+👤 Generate a JIRA integration installation link. The caller must be an admin of the specified account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'athenian'
+# setup authorization
+Athenian.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Athenian::RegistrationApi.new
+id = 56 # Integer | Numeric identifier of the account who is installing JIRA integration.
+
+begin
+  # 👤 Generate a JIRA integration installation link. The caller must be an admin of the specified account.
+  result = api_instance.gen_jira_link(id)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->gen_jira_link: #{e}"
+end
+```
+
+#### Using the gen_jira_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvitationLink>, Integer, Hash)> gen_jira_link_with_http_info(id)
+
+```ruby
+begin
+  # 👤 Generate a JIRA integration installation link. The caller must be an admin of the specified account.
+  data, status_code, headers = api_instance.gen_jira_link_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvitationLink>
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->gen_jira_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Numeric identifier of the account who is installing JIRA integration. |  |
+
+### Return type
+
+[**InvitationLink**](InvitationLink.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## gen_user_invitation
+
+> <InvitationLink> gen_user_invitation(id)
+
+👤 Create an account invitation link for regular users. The caller must be an admin of the specified account. The link is persistent, so multiple calls return the same result. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'athenian'
+# setup authorization
+Athenian.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Athenian::RegistrationApi.new
+id = 56 # Integer | Numeric identifier of the account where to invite new users.
+
+begin
+  # 👤 Create an account invitation link for regular users. The caller must be an admin of the specified account. The link is persistent, so multiple calls return the same result. 
+  result = api_instance.gen_user_invitation(id)
+  p result
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->gen_user_invitation: #{e}"
+end
+```
+
+#### Using the gen_user_invitation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InvitationLink>, Integer, Hash)> gen_user_invitation_with_http_info(id)
+
+```ruby
+begin
+  # 👤 Create an account invitation link for regular users. The caller must be an admin of the specified account. The link is persistent, so multiple calls return the same result. 
+  data, status_code, headers = api_instance.gen_user_invitation_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InvitationLink>
+rescue Athenian::ApiError => e
+  puts "Error when calling RegistrationApi->gen_user_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Numeric identifier of the account where to invite new users. |  |
+
+### Return type
+
+[**InvitationLink**](InvitationLink.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ReleaseDiff.md

@@ -0,0 +1,22 @@
+# Athenian::ReleaseDiff
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **old** | **String** |  |  |
+| **new** | **String** |  |  |
+| **releases** | [**Array<FilteredRelease>**](FilteredRelease.md) | List of matching release metadata. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::ReleaseDiff.new(
+  old: null,
+  new: null,
+  releases: null
+)
+```
+

data/docs/ReleaseMatchRequest.md

@@ -0,0 +1,28 @@
+# Athenian::ReleaseMatchRequest
+
+## 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. |  |
+| **branches** | **String** | Regular expression to match branch names. The match starts from the beginning of the string. Special value `{{default}}` matches to the default branch name - usually, `main` or `master`. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP  | [optional] |
+| **tags** | **String** | Regular expression to match tag names. The match starts from the beginning of the string. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP  | [optional] |
+| **events** | **String** | Regular expression to match event releases (submitted by the user via `/events/releases`). The match starts from the beginning of the string. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP  | [optional] |
+| **match** | [**ReleaseMatchStrategy**](ReleaseMatchStrategy.md) |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::ReleaseMatchRequest.new(
+  account: null,
+  repositories: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  branches: .*-production,
+  tags: .*,
+  events: null,
+  match: null
+)
+```
+

data/docs/ReleaseMatchSetting.md

@@ -0,0 +1,26 @@
+# Athenian::ReleaseMatchSetting
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **branches** | **String** | Regular expression to match branch names. The match starts from the beginning of the string. Special value `{{default}}` matches to the default branch name - usually, `main` or `master`. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP  |  |
+| **tags** | **String** | Regular expression to match tag names. The match starts from the beginning of the string. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP  |  |
+| **events** | **String** | Regular expression to match event releases (submitted by the user via `/events/releases`). The match starts from the beginning of the string. Reference: https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-SIMILARTO-REGEXP  | [optional] |
+| **match** | [**ReleaseMatchStrategy**](ReleaseMatchStrategy.md) |  |  |
+| **default_branch** | **String** | Name of the default branch of this repository. Returned in responses and ignored in requests.  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::ReleaseMatchSetting.new(
+  branches: .*-production,
+  tags: .*,
+  events: null,
+  match: null,
+  default_branch: null
+)
+```
+

data/docs/ReleaseMatchStrategy.md

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

data/docs/ReleaseMetricID.md

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

data/docs/ReleaseMetricsRequest.md

@@ -0,0 +1,42 @@
+# Athenian::ReleaseMetricsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_for** | [**Array<ReleaseMetricsRequestForInner>**](ReleaseMetricsRequestForInner.md) | List of repository groups for which to calculate the metrics. An empty repository (empty array) group will match nothing. Use `null` as repository group to match every repository.  |  |
+| **with** | [**Array<ReleaseWith>**](ReleaseWith.md) | List of developer groups for which to calculate the metrics. | [optional] |
+| **labels_include** | **Array<String>** | At least one of these labels must be present in at least one released PR. | [optional] |
+| **labels_exclude** | **Array<String>** | None of these labels must be present in each released PR. | [optional] |
+| **jira** | [**JIRAFilter**](JIRAFilter.md) |  | [optional] |
+| **jiragroups** | [**Array<JIRAFilter>**](JIRAFilter.md) | Calculate metrics separately for each JIRA Filter in the list. Not compatible with `jira` field.  | [optional] |
+| **metrics** | [**Array<ReleaseMetricID>**](ReleaseMetricID.md) | List of desired release metrics. |  |
+| **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::ReleaseMetricsRequest.new(
+  _for: null,
+  with: null,
+  labels_include: null,
+  labels_exclude: null,
+  jira: null,
+  jiragroups: null,
+  metrics: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  granularities: null,
+  quantiles: [0,0.95],
+  account: null
+)
+```
+

data/docs/ReleaseMetricsRequestForInner.md

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

data/docs/ReleaseNames.md

@@ -0,0 +1,20 @@
+# Athenian::ReleaseNames
+
+## 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.  |  |
+| **names** | **Array<String>** | List of release names. For tag releases, those are the tag names. For branch releases, those are commit hashes. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::ReleaseNames.new(
+  repository: github.com/athenianco/athenian-webapp,
+  names: null
+)
+```
+

data/docs/ReleaseNotification.md

@@ -0,0 +1,28 @@
+# Athenian::ReleaseNotification
+
+## 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.  |  |
+| **commit** | **String** | Commit hash, either short (7 chars) or long (40 chars) form. |  |
+| **name** | **String** | Release name. The value may not contain \\n - new line character, and ' - single quote.  | [optional] |
+| **author** | **String** | Release author. | [optional] |
+| **url** | **String** | Release URL. | [optional] |
+| **published_at** | **Time** | When the release was created. If missing, set to `now()`. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::ReleaseNotification.new(
+  repository: github.com/athenianco/athenian-webapp,
+  commit: null,
+  name: null,
+  author: null,
+  url: null,
+  published_at: null
+)
+```
+

data/docs/ReleaseNotificationStatus.md

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