Module: Shipeasy::Admin::Generated

Defined in:
lib/shipeasy_admin/version.rb,
lib/shipeasy_admin.rb,
lib/shipeasy_admin/api_error.rb,
lib/shipeasy_admin/api_client.rb,
lib/shipeasy_admin/api/ops_api.rb,
lib/shipeasy_admin/api/i18n_api.rb,
lib/shipeasy_admin/api/gates_api.rb,
lib/shipeasy_admin/configuration.rb,
lib/shipeasy_admin/api/events_api.rb,
lib/shipeasy_admin/api_model_base.rb,
lib/shipeasy_admin/api/configs_api.rb,
lib/shipeasy_admin/api/metrics_api.rb,
lib/shipeasy_admin/api/projects_api.rb,
lib/shipeasy_admin/api/universes_api.rb,
lib/shipeasy_admin/api/attributes_api.rb,
lib/shipeasy_admin/api/alert_rules_api.rb,
lib/shipeasy_admin/api/experiments_api.rb,
lib/shipeasy_admin/api/killswitches_api.rb,
lib/shipeasy_admin/models/error_response.rb,
lib/shipeasy_admin/models/get_event_response.rb,
lib/shipeasy_admin/models/notify_ops_request.rb,
lib/shipeasy_admin/models/create_gate_request.rb,
lib/shipeasy_admin/models/get_config_response.rb,
lib/shipeasy_admin/models/get_metric_response.rb,
lib/shipeasy_admin/models/list_gates_response.rb,
lib/shipeasy_admin/models/notify_ops_response.rb,
lib/shipeasy_admin/models/update_gate_request.rb,
lib/shipeasy_admin/models/create_event_request.rb,
lib/shipeasy_admin/models/create_gate_response.rb,
lib/shipeasy_admin/models/delete_gate_response.rb,
lib/shipeasy_admin/models/enable_gate_response.rb,
lib/shipeasy_admin/models/update_event_request.rb,
lib/shipeasy_admin/models/update_gate_response.rb,
lib/shipeasy_admin/models/approve_event_request.rb,
lib/shipeasy_admin/models/create_config_request.rb,
lib/shipeasy_admin/models/create_event_response.rb,
lib/shipeasy_admin/models/create_metric_request.rb,
lib/shipeasy_admin/models/delete_event_response.rb,
lib/shipeasy_admin/models/disable_gate_response.rb,
lib/shipeasy_admin/models/get_ops_item_response.rb,
lib/shipeasy_admin/models/list_configs_response.rb,
lib/shipeasy_admin/models/update_config_request.rb,
lib/shipeasy_admin/models/update_event_response.rb,
lib/shipeasy_admin/models/approve_event_response.rb,
lib/shipeasy_admin/models/create_config_response.rb,
lib/shipeasy_admin/models/create_metric_response.rb,
lib/shipeasy_admin/models/delete_config_response.rb,
lib/shipeasy_admin/models/delete_metric_response.rb,
lib/shipeasy_admin/models/push_i18n_keys_request.rb,
lib/shipeasy_admin/models/update_config_response.rb,
lib/shipeasy_admin/models/upsert_project_request.rb,
lib/shipeasy_admin/models/create_ops_item_request.rb,
lib/shipeasy_admin/models/create_universe_request.rb,
lib/shipeasy_admin/models/get_experiment_response.rb,
lib/shipeasy_admin/models/get_killswitch_response.rb,
lib/shipeasy_admin/models/list_i18n_keys_response.rb,
lib/shipeasy_admin/models/list_universes_response.rb,
lib/shipeasy_admin/models/push_i18n_keys_response.rb,
lib/shipeasy_admin/models/update_i18n_key_request.rb,
lib/shipeasy_admin/models/update_ops_item_request.rb,
lib/shipeasy_admin/models/update_universe_request.rb,
lib/shipeasy_admin/models/upsert_project_response.rb,
lib/shipeasy_admin/models/create_ops_item_response.rb,
lib/shipeasy_admin/models/create_universe_response.rb,
lib/shipeasy_admin/models/delete_universe_response.rb,
lib/shipeasy_admin/models/update_i18n_key_response.rb,
lib/shipeasy_admin/models/update_ops_item_response.rb,
lib/shipeasy_admin/models/update_universe_response.rb,
lib/shipeasy_admin/models/create_alert_rule_request.rb,
lib/shipeasy_admin/models/create_experiment_request.rb,
lib/shipeasy_admin/models/create_killswitch_request.rb,
lib/shipeasy_admin/models/list_experiments_response.rb,
lib/shipeasy_admin/models/save_config_draft_request.rb,
lib/shipeasy_admin/models/update_alert_rule_request.rb,
lib/shipeasy_admin/models/update_experiment_request.rb,
lib/shipeasy_admin/models/update_killswitch_request.rb,
lib/shipeasy_admin/models/create_alert_rule_response.rb,
lib/shipeasy_admin/models/create_experiment_response.rb,
lib/shipeasy_admin/models/create_killswitch_response.rb,
lib/shipeasy_admin/models/delete_alert_rule_response.rb,
lib/shipeasy_admin/models/delete_experiment_response.rb,
lib/shipeasy_admin/models/delete_killswitch_response.rb,
lib/shipeasy_admin/models/list_events_response_inner.rb,
lib/shipeasy_admin/models/list_killswitches_response.rb,
lib/shipeasy_admin/models/save_config_draft_response.rb,
lib/shipeasy_admin/models/update_alert_rule_response.rb,
lib/shipeasy_admin/models/update_experiment_response.rb,
lib/shipeasy_admin/models/update_killswitch_response.rb,
lib/shipeasy_admin/models/create_i18n_profile_request.rb,
lib/shipeasy_admin/models/link_pr_to_ops_item_request.rb,
lib/shipeasy_admin/models/list_metrics_response_inner.rb,
lib/shipeasy_admin/models/create_i18n_profile_response.rb,
lib/shipeasy_admin/models/discard_config_draft_request.rb,
lib/shipeasy_admin/models/get_current_project_response.rb,
lib/shipeasy_admin/models/link_pr_to_ops_item_response.rb,
lib/shipeasy_admin/models/list_slack_channels_response.rb,
lib/shipeasy_admin/models/publish_config_draft_request.rb,
lib/shipeasy_admin/models/publish_i18n_profile_request.rb,
lib/shipeasy_admin/models/discard_config_draft_response.rb,
lib/shipeasy_admin/models/list_ops_items_response_inner.rb,
lib/shipeasy_admin/models/publish_config_draft_response.rb,
lib/shipeasy_admin/models/publish_i18n_profile_response.rb,
lib/shipeasy_admin/models/reanalyze_experiment_response.rb,
lib/shipeasy_admin/models/set_experiment_status_request.rb,
lib/shipeasy_admin/models/set_killswitch_switch_request.rb,
lib/shipeasy_admin/models/list_attributes_response_inner.rb,
lib/shipeasy_admin/models/list_gates_response_data_inner.rb,
lib/shipeasy_admin/models/set_experiment_metrics_request.rb,
lib/shipeasy_admin/models/set_experiment_status_response.rb,
lib/shipeasy_admin/models/set_killswitch_switch_response.rb,
lib/shipeasy_admin/models/get_experiment_results_response.rb,
lib/shipeasy_admin/models/list_alert_rules_response_inner.rb,
lib/shipeasy_admin/models/list_i18n_drafts_response_inner.rb,
lib/shipeasy_admin/models/set_experiment_metrics_response.rb,
lib/shipeasy_admin/models/unset_killswitch_switch_request.rb,
lib/shipeasy_admin/models/list_configs_response_data_inner.rb,
lib/shipeasy_admin/models/unset_killswitch_switch_response.rb,
lib/shipeasy_admin/models/list_i18n_profiles_response_inner.rb,
lib/shipeasy_admin/models/push_i18n_keys_request_keys_inner.rb,
lib/shipeasy_admin/models/get_experiment_timeseries_response.rb,
lib/shipeasy_admin/models/list_i18n_keys_response_keys_inner.rb,
lib/shipeasy_admin/models/list_universes_response_data_inner.rb,
lib/shipeasy_admin/models/list_config_activity_response_inner.rb,
lib/shipeasy_admin/models/list_experiments_response_data_inner.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir.rb,
lib/shipeasy_admin/models/create_experiment_request_goal_metric.rb,
lib/shipeasy_admin/models/list_killswitches_response_data_inner.rb,
lib/shipeasy_admin/models/list_alert_rules_response_inner_notify.rb,
lib/shipeasy_admin/models/list_gates_response_data_inner_enabled.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg.rb,
lib/shipeasy_admin/models/get_experiment_results_response_experiment.rb,
lib/shipeasy_admin/models/list_gates_response_data_inner_rules_inner.rb,
lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner.rb,
lib/shipeasy_admin/models/list_configs_response_data_inner_envs_value.rb,
lib/shipeasy_admin/models/list_events_response_inner_properties_inner.rb,
lib/shipeasy_admin/models/list_slack_channels_response_channels_inner.rb,
lib/shipeasy_admin/models/set_experiment_metrics_request_metrics_inner.rb,
lib/shipeasy_admin/models/get_experiment_results_response_results_inner.rb,
lib/shipeasy_admin/models/get_experiment_timeseries_response_experiment.rb,
lib/shipeasy_admin/models/list_configs_response_data_inner_drafts_value.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_group_by.rb,
lib/shipeasy_admin/models/set_experiment_metrics_response_metrics_inner.rb,
lib/shipeasy_admin/models/get_experiment_timeseries_response_series_inner.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of.rb,
lib/shipeasy_admin/models/get_current_project_response_module_translations.rb,
lib/shipeasy_admin/models/list_killswitches_response_data_inner_envs_value.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of1.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of2.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of3.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of4.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of5.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of6.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of7.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of8.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9.rb,
lib/shipeasy_admin/models/list_experiments_response_data_inner_groups_inner.rb,
lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of.rb,
lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of1.rb,
lib/shipeasy_admin/models/list_alert_rules_response_inner_notify_slack_channel.rb,
lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of_ramp.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator.rb,
lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator_filters_inner.rb

Overview

#Shipeasy Admin API

#REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (Authorization: Bearer sdk_admin_…) and scope every request to a project via the X-Project-Id header. Mint admin keys via POST /api/admin/keys with type: \"admin\". Keys expire after 90 days; rotate with the revoke action.

The version of the OpenAPI document: 1.0.0

Generated by: https://openapi-generator.tech Generator version: 7.23.0

Defined Under Namespace

Modules: GetCurrentProjectResponseModuleTranslations, ListGatesResponseDataInnerEnabled, ListGatesResponseDataInnerStackInner, ListMetricsResponseInnerQueryIrAgg Classes: AlertRulesApi, ApiClient, ApiError, ApiModelBase, ApproveEventRequest, ApproveEventResponse, AttributesApi, ConfigsApi, Configuration, CreateAlertRuleRequest, CreateAlertRuleResponse, CreateConfigRequest, CreateConfigResponse, CreateEventRequest, CreateEventResponse, CreateExperimentRequest, CreateExperimentRequestGoalMetric, CreateExperimentResponse, CreateGateRequest, CreateGateResponse, CreateI18nProfileRequest, CreateI18nProfileResponse, CreateKillswitchRequest, CreateKillswitchResponse, CreateMetricRequest, CreateMetricResponse, CreateOpsItemRequest, CreateOpsItemResponse, CreateUniverseRequest, CreateUniverseResponse, DeleteAlertRuleResponse, DeleteConfigResponse, DeleteEventResponse, DeleteExperimentResponse, DeleteGateResponse, DeleteKillswitchResponse, DeleteMetricResponse, DeleteUniverseResponse, DisableGateResponse, DiscardConfigDraftRequest, DiscardConfigDraftResponse, EnableGateResponse, ErrorResponse, EventsApi, ExperimentsApi, GatesApi, GetConfigResponse, GetCurrentProjectResponse, GetEventResponse, GetExperimentResponse, GetExperimentResultsResponse, GetExperimentResultsResponseExperiment, GetExperimentResultsResponseResultsInner, GetExperimentTimeseriesResponse, GetExperimentTimeseriesResponseExperiment, GetExperimentTimeseriesResponseSeriesInner, GetKillswitchResponse, GetMetricResponse, GetOpsItemResponse, I18nApi, KillswitchesApi, LinkPrToOpsItemRequest, LinkPrToOpsItemResponse, ListAlertRulesResponseInner, ListAlertRulesResponseInnerNotify, ListAlertRulesResponseInnerNotifySlackChannel, ListAttributesResponseInner, ListConfigActivityResponseInner, ListConfigsResponse, ListConfigsResponseDataInner, ListConfigsResponseDataInnerDraftsValue, ListConfigsResponseDataInnerEnvsValue, ListEventsResponseInner, ListEventsResponseInnerPropertiesInner, ListExperimentsResponse, ListExperimentsResponseDataInner, ListExperimentsResponseDataInnerGroupsInner, ListGatesResponse, ListGatesResponseDataInner, ListGatesResponseDataInnerRulesInner, ListGatesResponseDataInnerStackInnerOneOf, ListGatesResponseDataInnerStackInnerOneOf1, ListGatesResponseDataInnerStackInnerOneOfRamp, ListI18nDraftsResponseInner, ListI18nKeysResponse, ListI18nKeysResponseKeysInner, ListI18nProfilesResponseInner, ListKillswitchesResponse, ListKillswitchesResponseDataInner, ListKillswitchesResponseDataInnerEnvsValue, ListMetricsResponseInner, ListMetricsResponseInnerQueryIr, ListMetricsResponseInnerQueryIrAggOneOf, ListMetricsResponseInnerQueryIrAggOneOf1, ListMetricsResponseInnerQueryIrAggOneOf2, ListMetricsResponseInnerQueryIrAggOneOf3, ListMetricsResponseInnerQueryIrAggOneOf4, ListMetricsResponseInnerQueryIrAggOneOf5, ListMetricsResponseInnerQueryIrAggOneOf6, ListMetricsResponseInnerQueryIrAggOneOf7, ListMetricsResponseInnerQueryIrAggOneOf8, ListMetricsResponseInnerQueryIrAggOneOf9, ListMetricsResponseInnerQueryIrAggOneOf9Numerator, ListMetricsResponseInnerQueryIrAggOneOf9NumeratorFiltersInner, ListMetricsResponseInnerQueryIrGroupBy, ListOpsItemsResponseInner, ListSlackChannelsResponse, ListSlackChannelsResponseChannelsInner, ListUniversesResponse, ListUniversesResponseDataInner, MetricsApi, NotifyOpsRequest, NotifyOpsResponse, OpsApi, ProjectsApi, PublishConfigDraftRequest, PublishConfigDraftResponse, PublishI18nProfileRequest, PublishI18nProfileResponse, PushI18nKeysRequest, PushI18nKeysRequestKeysInner, PushI18nKeysResponse, ReanalyzeExperimentResponse, SaveConfigDraftRequest, SaveConfigDraftResponse, SetExperimentMetricsRequest, SetExperimentMetricsRequestMetricsInner, SetExperimentMetricsResponse, SetExperimentMetricsResponseMetricsInner, SetExperimentStatusRequest, SetExperimentStatusResponse, SetKillswitchSwitchRequest, SetKillswitchSwitchResponse, UniversesApi, UnsetKillswitchSwitchRequest, UnsetKillswitchSwitchResponse, UpdateAlertRuleRequest, UpdateAlertRuleResponse, UpdateConfigRequest, UpdateConfigResponse, UpdateEventRequest, UpdateEventResponse, UpdateExperimentRequest, UpdateExperimentResponse, UpdateGateRequest, UpdateGateResponse, UpdateI18nKeyRequest, UpdateI18nKeyResponse, UpdateKillswitchRequest, UpdateKillswitchResponse, UpdateOpsItemRequest, UpdateOpsItemResponse, UpdateUniverseRequest, UpdateUniverseResponse, UpsertProjectRequest, UpsertProjectResponse

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block. Shipeasy::Admin::Generated.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.



188
189
190
191
192
193
194
 
# File 'lib/shipeasy_admin.rb', line 188

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