Module: Athenian

Defined in:
lib/athenian/version.rb,
lib/athenian.rb,
lib/athenian/api_error.rb,
lib/athenian/api_client.rb,
lib/athenian/api/get_api.rb,
lib/athenian/models/team.rb,
lib/athenian/models/user.rb,
lib/athenian/api/team_api.rb,
lib/athenian/api/user_api.rb,
lib/athenian/models/share.rb,
lib/athenian/api/align_api.rb,
lib/athenian/configuration.rb,
lib/athenian/models/commit.rb,
lib/athenian/api/events_api.rb,
lib/athenian/api/filter_api.rb,
lib/athenian/models/account.rb,
lib/athenian/api/metrics_api.rb,
lib/athenian/api/reposet_api.rb,
lib/athenian/api/version_api.rb,
lib/athenian/models/versions.rb,
lib/athenian/api/security_api.rb,
lib/athenian/api/settings_api.rb,
lib/athenian/models/jira_epic.rb,
lib/athenian/models/jira_user.rb,
lib/athenian/models/work_type.rb,
lib/athenian/models/datasource.rb,
lib/athenian/models/jira_issue.rb,
lib/athenian/models/jira_label.rb,
lib/athenian/api/histograms_api.rb,
lib/athenian/api/pagination_api.rb,
lib/athenian/models/code_filter.rb,
lib/athenian/models/contributor.rb,
lib/athenian/models/jira_filter.rb,
lib/athenian/models/jira_status.rb,
lib/athenian/models/release_set.rb,
lib/athenian/models/commits_list.rb,
lib/athenian/models/invited_user.rb,
lib/athenian/models/jira_comment.rb,
lib/athenian/models/jira_project.rb,
lib/athenian/models/listed_token.rb,
lib/athenian/models/organization.rb,
lib/athenian/models/pull_request.rb,
lib/athenian/models/release_diff.rb,
lib/athenian/models/release_pair.rb,
lib/athenian/models/release_with.rb,
lib/athenian/api/integrations_api.rb,
lib/athenian/api/registration_api.rb,
lib/athenian/models/created_token.rb,
lib/athenian/models/generic_error.rb,
lib/athenian/models/goal_template.rb,
lib/athenian/models/interquartile.rb,
lib/athenian/models/jira_priority.rb,
lib/athenian/models/release_names.rb,
lib/athenian/models/stage_timings.rb,
lib/athenian/models/account_status.rb,
lib/athenian/models/filtered_label.rb,
lib/athenian/models/jira_metric_id.rb,
lib/athenian/models/work_type_rule.rb,
lib/athenian/models/deployment_with.rb,
lib/athenian/models/diffed_releases.rb,
lib/athenian/models/histogram_scale.rb,
lib/athenian/models/invitation_link.rb,
lib/athenian/models/jira_epic_child.rb,
lib/athenian/models/jira_issue_type.rb,
lib/athenian/models/product_feature.rb,
lib/athenian/models/commit_signature.rb,
lib/athenian/models/deployed_release.rb,
lib/athenian/models/filtered_release.rb,
lib/athenian/models/jira_epic_all_of.rb,
lib/athenian/models/jira_filter_with.rb,
lib/athenian/models/logical_pr_rules.rb,
lib/athenian/models/matched_identity.rb,
lib/athenian/models/pull_request_set.rb,
lib/athenian/models/developer_summary.rb,
lib/athenian/models/developer_updates.rb,
lib/athenian/models/filter_jira_stuff.rb,
lib/athenian/models/jira_installation.rb,
lib/athenian/models/jira_issue_all_of.rb,
lib/athenian/models/linked_jira_issue.rb,
lib/athenian/models/pull_request_with.rb,
lib/athenian/models/release_metric_id.rb,
lib/athenian/models/created_identifier.rb,
lib/athenian/models/deployed_component.rb,
lib/athenian/models/filter_jira_common.rb,
lib/athenian/models/for_set_developers.rb,
lib/athenian/models/goal_metric_params.rb,
lib/athenian/models/jira_filter_return.rb,
lib/athenian/models/logical_repository.rb,
lib/athenian/models/pull_request_event.rb,
lib/athenian/models/pull_request_label.rb,
lib/athenian/models/pull_request_stage.rb,
lib/athenian/models/accepted_invitation.rb,
lib/athenian/models/deployment_analysis.rb,
lib/athenian/models/developer_metric_id.rb,
lib/athenian/models/filtered_deployment.rb,
lib/athenian/models/filtered_jira_stuff.rb,
lib/athenian/models/for_set_code_checks.rb,
lib/athenian/models/for_set_deployments.rb,
lib/athenian/models/matched_identity_to.rb,
lib/athenian/models/patch_token_request.rb,
lib/athenian/models/release_set_include.rb,
lib/athenian/models/team_create_request.rb,
lib/athenian/models/team_update_request.rb,
lib/athenian/models/code_check_metric_id.rb,
lib/athenian/models/commits_list_include.rb,
lib/athenian/models/contributor_identity.rb,
lib/athenian/models/create_token_request.rb,
lib/athenian/models/deployment_metric_id.rb,
lib/athenian/models/filtered_deployments.rb,
lib/athenian/models/filtered_environment.rb,
lib/athenian/models/get_releases_request.rb,
lib/athenian/models/goal_template_metric.rb,
lib/athenian/models/included_deployments.rb,
lib/athenian/models/included_jira_issues.rb,
lib/athenian/models/included_native_user.rb,
lib/athenian/models/jira_metrics_request.rb,
lib/athenian/models/jira_status_category.rb,
lib/athenian/models/mapped_jira_identity.rb,
lib/athenian/models/pull_request_numbers.rb,
lib/athenian/models/release_notification.rb,
lib/athenian/models/deployed_pull_request.rb,
lib/athenian/models/deployment_conclusion.rb,
lib/athenian/models/diff_releases_request.rb,
lib/athenian/models/filter_labels_request.rb,
lib/athenian/models/for_set_pull_requests.rb,
lib/athenian/models/included_native_users.rb,
lib/athenian/models/installation_progress.rb,
lib/athenian/models/invalid_request_error.rb,
lib/athenian/models/jira_projects_request.rb,
lib/athenian/models/release_match_request.rb,
lib/athenian/models/release_match_setting.rb,
lib/athenian/models/released_pull_request.rb,
lib/athenian/models/work_type_get_request.rb,
lib/athenian/models/work_type_put_request.rb,
lib/athenian/models/filter_commits_request.rb,
lib/athenian/models/filter_jira_stuff_with.rb,
lib/athenian/models/jira_epic_child_all_of.rb,
lib/athenian/models/jira_epic_issue_common.rb,
lib/athenian/models/pull_request_metric_id.rb,
lib/athenian/models/release_match_strategy.rb,
lib/athenian/models/deployment_notification.rb,
lib/athenian/models/diffed_releases_include.rb,
lib/athenian/models/filter_releases_request.rb,
lib/athenian/models/filtered_code_check_run.rb,
lib/athenian/models/get_jira_issues_include.rb,
lib/athenian/models/get_jira_issues_request.rb,
lib/athenian/models/invitation_check_result.rb,
lib/athenian/models/jira_histograms_request.rb,
lib/athenian/models/release_metrics_request.rb,
lib/athenian/models/table_fetching_progress.rb,
lib/athenian/models/deployment_analysis_code.rb,
lib/athenian/models/filtered_code_check_runs.rb,
lib/athenian/models/for_set_code_checks_jira.rb,
lib/athenian/models/get_jira_issues_response.rb,
lib/athenian/models/logical_deployment_rules.rb,
lib/athenian/models/match_identities_request.rb,
lib/athenian/models/pull_request_participant.rb,
lib/athenian/models/pull_request_set_include.rb,
lib/athenian/models/repository_set_list_item.rb,
lib/athenian/models/repository_set_with_name.rb,
lib/athenian/models/calculated_jira_histogram.rb,
lib/athenian/models/calculated_release_metric.rb,
lib/athenian/models/code_check_run_statistics.rb,
lib/athenian/models/developer_metrics_request.rb,
lib/athenian/models/get_pull_requests_request.rb,
lib/athenian/models/jira_histogram_definition.rb,
lib/athenian/models/code_check_metrics_request.rb,
lib/athenian/models/deployment_metrics_request.rb,
lib/athenian/models/filter_code_checks_request.rb,
lib/athenian/models/filter_deployments_request.rb,
lib/athenian/models/logical_repository_request.rb,
lib/athenian/models/notified_deployments_inner.rb,
lib/athenian/models/product_feature_parameters.rb,
lib/athenian/models/account_user_change_request.rb,
lib/athenian/models/delete_events_cache_request.rb,
lib/athenian/models/filter_contributors_request.rb,
lib/athenian/models/filter_environments_request.rb,
lib/athenian/models/filter_repositories_request.rb,
lib/athenian/models/mapped_jira_identity_change.rb,
lib/athenian/models/release_notification_status.rb,
lib/athenian/models/calculated_deployment_metric.rb,
lib/athenian/models/calculated_developer_metrics.rb,
lib/athenian/models/deployed_pull_request_all_of.rb,
lib/athenian/models/filter_pull_requests_request.rb,
lib/athenian/models/filtered_deployments_include.rb,
lib/athenian/models/goal_metric_params_threshold.rb,
lib/athenian/models/goal_template_create_request.rb,
lib/athenian/models/goal_template_update_request.rb,
lib/athenian/models/invalid_request_error_all_of.rb,
lib/athenian/models/pull_request_metrics_request.rb,
lib/athenian/models/pull_request_pagination_plan.rb,
lib/athenian/models/released_pull_request_author.rb,
lib/athenian/models/calculated_code_check_metrics.rb,
lib/athenian/models/calculated_jira_metric_values.rb,
lib/athenian/models/code_check_histograms_request.rb,
lib/athenian/models/repository_set_create_request.rb,
lib/athenian/models/with_both_jira_and_jiragroups.rb,
lib/athenian/models/code_bypassing_prs_measurement.rb,
lib/athenian/models/logical_repository_get_request.rb,
lib/athenian/models/notify_deployments200_response.rb,
lib/athenian/models/paginate_pull_requests_request.rb,
lib/athenian/models/calculated_code_check_histogram.rb,
lib/athenian/models/calculated_linear_metric_values.rb,
lib/athenian/models/calculated_pull_request_metrics.rb,
lib/athenian/models/code_check_histogram_definition.rb,
lib/athenian/models/pull_request_histograms_request.rb,
lib/athenian/models/deployment_modify_labels_request.rb,
lib/athenian/models/get_jira_issues_response_include.rb,
lib/athenian/models/calculated_developer_metrics_item.rb,
lib/athenian/models/calculated_pull_request_histogram.rb,
lib/athenian/models/filtered_code_check_run_prs_stats.rb,
lib/athenian/models/get_deployment_labels200_response.rb,
lib/athenian/models/pull_request_histogram_definition.rb,
lib/athenian/models/release_metrics_request_for_inner.rb,
lib/athenian/models/calculated_code_check_metrics_item.rb,
lib/athenian/models/set_mapped_jira_identities_request.rb,
lib/athenian/models/filtered_code_check_run_total_stats.rb,
lib/athenian/models/calculated_pull_request_metrics_item.rb,
lib/athenian/models/calculated_linear_metric_values_values_inner.rb,
lib/athenian/models/code_check_run_statistics_mean_execution_time.rb,
lib/athenian/models/code_check_run_statistics_median_execution_time.rb,
lib/athenian/models/code_check_run_statistics_stddev_execution_time.rb,
lib/athenian/models/calculated_pull_request_histogram_frequencies_inner.rb,
lib/athenian/models/calculated_linear_metric_values_confidence_mins_inner.rb

Overview

This is an automatically generated file. DO NOT EDIT.

Generated from version 2.1.86 of the OpenAPI specification at github.com/athenianco/api-spec/releases/tag/2.1.86. Generated by: openapi-generator.tech OpenAPI Generator version: 6.5.0

Defined Under Namespace

Modules: CalculatedLinearMetricValuesConfidenceMinsInner, CalculatedLinearMetricValuesValuesInner, CalculatedPullRequestHistogramFrequenciesInner, GoalMetricParamsThreshold, GoalTemplateMetric, ProductFeatureParameters, ReleaseMetricsRequestForInner Classes: AcceptedInvitation, Account, AccountStatus, AccountUserChangeRequest, AlignApi, ApiClient, ApiError, CalculatedCodeCheckHistogram, CalculatedCodeCheckMetrics, CalculatedCodeCheckMetricsItem, CalculatedDeploymentMetric, CalculatedDeveloperMetrics, CalculatedDeveloperMetricsItem, CalculatedJIRAHistogram, CalculatedJIRAMetricValues, CalculatedLinearMetricValues, CalculatedPullRequestHistogram, CalculatedPullRequestMetrics, CalculatedPullRequestMetricsItem, CalculatedReleaseMetric, CodeBypassingPRsMeasurement, CodeCheckHistogramDefinition, CodeCheckHistogramsRequest, CodeCheckMetricID, CodeCheckMetricsRequest, CodeCheckRunStatistics, CodeCheckRunStatisticsMeanExecutionTime, CodeCheckRunStatisticsMedianExecutionTime, CodeCheckRunStatisticsStddevExecutionTime, CodeFilter, Commit, CommitSignature, CommitsList, CommitsListInclude, Configuration, Contributor, ContributorIdentity, CreateTokenRequest, CreatedIdentifier, CreatedToken, Datasource, DeleteEventsCacheRequest, DeployedComponent, DeployedPullRequest, DeployedPullRequestAllOf, DeployedRelease, DeploymentAnalysis, DeploymentAnalysisCode, DeploymentConclusion, DeploymentMetricID, DeploymentMetricsRequest, DeploymentModifyLabelsRequest, DeploymentNotification, DeploymentWith, DeveloperMetricID, DeveloperMetricsRequest, DeveloperSummary, DeveloperUpdates, DiffReleasesRequest, DiffedReleases, DiffedReleasesInclude, EventsApi, FilterApi, FilterCodeChecksRequest, FilterCommitsRequest, FilterContributorsRequest, FilterDeploymentsRequest, FilterEnvironmentsRequest, FilterJIRACommon, FilterJIRAStuff, FilterJIRAStuffWith, FilterLabelsRequest, FilterPullRequestsRequest, FilterReleasesRequest, FilterRepositoriesRequest, FilteredCodeCheckRun, FilteredCodeCheckRunPrsStats, FilteredCodeCheckRunTotalStats, FilteredCodeCheckRuns, FilteredDeployment, FilteredDeployments, FilteredDeploymentsInclude, FilteredEnvironment, FilteredJIRAStuff, FilteredLabel, FilteredRelease, ForSetCodeChecks, ForSetCodeChecksJira, ForSetDeployments, ForSetDevelopers, ForSetPullRequests, GenericError, GetApi, GetDeploymentLabels200Response, GetJIRAIssuesInclude, GetJIRAIssuesRequest, GetJIRAIssuesResponse, GetJIRAIssuesResponseInclude, GetPullRequestsRequest, GetReleasesRequest, GoalMetricParams, GoalTemplate, GoalTemplateCreateRequest, GoalTemplateUpdateRequest, HistogramScale, HistogramsApi, IncludedDeployments, IncludedJIRAIssues, IncludedNativeUser, IncludedNativeUsers, InstallationProgress, IntegrationsApi, Interquartile, InvalidRequestError, InvalidRequestErrorAllOf, InvitationCheckResult, InvitationLink, InvitedUser, JIRAComment, JIRAEpic, JIRAEpicAllOf, JIRAEpicChild, JIRAEpicChildAllOf, JIRAEpicIssueCommon, JIRAFilter, JIRAFilterReturn, JIRAFilterWith, JIRAHistogramDefinition, JIRAHistogramsRequest, JIRAInstallation, JIRAIssue, JIRAIssueAllOf, JIRAIssueType, JIRALabel, JIRAMetricID, JIRAMetricsRequest, JIRAPriority, JIRAProject, JIRAProjectsRequest, JIRAStatus, JIRAStatusCategory, JIRAUser, LinkedJIRAIssue, ListedToken, LogicalDeploymentRules, LogicalPRRules, LogicalRepository, LogicalRepositoryGetRequest, LogicalRepositoryRequest, MappedJIRAIdentity, MappedJIRAIdentityChange, MatchIdentitiesRequest, MatchedIdentity, MatchedIdentityTo, MetricsApi, NotifiedDeploymentsInner, NotifyDeployments200Response, Organization, PaginatePullRequestsRequest, PaginationApi, PatchTokenRequest, ProductFeature, PullRequest, PullRequestEvent, PullRequestHistogramDefinition, PullRequestHistogramsRequest, PullRequestLabel, PullRequestMetricID, PullRequestMetricsRequest, PullRequestNumbers, PullRequestPaginationPlan, PullRequestParticipant, PullRequestSet, PullRequestSetInclude, PullRequestStage, PullRequestWith, RegistrationApi, ReleaseDiff, ReleaseMatchRequest, ReleaseMatchSetting, ReleaseMatchStrategy, ReleaseMetricID, ReleaseMetricsRequest, ReleaseNames, ReleaseNotification, ReleaseNotificationStatus, ReleasePair, ReleaseSet, ReleaseSetInclude, ReleaseWith, ReleasedPullRequest, ReleasedPullRequestAuthor, ReposetApi, RepositorySetCreateRequest, RepositorySetListItem, RepositorySetWithName, SecurityApi, SetMappedJIRAIdentitiesRequest, SettingsApi, Share, StageTimings, TableFetchingProgress, Team, TeamApi, TeamCreateRequest, TeamUpdateRequest, User, UserApi, VersionApi, Versions, WithBothJiraAndJiragroups, WorkType, WorkTypeGetRequest, WorkTypePutRequest, WorkTypeRule

Constant Summary collapse

VERSION = 
'2.1.86'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Athenian.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



247
248
249
250
251
252
253
 
# File 'lib/athenian.rb', line 247

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end