athenian 2.1.81

data/docs/FilterCodeChecksRequest.md

@@ -0,0 +1,36 @@
+# Athenian::FilterCodeChecksRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. |  |
+| **triggered_by** | **Array<String>** | Check runs must be triggered by commits pushed by these people. When it is impossible to determine who pushed, e.g. in legacy API based checks, they are committers. It is possible to mention whole teams using the syntax `{id}` where `id` is a team identifier (see `/teams`).  | [optional] |
+| **labels_include** | **Array<String>** | At least one of these labels must be present in the checked PRs. | [optional] |
+| **labels_exclude** | **Array<String>** | None of these labels must be present in each checked PR. | [optional] |
+| **jira** | [**ForSetCodeChecksJira**](ForSetCodeChecksJira.md) |  | [optional] |
+| **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. |  |
+| **quantiles** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterCodeChecksRequest.new(
+  _in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  triggered_by: ["github.com/vmarkovtsev","github.com/se7entyse7en"],
+  labels_include: null,
+  labels_exclude: null,
+  jira: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  account: null,
+  quantiles: null
+)
+```
+

data/docs/FilterCommitsRequest.md

@@ -0,0 +1,34 @@
+# Athenian::FilterCommitsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **date_from** | **Date** | Commits must be made later than or equal to this date. |  |
+| **date_to** | **Date** | Commits must be made earlier than or equal to this date. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. |  |
+| **with_author** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **with_committer** | **Array<String>** | A set of developers. An empty list disables the filter and includes everybody. Duplicates are automatically ignored. | [optional] |
+| **property** | **String** | Main trait of the commits - the core of the filter. * bypassing_prs: select commits that were pushed without creating a PR * everything: select all the commits matched by the filters * no_pr_merges: select all the commits but PR merges by noreply@github.com |  |
+| **only_default_branch** | **Boolean** | Consider only commits that are accessible from the head of the default branch. For example, if your workflow includes PR-ing feature branches, you rebase and merge them and don't delete afterward, `bypassing_prs` will report the commits in those feature branches unless you set `only_default_branch` to `true`. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterCommitsRequest.new(
+  account: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  _in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  with_author: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  with_committer: ["github.com/vmarkovtsev","github.com/dpordomingo"],
+  property: null,
+  only_default_branch: null
+)
+```
+

data/docs/FilterContributorsRequest.md

@@ -0,0 +1,28 @@
+# Athenian::FilterContributorsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **date_from** | **Date** | Updates must be later than or equal to this date. An update is any action that influences the stage assignment. |  |
+| **date_to** | **Date** | Updates must be earlier than or equal to this date. An update is any action that influences the stage assignment. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
+| **as** | **Array<String>** | Filter by contribution type. A `null` or an empty list select all. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterContributorsRequest.new(
+  account: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  _in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  as: null
+)
+```
+

data/docs/FilterDeploymentsRequest.md

@@ -0,0 +1,42 @@
+# Athenian::FilterDeploymentsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_from** | **Date** | Search for the deployments since this date. |  |
+| **date_to** | **Date** | Search for the deployments until this date. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **account** | **Integer** | Session account ID. |  |
+| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
+| **with** | [**DeploymentWith**](DeploymentWith.md) |  | [optional] |
+| **pr_labels_include** | **Array<String>** | At least one of these labels must be present in at least one deployed PR. | [optional] |
+| **pr_labels_exclude** | **Array<String>** | None of these labels must be present in each deployed PR. | [optional] |
+| **jira** | [**JIRAFilter**](JIRAFilter.md) |  | [optional] |
+| **environments** | **Array<String>** | Deployments must belong to one of these environments. | [optional] |
+| **conclusions** | [**Array<DeploymentConclusion>**](DeploymentConclusion.md) | Deployments must execute with any of these conclusions. | [optional] |
+| **with_labels** | **Object** | Deployments should contain at least one of the specified label values. `null` matches any label value and effectively checks the label existence. | [optional] |
+| **without_labels** | **Object** | Deployments may not contain the specified label values. `null` matches any label value and effectively ensures that the label does not exist. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterDeploymentsRequest.new(
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  account: null,
+  _in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  with: null,
+  pr_labels_include: null,
+  pr_labels_exclude: null,
+  jira: null,
+  environments: null,
+  conclusions: null,
+  with_labels: null,
+  without_labels: null
+)
+```
+

data/docs/FilterEnvironmentsRequest.md

@@ -0,0 +1,26 @@
+# Athenian::FilterEnvironmentsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Account ID. |  |
+| **repositories** | **Array** |  | [optional] |
+| **date_from** | **Date** | Date from when to start looking for deployments. |  |
+| **date_to** | **Date** | Date until which to look for deployments. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterEnvironmentsRequest.new(
+  account: null,
+  repositories: null,
+  date_from: null,
+  date_to: null,
+  timezone: null
+)
+```
+

data/docs/FilterJIRACommon.md

@@ -0,0 +1,30 @@
+# Athenian::FilterJIRACommon
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **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. Ignored for epics. | [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. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterJIRACommon.new(
+  account: null,
+  timezone: null,
+  priorities: null,
+  types: null,
+  labels_include: null,
+  labels_exclude: null,
+  exclude_inactive: null
+)
+```
+

data/docs/FilterJIRAStuff.md

@@ -0,0 +1,40 @@
+# Athenian::FilterJIRAStuff
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **date_from** | **Date** | `null` disables the time filter boundary, thus everything is returned. `date_from` and `date_to` must be both either `null` or not `null`. |  |
+| **date_to** | **Date** | `null` disables the time filter boundary, thus everything is returned. `date_from` and `date_to` must be both either `null` or not `null`. |  |
+| **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. Ignored for epics. | [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. |  |
+| **with** | [**FilterJIRAStuffWith**](FilterJIRAStuffWith.md) |  | [optional] |
+| **projects** | **Array<String>** | Issues must belong to these JIRA projects. | [optional] |
+| **_return** | [**Array<JIRAFilterReturn>**](JIRAFilterReturn.md) | Specifies which items are required, an empty or missing array means everything. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterJIRAStuff.new(
+  account: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  priorities: null,
+  types: null,
+  labels_include: null,
+  labels_exclude: null,
+  exclude_inactive: null,
+  with: null,
+  projects: null,
+  _return: null
+)
+```
+

data/docs/FilterJIRAStuffWith.md

@@ -0,0 +1,22 @@
+# Athenian::FilterJIRAStuffWith
+
+## 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::FilterJIRAStuffWith.new(
+  assignees: null,
+  reporters: null,
+  commenters: null
+)
+```
+

data/docs/FilterLabelsRequest.md

@@ -0,0 +1,20 @@
+# Athenian::FilterLabelsRequest
+
+## 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. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterLabelsRequest.new(
+  account: null,
+  repositories: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"]
+)
+```
+

data/docs/FilterPullRequestsRequest.md

@@ -0,0 +1,48 @@
+# Athenian::FilterPullRequestsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **date_from** | **Date** | PRs must be updated later than or equal to this date. |  |
+| **date_to** | **Date** | PRs must be updated earlier than or equal to this date. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. |  |
+| **events** | [**Array<PullRequestEvent>**](PullRequestEvent.md) | Allowed PR events that happened between `date_from` and `date_to`. | [optional] |
+| **stages** | [**Array<PullRequestStage>**](PullRequestStage.md) | Allowed PR stages that are defined at `date_to`. | [optional] |
+| **with** | [**PullRequestWith**](PullRequestWith.md) |  | [optional] |
+| **labels_include** | **Array<String>** | At least one of these labels must be present in each returned PR. | [optional] |
+| **labels_exclude** | **Array<String>** | None of these labels must be present in each returned PR. | [optional] |
+| **exclude_inactive** | **Boolean** | Value indicating whether PRs without events in the given time frame shall be ignored. |  |
+| **jira** | [**JIRAFilter**](JIRAFilter.md) |  | [optional] |
+| **updated_from** | **Date** | Paginate the response: the returned PRs are updated on GitHub no older than this timestamp, including the beginning. Note: \"updated on GitHub\" means that we don´t consider release or deployment timestamps. Use this field only to paginate after calling `/paginate/pull_requests`. Subject of future changes. | [optional] |
+| **updated_to** | **Date** | Paginate the response: the returned PRs are updated on GitHub no later than this timestamp, not including the ending. Note: \"updated on GitHub\" means that we don´t consider release or deployment timestamps. Use this field only to paginate after calling `/paginate/pull_requests`. Subject of future changes. | [optional] |
+| **limit** | **Integer** | Maximum number of pull requests to return. The list is sorted by the last update timestamp. `null` means no limit. | [optional] |
+| **environments** | **Array<String>** | Target environments for the deployment events, impacts `events` and `stages`. If omitted, we match any deployment in any environment. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterPullRequestsRequest.new(
+  account: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  _in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  events: null,
+  stages: null,
+  with: null,
+  labels_include: null,
+  labels_exclude: null,
+  exclude_inactive: null,
+  jira: null,
+  updated_from: null,
+  updated_to: null,
+  limit: null,
+  environments: null
+)
+```
+

data/docs/FilterReleasesRequest.md

@@ -0,0 +1,34 @@
+# Athenian::FilterReleasesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **date_from** | **Date** | Updates must be later than or equal to this date. An update is any action that influences the stage assignment. |  |
+| **date_to** | **Date** | Updates must be earlier than or equal to this date. An update is any action that influences the stage assignment. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
+| **with** | [**ReleaseWith**](ReleaseWith.md) |  | [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>** | PRs with these labels are excluded from `ReleaseSet.data.prs`. | [optional] |
+| **jira** | [**JIRAFilter**](JIRAFilter.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterReleasesRequest.new(
+  account: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  _in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  with: null,
+  labels_include: null,
+  labels_exclude: null,
+  jira: null
+)
+```
+

data/docs/FilterRepositoriesRequest.md

@@ -0,0 +1,28 @@
+# Athenian::FilterRepositoriesRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | **Integer** | Session account ID. |  |
+| **date_from** | **Date** | Updates must be later than or equal to this date. An update is any action that influences the stage assignment. |  |
+| **date_to** | **Date** | Updates must be earlier than or equal to this date. An update is any action that influences the stage assignment. |  |
+| **timezone** | **Integer** | Local time zone offset in minutes, used to adjust `date_from` and `date_to`. | [optional] |
+| **_in** | **Array<String>** | Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored. | [optional] |
+| **exclude_inactive** | **Boolean** | Value indicating whether PRs without events in the given time frame shall be ignored as repository triggers. | [optional] |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilterRepositoriesRequest.new(
+  account: null,
+  date_from: null,
+  date_to: null,
+  timezone: null,
+  _in: ["github.com/athenianco/athenian-webapp","github.com/athenianco/athenian-api"],
+  exclude_inactive: null
+)
+```
+

data/docs/FilteredCodeCheckRun.md

@@ -0,0 +1,30 @@
+# Athenian::FilteredCodeCheckRun
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | Unique name of the check run. |  |
+| **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.  |  |
+| **last_execution_time** | **Time** | Timestamp of when the check run launched the latest. |  |
+| **last_execution_url** | **String** | Link to the check run that launched the latest. | [optional] |
+| **total_stats** | [**FilteredCodeCheckRunTotalStats**](FilteredCodeCheckRunTotalStats.md) |  |  |
+| **prs_stats** | [**FilteredCodeCheckRunPrsStats**](FilteredCodeCheckRunPrsStats.md) |  |  |
+| **size_groups** | **Array<Integer>** | Check suite sizes this check run belongs to. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilteredCodeCheckRun.new(
+  title: null,
+  repository: github.com/athenianco/athenian-webapp,
+  last_execution_time: null,
+  last_execution_url: null,
+  total_stats: null,
+  prs_stats: null,
+  size_groups: null
+)
+```
+

data/docs/FilteredCodeCheckRunPrsStats.md

@@ -0,0 +1,40 @@
+# Athenian::FilteredCodeCheckRunPrsStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | Number of executions with respect to `date_from` and `date_to`. |  |
+| **successes** | **Integer** | Number of successful executions with respect to `date_from` and `date_to`. |  |
+| **critical** | **Boolean** | This code check dominated the overall check suite execution time at least once. |  |
+| **mean_execution_time** | [**CodeCheckRunStatisticsMeanExecutionTime**](CodeCheckRunStatisticsMeanExecutionTime.md) |  |  |
+| **stddev_execution_time** | [**CodeCheckRunStatisticsStddevExecutionTime**](CodeCheckRunStatisticsStddevExecutionTime.md) |  |  |
+| **median_execution_time** | [**CodeCheckRunStatisticsMedianExecutionTime**](CodeCheckRunStatisticsMedianExecutionTime.md) |  |  |
+| **skips** | **Integer** | Number of times this check run was skipped. |  |
+| **flaky_count** | **Integer** | Number of times this check run appeared flaky: it both failed and succeeded for the same commit. |  |
+| **count_timeline** | **Array<Integer>** | Number of executions through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+| **successes_timeline** | **Array<Integer>** | Number of successful executions through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+| **mean_execution_time_timeline** | **Array<String>** | Average elapsed execution time through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+| **median_execution_time_timeline** | **Array<String>** | Median elapsed execution time through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilteredCodeCheckRunPrsStats.new(
+  count: null,
+  successes: null,
+  critical: null,
+  mean_execution_time: null,
+  stddev_execution_time: null,
+  median_execution_time: null,
+  skips: null,
+  flaky_count: null,
+  count_timeline: null,
+  successes_timeline: null,
+  mean_execution_time_timeline: null,
+  median_execution_time_timeline: null
+)
+```
+

data/docs/FilteredCodeCheckRunTotalStats.md

@@ -0,0 +1,40 @@
+# Athenian::FilteredCodeCheckRunTotalStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **count** | **Integer** | Number of executions with respect to `date_from` and `date_to`. |  |
+| **successes** | **Integer** | Number of successful executions with respect to `date_from` and `date_to`. |  |
+| **critical** | **Boolean** | This code check dominated the overall check suite execution time at least once. |  |
+| **mean_execution_time** | [**CodeCheckRunStatisticsMeanExecutionTime**](CodeCheckRunStatisticsMeanExecutionTime.md) |  |  |
+| **stddev_execution_time** | [**CodeCheckRunStatisticsStddevExecutionTime**](CodeCheckRunStatisticsStddevExecutionTime.md) |  |  |
+| **median_execution_time** | [**CodeCheckRunStatisticsMedianExecutionTime**](CodeCheckRunStatisticsMedianExecutionTime.md) |  |  |
+| **skips** | **Integer** | Number of times this check run was skipped. |  |
+| **flaky_count** | **Integer** | Number of times this check run appeared flaky: it both failed and succeeded for the same commit. |  |
+| **count_timeline** | **Array<Integer>** | Number of executions through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+| **successes_timeline** | **Array<Integer>** | Number of successful executions through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+| **mean_execution_time_timeline** | **Array<String>** | Average elapsed execution time through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+| **median_execution_time_timeline** | **Array<String>** | Median elapsed execution time through time. The dates sequence is `FilteredCodeCheckRuns.timeline`. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilteredCodeCheckRunTotalStats.new(
+  count: null,
+  successes: null,
+  critical: null,
+  mean_execution_time: null,
+  stddev_execution_time: null,
+  median_execution_time: null,
+  skips: null,
+  flaky_count: null,
+  count_timeline: null,
+  successes_timeline: null,
+  mean_execution_time_timeline: null,
+  median_execution_time_timeline: null
+)
+```
+

data/docs/FilteredCodeCheckRuns.md

@@ -0,0 +1,20 @@
+# Athenian::FilteredCodeCheckRuns
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timeline** | **Array<Date>** | Sequence of dates from `date_from` till `date_to`. We choose the adaptive intervals by applying these rules on `(date_to - date_from)`: - Less than 5 weeks: daily. - Less than 5 months: weekly (*not aligned*). - Aligned monthly. |  |
+| **items** | [**Array<FilteredCodeCheckRun>**](FilteredCodeCheckRun.md) | Found check runs and their stats. |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilteredCodeCheckRuns.new(
+  timeline: null,
+  items: null
+)
+```
+

data/docs/FilteredDeployment.md

@@ -0,0 +1,38 @@
+# Athenian::FilteredDeployment
+
+## 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] |
+| **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::FilteredDeployment.new(
+  components: null,
+  environment: null,
+  name: null,
+  url: null,
+  date_started: null,
+  date_finished: null,
+  conclusion: null,
+  labels: null,
+  code: null,
+  prs: null,
+  releases: null
+)
+```
+

data/docs/FilteredDeployments.md

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

data/docs/FilteredDeploymentsInclude.md

@@ -0,0 +1,20 @@
+# Athenian::FilteredDeploymentsInclude
+
+## 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::FilteredDeploymentsInclude.new(
+  users: null,
+  jira: null
+)
+```
+

data/docs/FilteredEnvironment.md

@@ -0,0 +1,24 @@
+# Athenian::FilteredEnvironment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deployments_count** | **Integer** | Number of deployments (successful or not) in the specified time interval. |  |
+| **last_conclusion** | [**DeploymentConclusion**](DeploymentConclusion.md) |  |  |
+| **name** | **String** | Name of the environment. |  |
+| **repositories** | **Array** |  |  |
+
+## Example
+
+```ruby
+require 'athenian'
+
+instance = Athenian::FilteredEnvironment.new(
+  deployments_count: null,
+  last_conclusion: null,
+  name: null,
+  repositories: null
+)
+```
+