shipeasy-sdk 3.8.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/skill/SKILL.md +7 -4
- data/lib/shipeasy/admin.rb +23 -20
- data/lib/shipeasy/sdk/see.rb +7 -5
- data/lib/shipeasy/sdk/version.rb +1 -1
- data/lib/shipeasy_admin/api/flags_api.rb +127 -214
- data/lib/shipeasy_admin/api/killswitch_api.rb +25 -525
- data/lib/shipeasy_admin/api/ops_api.rb +44 -351
- data/lib/shipeasy_admin/api_client.rb +2 -2
- data/lib/shipeasy_admin/api_error.rb +2 -2
- data/lib/shipeasy_admin/api_model_base.rb +2 -2
- data/lib/shipeasy_admin/configuration.rb +29 -2
- data/lib/shipeasy_admin/models/{set_killswitch_value_request.rb → add_to_gate_whitelist_request.rb} +37 -42
- data/lib/shipeasy_admin/models/create_public_bug_request.rb +464 -0
- data/lib/shipeasy_admin/models/create_public_feature_request_request.rb +407 -0
- data/lib/shipeasy_admin/models/{file_error_ticket_response.rb → create_public_ticket_response.rb} +22 -29
- data/lib/shipeasy_admin/models/env.rb +2 -2
- data/lib/shipeasy_admin/models/error.rb +41 -7
- data/lib/shipeasy_admin/models/error_code.rb +14 -3
- data/lib/shipeasy_admin/models/{get_experiment_timeseries_response_experiment.rb → gate_whitelist.rb} +51 -42
- data/lib/shipeasy_admin/models/gate_whitelist_attr.rb +40 -0
- data/lib/shipeasy_admin/models/killswitch_value.rb +2 -2
- data/lib/shipeasy_admin/models/notification_target.rb +2 -2
- data/lib/shipeasy_admin/models/notification_target_slack_channel.rb +2 -2
- data/lib/shipeasy_admin/models/ops_item_priority.rb +42 -0
- data/lib/shipeasy_admin/models/ops_item_status.rb +46 -0
- data/lib/shipeasy_admin/models/{discard_config_draft_request.rb → remove_from_gate_whitelist_request.rb} +34 -44
- data/lib/shipeasy_admin/models/{delete_alert_rule_response.rb → set_gate_whitelist_request.rb} +37 -25
- data/lib/shipeasy_admin/models/{set_killswitch_switch_request.rb → toggle_killswitch_request.rb} +30 -72
- data/lib/shipeasy_admin/models/{set_killswitch_value_response.rb → toggle_killswitch_response.rb} +100 -6
- data/lib/shipeasy_admin/version.rb +2 -2
- data/lib/shipeasy_admin.rb +14 -195
- metadata +13 -194
- data/lib/shipeasy_admin/api/alerts_api.rb +0 -352
- data/lib/shipeasy_admin/api/api_keys_api.rb +0 -229
- data/lib/shipeasy_admin/api/attributes_api.rb +0 -82
- data/lib/shipeasy_admin/api/configs_api.rb +0 -757
- data/lib/shipeasy_admin/api/connectors_api.rb +0 -497
- data/lib/shipeasy_admin/api/drafts_api.rb +0 -82
- data/lib/shipeasy_admin/api/errors_api.rb +0 -389
- data/lib/shipeasy_admin/api/events_api.rb +0 -438
- data/lib/shipeasy_admin/api/experiments_api.rb +0 -727
- data/lib/shipeasy_admin/api/keys_api.rb +0 -317
- data/lib/shipeasy_admin/api/metrics_api.rb +0 -281
- data/lib/shipeasy_admin/api/profiles_api.rb +0 -222
- data/lib/shipeasy_admin/api/projects_api.rb +0 -216
- data/lib/shipeasy_admin/api/universes_api.rb +0 -306
- data/lib/shipeasy_admin/models/approve_event_request.rb +0 -198
- data/lib/shipeasy_admin/models/approve_event_response.rb +0 -166
- data/lib/shipeasy_admin/models/claude_trigger_config.rb +0 -204
- data/lib/shipeasy_admin/models/connector_event.rb +0 -40
- data/lib/shipeasy_admin/models/connector_provider.rb +0 -45
- data/lib/shipeasy_admin/models/connector_record.rb +0 -468
- data/lib/shipeasy_admin/models/copilot_trigger_config.rb +0 -276
- data/lib/shipeasy_admin/models/create_alert_rule_request.rb +0 -383
- data/lib/shipeasy_admin/models/create_alert_rule_response.rb +0 -165
- data/lib/shipeasy_admin/models/create_claude_trigger_request.rb +0 -309
- data/lib/shipeasy_admin/models/create_config_request.rb +0 -291
- data/lib/shipeasy_admin/models/create_config_response.rb +0 -201
- data/lib/shipeasy_admin/models/create_connector_request.rb +0 -64
- data/lib/shipeasy_admin/models/create_connector_response.rb +0 -165
- data/lib/shipeasy_admin/models/create_copilot_trigger_request.rb +0 -316
- data/lib/shipeasy_admin/models/create_cursor_trigger_request.rb +0 -352
- data/lib/shipeasy_admin/models/create_event_request.rb +0 -236
- data/lib/shipeasy_admin/models/create_event_response.rb +0 -193
- data/lib/shipeasy_admin/models/create_experiment_request.rb +0 -807
- data/lib/shipeasy_admin/models/create_experiment_response.rb +0 -212
- data/lib/shipeasy_admin/models/create_gate_request.rb +0 -492
- data/lib/shipeasy_admin/models/create_gate_response.rb +0 -212
- data/lib/shipeasy_admin/models/create_i18n_profile_request.rb +0 -188
- data/lib/shipeasy_admin/models/create_i18n_profile_response.rb +0 -193
- data/lib/shipeasy_admin/models/create_jules_trigger_request.rb +0 -352
- data/lib/shipeasy_admin/models/create_key_request.rb +0 -297
- data/lib/shipeasy_admin/models/create_key_response.rb +0 -286
- data/lib/shipeasy_admin/models/create_killswitch_request.rb +0 -274
- data/lib/shipeasy_admin/models/create_killswitch_response.rb +0 -201
- data/lib/shipeasy_admin/models/create_metric_request.rb +0 -403
- data/lib/shipeasy_admin/models/create_metric_response.rb +0 -193
- data/lib/shipeasy_admin/models/create_o_auth_connector_request.rb +0 -273
- data/lib/shipeasy_admin/models/create_ops_item_request.rb +0 -287
- data/lib/shipeasy_admin/models/create_ops_item_response.rb +0 -177
- data/lib/shipeasy_admin/models/create_universe_request.rb +0 -272
- data/lib/shipeasy_admin/models/create_universe_response.rb +0 -212
- data/lib/shipeasy_admin/models/cursor_trigger_config.rb +0 -231
- data/lib/shipeasy_admin/models/delete_config_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_connector_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_event_response.rb +0 -189
- data/lib/shipeasy_admin/models/delete_experiment_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_gate_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_killswitch_response.rb +0 -188
- data/lib/shipeasy_admin/models/delete_metric_response.rb +0 -189
- data/lib/shipeasy_admin/models/delete_universe_response.rb +0 -188
- data/lib/shipeasy_admin/models/disable_gate_response.rb +0 -190
- data/lib/shipeasy_admin/models/discard_config_draft_response.rb +0 -188
- data/lib/shipeasy_admin/models/enable_gate_response.rb +0 -190
- data/lib/shipeasy_admin/models/error_record.rb +0 -597
- data/lib/shipeasy_admin/models/error_series_request.rb +0 -251
- data/lib/shipeasy_admin/models/error_series_response.rb +0 -195
- data/lib/shipeasy_admin/models/error_series_response_rows_inner.rb +0 -192
- data/lib/shipeasy_admin/models/experiment_inline_metric.rb +0 -337
- data/lib/shipeasy_admin/models/fire_connector_request.rb +0 -149
- data/lib/shipeasy_admin/models/fire_connector_response.rb +0 -176
- data/lib/shipeasy_admin/models/get_config_response.rb +0 -351
- data/lib/shipeasy_admin/models/get_current_project_response.rb +0 -606
- data/lib/shipeasy_admin/models/get_current_project_response_module_translations.rb +0 -104
- data/lib/shipeasy_admin/models/get_event_response.rb +0 -344
- data/lib/shipeasy_admin/models/get_experiment_response.rb +0 -688
- data/lib/shipeasy_admin/models/get_experiment_results_response.rb +0 -243
- data/lib/shipeasy_admin/models/get_experiment_results_response_experiment.rb +0 -248
- data/lib/shipeasy_admin/models/get_experiment_results_response_results_inner.rb +0 -252
- data/lib/shipeasy_admin/models/get_experiment_timeseries_response.rb +0 -192
- data/lib/shipeasy_admin/models/get_experiment_timeseries_response_series_inner.rb +0 -278
- data/lib/shipeasy_admin/models/get_killswitch_response.rb +0 -270
- data/lib/shipeasy_admin/models/get_metric_response.rb +0 -378
- data/lib/shipeasy_admin/models/get_ops_item_response.rb +0 -349
- data/lib/shipeasy_admin/models/jules_trigger_config.rb +0 -240
- data/lib/shipeasy_admin/models/key_record.rb +0 -353
- data/lib/shipeasy_admin/models/link_pr_to_ops_item_request.rb +0 -186
- data/lib/shipeasy_admin/models/link_pr_to_ops_item_response.rb +0 -166
- data/lib/shipeasy_admin/models/list_alert_rules_response_inner.rb +0 -478
- data/lib/shipeasy_admin/models/list_attributes_response_inner.rb +0 -176
- data/lib/shipeasy_admin/models/list_config_activity_response_inner.rb +0 -280
- data/lib/shipeasy_admin/models/list_configs_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_configs_response_data_inner.rb +0 -351
- data/lib/shipeasy_admin/models/list_configs_response_data_inner_drafts_value.rb +0 -237
- data/lib/shipeasy_admin/models/list_configs_response_data_inner_envs_value.rb +0 -237
- data/lib/shipeasy_admin/models/list_events_response_inner.rb +0 -344
- data/lib/shipeasy_admin/models/list_events_response_inner_properties_inner.rb +0 -259
- data/lib/shipeasy_admin/models/list_experiments_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_experiments_response_data_inner.rb +0 -688
- data/lib/shipeasy_admin/models/list_experiments_response_data_inner_groups_inner.rb +0 -241
- data/lib/shipeasy_admin/models/list_gates_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_gates_response_data_inner.rb +0 -395
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_enabled.rb +0 -104
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_rules_inner.rb +0 -238
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner.rb +0 -105
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of.rb +0 -358
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of1.rb +0 -331
- data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of_ramp.rb +0 -319
- data/lib/shipeasy_admin/models/list_i18n_drafts_response_inner.rb +0 -272
- data/lib/shipeasy_admin/models/list_i18n_keys_response.rb +0 -195
- data/lib/shipeasy_admin/models/list_i18n_keys_response_keys_inner.rb +0 -274
- data/lib/shipeasy_admin/models/list_i18n_profiles_response_inner.rb +0 -224
- data/lib/shipeasy_admin/models/list_keys_response.rb +0 -180
- data/lib/shipeasy_admin/models/list_killswitches_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_killswitches_response_data_inner.rb +0 -270
- data/lib/shipeasy_admin/models/list_killswitches_response_data_inner_envs_value.rb +0 -248
- data/lib/shipeasy_admin/models/list_metrics_response_inner.rb +0 -378
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir.rb +0 -288
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg.rb +0 -113
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of1.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of2.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of3.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of4.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of5.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of6.rb +0 -188
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of7.rb +0 -217
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of8.rb +0 -233
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9.rb +0 -240
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator.rb +0 -266
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator_filters_inner.rb +0 -264
- data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_group_by.rb +0 -228
- data/lib/shipeasy_admin/models/list_ops_items_response_inner.rb +0 -349
- data/lib/shipeasy_admin/models/list_slack_channels_response.rb +0 -195
- data/lib/shipeasy_admin/models/list_slack_channels_response_channels_inner.rb +0 -203
- data/lib/shipeasy_admin/models/list_universes_response.rb +0 -178
- data/lib/shipeasy_admin/models/list_universes_response_data_inner.rb +0 -305
- data/lib/shipeasy_admin/models/notify_ops_request.rb +0 -261
- data/lib/shipeasy_admin/models/notify_ops_response.rb +0 -193
- data/lib/shipeasy_admin/models/publish_config_draft_request.rb +0 -187
- data/lib/shipeasy_admin/models/publish_config_draft_response.rb +0 -257
- data/lib/shipeasy_admin/models/publish_i18n_profile_response.rb +0 -391
- data/lib/shipeasy_admin/models/push_i18n_keys_request.rb +0 -195
- data/lib/shipeasy_admin/models/push_i18n_keys_request_keys_inner.rb +0 -192
- data/lib/shipeasy_admin/models/push_i18n_keys_response.rb +0 -251
- data/lib/shipeasy_admin/models/reanalyze_experiment_response.rb +0 -214
- data/lib/shipeasy_admin/models/revoke_key_response.rb +0 -216
- data/lib/shipeasy_admin/models/save_config_draft_request.rb +0 -199
- data/lib/shipeasy_admin/models/save_config_draft_response.rb +0 -283
- data/lib/shipeasy_admin/models/search_hit.rb +0 -284
- data/lib/shipeasy_admin/models/search_response.rb +0 -167
- data/lib/shipeasy_admin/models/set_experiment_metrics_request.rb +0 -168
- data/lib/shipeasy_admin/models/set_experiment_metrics_request_metrics_inner.rb +0 -216
- data/lib/shipeasy_admin/models/set_experiment_metrics_response.rb +0 -179
- data/lib/shipeasy_admin/models/set_experiment_metrics_response_metrics_inner.rb +0 -201
- data/lib/shipeasy_admin/models/set_experiment_status_request.rb +0 -190
- data/lib/shipeasy_admin/models/set_experiment_status_response.rb +0 -214
- data/lib/shipeasy_admin/models/set_i18n_label_request.rb +0 -213
- data/lib/shipeasy_admin/models/set_i18n_label_response.rb +0 -472
- data/lib/shipeasy_admin/models/set_killswitch_switch_response.rb +0 -285
- data/lib/shipeasy_admin/models/test_connector_response.rb +0 -189
- data/lib/shipeasy_admin/models/unset_killswitch_switch_request.rb +0 -234
- data/lib/shipeasy_admin/models/unset_killswitch_switch_response.rb +0 -286
- data/lib/shipeasy_admin/models/update_alert_rule_request.rb +0 -304
- data/lib/shipeasy_admin/models/update_alert_rule_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_config_request.rb +0 -198
- data/lib/shipeasy_admin/models/update_config_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_config_schema_request.rb +0 -168
- data/lib/shipeasy_admin/models/update_config_schema_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_connector_request.rb +0 -211
- data/lib/shipeasy_admin/models/update_connector_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_error_status_request.rb +0 -190
- data/lib/shipeasy_admin/models/update_event_request.rb +0 -198
- data/lib/shipeasy_admin/models/update_event_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_experiment_request.rb +0 -747
- data/lib/shipeasy_admin/models/update_experiment_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_gate_request.rb +0 -403
- data/lib/shipeasy_admin/models/update_gate_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_i18n_key_request.rb +0 -176
- data/lib/shipeasy_admin/models/update_i18n_key_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_killswitch_request.rb +0 -224
- data/lib/shipeasy_admin/models/update_killswitch_response.rb +0 -165
- data/lib/shipeasy_admin/models/update_ops_item_request.rb +0 -205
- data/lib/shipeasy_admin/models/update_ops_item_response.rb +0 -166
- data/lib/shipeasy_admin/models/update_universe_request.rb +0 -213
- data/lib/shipeasy_admin/models/update_universe_response.rb +0 -165
- data/lib/shipeasy_admin/models/upsert_project_request.rb +0 -222
- data/lib/shipeasy_admin/models/upsert_project_response.rb +0 -260
|
@@ -1,352 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
#Shipeasy Admin API
|
|
3
|
-
|
|
4
|
-
#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.
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 2.0.0
|
|
7
|
-
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.23.0
|
|
10
|
-
|
|
11
|
-
=end
|
|
12
|
-
|
|
13
|
-
require 'cgi'
|
|
14
|
-
|
|
15
|
-
module Shipeasy::Admin::Generated
|
|
16
|
-
class AlertsApi
|
|
17
|
-
attr_accessor :api_client
|
|
18
|
-
|
|
19
|
-
def initialize(api_client = ApiClient.default)
|
|
20
|
-
@api_client = api_client
|
|
21
|
-
end
|
|
22
|
-
# Create an alert rule
|
|
23
|
-
# Creates a metric-threshold alert rule. `name`, `metricId`, `comparator`, and `threshold` are required; `windowHours` defaults to `24`, `severity` to `warn`, and `enabled` to `true`. Returns `404` if `metricId` does not resolve, and `400` for a metric with no scalar form over a window (e.g. retention metrics) — the cron can't evaluate those. **Use cases** - **Threshold alert** — warn when an error/latency metric crosses a value over a rolling window. - **Routed alert** — set `notify` to page a specific Slack channel or on-call email instead of the project default.
|
|
24
|
-
# @param create_alert_rule_request [CreateAlertRuleRequest]
|
|
25
|
-
# @param [Hash] opts the optional parameters
|
|
26
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
27
|
-
# @return [CreateAlertRuleResponse]
|
|
28
|
-
def create_alert_rule(create_alert_rule_request, opts = {})
|
|
29
|
-
data, _status_code, _headers = create_alert_rule_with_http_info(create_alert_rule_request, opts)
|
|
30
|
-
data
|
|
31
|
-
end
|
|
32
|
-
|
|
33
|
-
# Create an alert rule
|
|
34
|
-
# Creates a metric-threshold alert rule. `name`, `metricId`, `comparator`, and `threshold` are required; `windowHours` defaults to `24`, `severity` to `warn`, and `enabled` to `true`. Returns `404` if `metricId` does not resolve, and `400` for a metric with no scalar form over a window (e.g. retention metrics) — the cron can't evaluate those. **Use cases** - **Threshold alert** — warn when an error/latency metric crosses a value over a rolling window. - **Routed alert** — set `notify` to page a specific Slack channel or on-call email instead of the project default.
|
|
35
|
-
# @param create_alert_rule_request [CreateAlertRuleRequest]
|
|
36
|
-
# @param [Hash] opts the optional parameters
|
|
37
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
38
|
-
# @return [Array<(CreateAlertRuleResponse, Integer, Hash)>] CreateAlertRuleResponse data, response status code and response headers
|
|
39
|
-
def create_alert_rule_with_http_info(create_alert_rule_request, opts = {})
|
|
40
|
-
if @api_client.config.debugging
|
|
41
|
-
@api_client.config.logger.debug 'Calling API: AlertsApi.create_alert_rule ...'
|
|
42
|
-
end
|
|
43
|
-
# verify the required parameter 'create_alert_rule_request' is set
|
|
44
|
-
if @api_client.config.client_side_validation && create_alert_rule_request.nil?
|
|
45
|
-
fail ArgumentError, "Missing the required parameter 'create_alert_rule_request' when calling AlertsApi.create_alert_rule"
|
|
46
|
-
end
|
|
47
|
-
# resource path
|
|
48
|
-
local_var_path = '/api/admin/alert-rules'
|
|
49
|
-
|
|
50
|
-
# query parameters
|
|
51
|
-
query_params = opts[:query_params] || {}
|
|
52
|
-
|
|
53
|
-
# header parameters
|
|
54
|
-
header_params = opts[:header_params] || {}
|
|
55
|
-
# HTTP header 'Accept' (if needed)
|
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
57
|
-
# HTTP header 'Content-Type'
|
|
58
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
59
|
-
if !content_type.nil?
|
|
60
|
-
header_params['Content-Type'] = content_type
|
|
61
|
-
end
|
|
62
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
63
|
-
|
|
64
|
-
# form parameters
|
|
65
|
-
form_params = opts[:form_params] || {}
|
|
66
|
-
|
|
67
|
-
# http body (model)
|
|
68
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_alert_rule_request)
|
|
69
|
-
|
|
70
|
-
# return_type
|
|
71
|
-
return_type = opts[:debug_return_type] || 'CreateAlertRuleResponse'
|
|
72
|
-
|
|
73
|
-
# auth_names
|
|
74
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
75
|
-
|
|
76
|
-
new_options = opts.merge(
|
|
77
|
-
:operation => :"AlertsApi.create_alert_rule",
|
|
78
|
-
:header_params => header_params,
|
|
79
|
-
:query_params => query_params,
|
|
80
|
-
:form_params => form_params,
|
|
81
|
-
:body => post_body,
|
|
82
|
-
:auth_names => auth_names,
|
|
83
|
-
:return_type => return_type
|
|
84
|
-
)
|
|
85
|
-
|
|
86
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
87
|
-
if @api_client.config.debugging
|
|
88
|
-
@api_client.config.logger.debug "API called: AlertsApi#create_alert_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
89
|
-
end
|
|
90
|
-
return data, status_code, headers
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
# Delete an alert rule
|
|
94
|
-
# Deletes the alert rule. The cron stops evaluating it immediately. Use this (then create a new rule) to repoint alerting at a different metric, since `metricId` is immutable. **Use case:** Remove an alert rule that is no longer needed, or as the first half of repointing a rule at a different metric.
|
|
95
|
-
# @param id [String] Stable opaque alert-rule id (`ar_…`) or the rule's `name`.
|
|
96
|
-
# @param [Hash] opts the optional parameters
|
|
97
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
98
|
-
# @return [DeleteAlertRuleResponse]
|
|
99
|
-
def delete_alert_rule(id, opts = {})
|
|
100
|
-
data, _status_code, _headers = delete_alert_rule_with_http_info(id, opts)
|
|
101
|
-
data
|
|
102
|
-
end
|
|
103
|
-
|
|
104
|
-
# Delete an alert rule
|
|
105
|
-
# Deletes the alert rule. The cron stops evaluating it immediately. Use this (then create a new rule) to repoint alerting at a different metric, since `metricId` is immutable. **Use case:** Remove an alert rule that is no longer needed, or as the first half of repointing a rule at a different metric.
|
|
106
|
-
# @param id [String] Stable opaque alert-rule id (`ar_…`) or the rule's `name`.
|
|
107
|
-
# @param [Hash] opts the optional parameters
|
|
108
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
109
|
-
# @return [Array<(DeleteAlertRuleResponse, Integer, Hash)>] DeleteAlertRuleResponse data, response status code and response headers
|
|
110
|
-
def delete_alert_rule_with_http_info(id, opts = {})
|
|
111
|
-
if @api_client.config.debugging
|
|
112
|
-
@api_client.config.logger.debug 'Calling API: AlertsApi.delete_alert_rule ...'
|
|
113
|
-
end
|
|
114
|
-
# resource path
|
|
115
|
-
local_var_path = '/api/admin/alert-rules/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
116
|
-
|
|
117
|
-
# query parameters
|
|
118
|
-
query_params = opts[:query_params] || {}
|
|
119
|
-
|
|
120
|
-
# header parameters
|
|
121
|
-
header_params = opts[:header_params] || {}
|
|
122
|
-
# HTTP header 'Accept' (if needed)
|
|
123
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
124
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
125
|
-
|
|
126
|
-
# form parameters
|
|
127
|
-
form_params = opts[:form_params] || {}
|
|
128
|
-
|
|
129
|
-
# http body (model)
|
|
130
|
-
post_body = opts[:debug_body]
|
|
131
|
-
|
|
132
|
-
# return_type
|
|
133
|
-
return_type = opts[:debug_return_type] || 'DeleteAlertRuleResponse'
|
|
134
|
-
|
|
135
|
-
# auth_names
|
|
136
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
137
|
-
|
|
138
|
-
new_options = opts.merge(
|
|
139
|
-
:operation => :"AlertsApi.delete_alert_rule",
|
|
140
|
-
:header_params => header_params,
|
|
141
|
-
:query_params => query_params,
|
|
142
|
-
:form_params => form_params,
|
|
143
|
-
:body => post_body,
|
|
144
|
-
:auth_names => auth_names,
|
|
145
|
-
:return_type => return_type
|
|
146
|
-
)
|
|
147
|
-
|
|
148
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
149
|
-
if @api_client.config.debugging
|
|
150
|
-
@api_client.config.logger.debug "API called: AlertsApi#delete_alert_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
151
|
-
end
|
|
152
|
-
return data, status_code, headers
|
|
153
|
-
end
|
|
154
|
-
|
|
155
|
-
# List alert rules
|
|
156
|
-
# Returns every alert rule in the project (not paginated). Each rule carries its bound `metricId`, the denormalised `metricName` (or `null` if the metric was removed), the comparator/threshold/window, severity, enabled flag, and delivery target. **Use case:** Audit which metrics have alerting configured — for example to confirm an on-call threshold is set before a launch.
|
|
157
|
-
# @param [Hash] opts the optional parameters
|
|
158
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
159
|
-
# @return [Array<ListAlertRulesResponseInner>]
|
|
160
|
-
def list_alert_rules(opts = {})
|
|
161
|
-
data, _status_code, _headers = list_alert_rules_with_http_info(opts)
|
|
162
|
-
data
|
|
163
|
-
end
|
|
164
|
-
|
|
165
|
-
# List alert rules
|
|
166
|
-
# Returns every alert rule in the project (not paginated). Each rule carries its bound `metricId`, the denormalised `metricName` (or `null` if the metric was removed), the comparator/threshold/window, severity, enabled flag, and delivery target. **Use case:** Audit which metrics have alerting configured — for example to confirm an on-call threshold is set before a launch.
|
|
167
|
-
# @param [Hash] opts the optional parameters
|
|
168
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
169
|
-
# @return [Array<(Array<ListAlertRulesResponseInner>, Integer, Hash)>] Array<ListAlertRulesResponseInner> data, response status code and response headers
|
|
170
|
-
def list_alert_rules_with_http_info(opts = {})
|
|
171
|
-
if @api_client.config.debugging
|
|
172
|
-
@api_client.config.logger.debug 'Calling API: AlertsApi.list_alert_rules ...'
|
|
173
|
-
end
|
|
174
|
-
# resource path
|
|
175
|
-
local_var_path = '/api/admin/alert-rules'
|
|
176
|
-
|
|
177
|
-
# query parameters
|
|
178
|
-
query_params = opts[:query_params] || {}
|
|
179
|
-
|
|
180
|
-
# header parameters
|
|
181
|
-
header_params = opts[:header_params] || {}
|
|
182
|
-
# HTTP header 'Accept' (if needed)
|
|
183
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
184
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
185
|
-
|
|
186
|
-
# form parameters
|
|
187
|
-
form_params = opts[:form_params] || {}
|
|
188
|
-
|
|
189
|
-
# http body (model)
|
|
190
|
-
post_body = opts[:debug_body]
|
|
191
|
-
|
|
192
|
-
# return_type
|
|
193
|
-
return_type = opts[:debug_return_type] || 'Array<ListAlertRulesResponseInner>'
|
|
194
|
-
|
|
195
|
-
# auth_names
|
|
196
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
197
|
-
|
|
198
|
-
new_options = opts.merge(
|
|
199
|
-
:operation => :"AlertsApi.list_alert_rules",
|
|
200
|
-
:header_params => header_params,
|
|
201
|
-
:query_params => query_params,
|
|
202
|
-
:form_params => form_params,
|
|
203
|
-
:body => post_body,
|
|
204
|
-
:auth_names => auth_names,
|
|
205
|
-
:return_type => return_type
|
|
206
|
-
)
|
|
207
|
-
|
|
208
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
209
|
-
if @api_client.config.debugging
|
|
210
|
-
@api_client.config.logger.debug "API called: AlertsApi#list_alert_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
211
|
-
end
|
|
212
|
-
return data, status_code, headers
|
|
213
|
-
end
|
|
214
|
-
|
|
215
|
-
# List Slack channels
|
|
216
|
-
# List the project's connected Slack channels — used to resolve an alert rule's notification target. **Use case:** Populate a channel picker, or validate an alert rule's `--slack-channel` before saving.
|
|
217
|
-
# @param [Hash] opts the optional parameters
|
|
218
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
219
|
-
# @return [ListSlackChannelsResponse]
|
|
220
|
-
def list_slack_channels(opts = {})
|
|
221
|
-
data, _status_code, _headers = list_slack_channels_with_http_info(opts)
|
|
222
|
-
data
|
|
223
|
-
end
|
|
224
|
-
|
|
225
|
-
# List Slack channels
|
|
226
|
-
# List the project's connected Slack channels — used to resolve an alert rule's notification target. **Use case:** Populate a channel picker, or validate an alert rule's `--slack-channel` before saving.
|
|
227
|
-
# @param [Hash] opts the optional parameters
|
|
228
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
229
|
-
# @return [Array<(ListSlackChannelsResponse, Integer, Hash)>] ListSlackChannelsResponse data, response status code and response headers
|
|
230
|
-
def list_slack_channels_with_http_info(opts = {})
|
|
231
|
-
if @api_client.config.debugging
|
|
232
|
-
@api_client.config.logger.debug 'Calling API: AlertsApi.list_slack_channels ...'
|
|
233
|
-
end
|
|
234
|
-
# resource path
|
|
235
|
-
local_var_path = '/api/admin/slack/channels'
|
|
236
|
-
|
|
237
|
-
# query parameters
|
|
238
|
-
query_params = opts[:query_params] || {}
|
|
239
|
-
|
|
240
|
-
# header parameters
|
|
241
|
-
header_params = opts[:header_params] || {}
|
|
242
|
-
# HTTP header 'Accept' (if needed)
|
|
243
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
244
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
245
|
-
|
|
246
|
-
# form parameters
|
|
247
|
-
form_params = opts[:form_params] || {}
|
|
248
|
-
|
|
249
|
-
# http body (model)
|
|
250
|
-
post_body = opts[:debug_body]
|
|
251
|
-
|
|
252
|
-
# return_type
|
|
253
|
-
return_type = opts[:debug_return_type] || 'ListSlackChannelsResponse'
|
|
254
|
-
|
|
255
|
-
# auth_names
|
|
256
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
257
|
-
|
|
258
|
-
new_options = opts.merge(
|
|
259
|
-
:operation => :"AlertsApi.list_slack_channels",
|
|
260
|
-
:header_params => header_params,
|
|
261
|
-
:query_params => query_params,
|
|
262
|
-
:form_params => form_params,
|
|
263
|
-
:body => post_body,
|
|
264
|
-
:auth_names => auth_names,
|
|
265
|
-
:return_type => return_type
|
|
266
|
-
)
|
|
267
|
-
|
|
268
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
269
|
-
if @api_client.config.debugging
|
|
270
|
-
@api_client.config.logger.debug "API called: AlertsApi#list_slack_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
271
|
-
end
|
|
272
|
-
return data, status_code, headers
|
|
273
|
-
end
|
|
274
|
-
|
|
275
|
-
# Update an alert rule
|
|
276
|
-
# Partial update of a rule's tunable knobs. `metricId` is immutable — it is rejected by the schema (the metric also pins the aggregation), so delete + recreate to repoint a rule. Pass `\"notify\": null` to revert the rule's delivery target back to the project default. **Use cases** - **Tune sensitivity** — change `threshold`/`comparator`/`windowHours` as the metric's baseline shifts. - **Pause without losing config** — `{ \"enabled\": false }` instead of deleting the rule.
|
|
277
|
-
# @param id [String] Stable opaque alert-rule id (`ar_…`) or the rule's `name`.
|
|
278
|
-
# @param update_alert_rule_request [UpdateAlertRuleRequest]
|
|
279
|
-
# @param [Hash] opts the optional parameters
|
|
280
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
281
|
-
# @return [UpdateAlertRuleResponse]
|
|
282
|
-
def update_alert_rule(id, update_alert_rule_request, opts = {})
|
|
283
|
-
data, _status_code, _headers = update_alert_rule_with_http_info(id, update_alert_rule_request, opts)
|
|
284
|
-
data
|
|
285
|
-
end
|
|
286
|
-
|
|
287
|
-
# Update an alert rule
|
|
288
|
-
# Partial update of a rule's tunable knobs. `metricId` is immutable — it is rejected by the schema (the metric also pins the aggregation), so delete + recreate to repoint a rule. Pass `\"notify\": null` to revert the rule's delivery target back to the project default. **Use cases** - **Tune sensitivity** — change `threshold`/`comparator`/`windowHours` as the metric's baseline shifts. - **Pause without losing config** — `{ \"enabled\": false }` instead of deleting the rule.
|
|
289
|
-
# @param id [String] Stable opaque alert-rule id (`ar_…`) or the rule's `name`.
|
|
290
|
-
# @param update_alert_rule_request [UpdateAlertRuleRequest]
|
|
291
|
-
# @param [Hash] opts the optional parameters
|
|
292
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
293
|
-
# @return [Array<(UpdateAlertRuleResponse, Integer, Hash)>] UpdateAlertRuleResponse data, response status code and response headers
|
|
294
|
-
def update_alert_rule_with_http_info(id, update_alert_rule_request, opts = {})
|
|
295
|
-
if @api_client.config.debugging
|
|
296
|
-
@api_client.config.logger.debug 'Calling API: AlertsApi.update_alert_rule ...'
|
|
297
|
-
end
|
|
298
|
-
# verify the required parameter 'id' is set
|
|
299
|
-
if @api_client.config.client_side_validation && id.nil?
|
|
300
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling AlertsApi.update_alert_rule"
|
|
301
|
-
end
|
|
302
|
-
# verify the required parameter 'update_alert_rule_request' is set
|
|
303
|
-
if @api_client.config.client_side_validation && update_alert_rule_request.nil?
|
|
304
|
-
fail ArgumentError, "Missing the required parameter 'update_alert_rule_request' when calling AlertsApi.update_alert_rule"
|
|
305
|
-
end
|
|
306
|
-
# resource path
|
|
307
|
-
local_var_path = '/api/admin/alert-rules/{id}'.sub('{id}', CGI.escape(id.to_s))
|
|
308
|
-
|
|
309
|
-
# query parameters
|
|
310
|
-
query_params = opts[:query_params] || {}
|
|
311
|
-
|
|
312
|
-
# header parameters
|
|
313
|
-
header_params = opts[:header_params] || {}
|
|
314
|
-
# HTTP header 'Accept' (if needed)
|
|
315
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
316
|
-
# HTTP header 'Content-Type'
|
|
317
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
318
|
-
if !content_type.nil?
|
|
319
|
-
header_params['Content-Type'] = content_type
|
|
320
|
-
end
|
|
321
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
322
|
-
|
|
323
|
-
# form parameters
|
|
324
|
-
form_params = opts[:form_params] || {}
|
|
325
|
-
|
|
326
|
-
# http body (model)
|
|
327
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_alert_rule_request)
|
|
328
|
-
|
|
329
|
-
# return_type
|
|
330
|
-
return_type = opts[:debug_return_type] || 'UpdateAlertRuleResponse'
|
|
331
|
-
|
|
332
|
-
# auth_names
|
|
333
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
334
|
-
|
|
335
|
-
new_options = opts.merge(
|
|
336
|
-
:operation => :"AlertsApi.update_alert_rule",
|
|
337
|
-
:header_params => header_params,
|
|
338
|
-
:query_params => query_params,
|
|
339
|
-
:form_params => form_params,
|
|
340
|
-
:body => post_body,
|
|
341
|
-
:auth_names => auth_names,
|
|
342
|
-
:return_type => return_type
|
|
343
|
-
)
|
|
344
|
-
|
|
345
|
-
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
346
|
-
if @api_client.config.debugging
|
|
347
|
-
@api_client.config.logger.debug "API called: AlertsApi#update_alert_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
348
|
-
end
|
|
349
|
-
return data, status_code, headers
|
|
350
|
-
end
|
|
351
|
-
end
|
|
352
|
-
end
|
|
@@ -1,229 +0,0 @@
|
|
|
1
|
-
=begin
|
|
2
|
-
#Shipeasy Admin API
|
|
3
|
-
|
|
4
|
-
#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.
|
|
5
|
-
|
|
6
|
-
The version of the OpenAPI document: 2.0.0
|
|
7
|
-
|
|
8
|
-
Generated by: https://openapi-generator.tech
|
|
9
|
-
Generator version: 7.23.0
|
|
10
|
-
|
|
11
|
-
=end
|
|
12
|
-
|
|
13
|
-
require 'cgi'
|
|
14
|
-
|
|
15
|
-
module Shipeasy::Admin::Generated
|
|
16
|
-
class APIKeysApi
|
|
17
|
-
attr_accessor :api_client
|
|
18
|
-
|
|
19
|
-
def initialize(api_client = ApiClient.default)
|
|
20
|
-
@api_client = api_client
|
|
21
|
-
end
|
|
22
|
-
# Create an API key
|
|
23
|
-
# Mints a new API key and returns the plaintext token **once** — it is stored hashed and can never be retrieved again, so capture it on creation. Only `type` is required. `env` is **required** for `server` and `client` keys (the key is bound to one environment, which is the read-env isolation boundary); for `admin` and `ops` keys `env` is ignored and the key is pinned to `prod`. Expiry is fixed for some types: `admin` keys always get a 90-day expiry and `ops` keys a short sliding window, regardless of `expiresInDays`. Only `server`/`client` keys count toward the plan key limit. **Use cases** - **Back-end key** — `{ \"type\": \"server\", \"env\": \"prod\" }` for the production server SDK. - **Public browser key** — `{ \"type\": \"client\", \"env\": \"prod\", \"name\": \"marketing site\" }` to embed in the browser SDK. - **Scoped, expiring key** — `{ \"type\": \"server\", \"env\": \"staging\", \"scopes\": [\"gates:evaluate\"], \"expiresInDays\": 30 }` for a time-boxed integration.
|
|
24
|
-
# @param create_key_request [CreateKeyRequest]
|
|
25
|
-
# @param [Hash] opts the optional parameters
|
|
26
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
27
|
-
# @return [CreateKeyResponse]
|
|
28
|
-
def create_key(create_key_request, opts = {})
|
|
29
|
-
data, _status_code, _headers = create_key_with_http_info(create_key_request, opts)
|
|
30
|
-
data
|
|
31
|
-
end
|
|
32
|
-
|
|
33
|
-
# Create an API key
|
|
34
|
-
# Mints a new API key and returns the plaintext token **once** — it is stored hashed and can never be retrieved again, so capture it on creation. Only `type` is required. `env` is **required** for `server` and `client` keys (the key is bound to one environment, which is the read-env isolation boundary); for `admin` and `ops` keys `env` is ignored and the key is pinned to `prod`. Expiry is fixed for some types: `admin` keys always get a 90-day expiry and `ops` keys a short sliding window, regardless of `expiresInDays`. Only `server`/`client` keys count toward the plan key limit. **Use cases** - **Back-end key** — `{ \"type\": \"server\", \"env\": \"prod\" }` for the production server SDK. - **Public browser key** — `{ \"type\": \"client\", \"env\": \"prod\", \"name\": \"marketing site\" }` to embed in the browser SDK. - **Scoped, expiring key** — `{ \"type\": \"server\", \"env\": \"staging\", \"scopes\": [\"gates:evaluate\"], \"expiresInDays\": 30 }` for a time-boxed integration.
|
|
35
|
-
# @param create_key_request [CreateKeyRequest]
|
|
36
|
-
# @param [Hash] opts the optional parameters
|
|
37
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
38
|
-
# @return [Array<(CreateKeyResponse, Integer, Hash)>] CreateKeyResponse data, response status code and response headers
|
|
39
|
-
def create_key_with_http_info(create_key_request, opts = {})
|
|
40
|
-
if @api_client.config.debugging
|
|
41
|
-
@api_client.config.logger.debug 'Calling API: APIKeysApi.create_key ...'
|
|
42
|
-
end
|
|
43
|
-
# verify the required parameter 'create_key_request' is set
|
|
44
|
-
if @api_client.config.client_side_validation && create_key_request.nil?
|
|
45
|
-
fail ArgumentError, "Missing the required parameter 'create_key_request' when calling APIKeysApi.create_key"
|
|
46
|
-
end
|
|
47
|
-
# resource path
|
|
48
|
-
local_var_path = '/api/admin/keys'
|
|
49
|
-
|
|
50
|
-
# query parameters
|
|
51
|
-
query_params = opts[:query_params] || {}
|
|
52
|
-
|
|
53
|
-
# header parameters
|
|
54
|
-
header_params = opts[:header_params] || {}
|
|
55
|
-
# HTTP header 'Accept' (if needed)
|
|
56
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
57
|
-
# HTTP header 'Content-Type'
|
|
58
|
-
content_type = @api_client.select_header_content_type(['application/json'])
|
|
59
|
-
if !content_type.nil?
|
|
60
|
-
header_params['Content-Type'] = content_type
|
|
61
|
-
end
|
|
62
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
63
|
-
|
|
64
|
-
# form parameters
|
|
65
|
-
form_params = opts[:form_params] || {}
|
|
66
|
-
|
|
67
|
-
# http body (model)
|
|
68
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_key_request)
|
|
69
|
-
|
|
70
|
-
# return_type
|
|
71
|
-
return_type = opts[:debug_return_type] || 'CreateKeyResponse'
|
|
72
|
-
|
|
73
|
-
# auth_names
|
|
74
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
75
|
-
|
|
76
|
-
new_options = opts.merge(
|
|
77
|
-
:operation => :"APIKeysApi.create_key",
|
|
78
|
-
:header_params => header_params,
|
|
79
|
-
:query_params => query_params,
|
|
80
|
-
:form_params => form_params,
|
|
81
|
-
:body => post_body,
|
|
82
|
-
:auth_names => auth_names,
|
|
83
|
-
:return_type => return_type
|
|
84
|
-
)
|
|
85
|
-
|
|
86
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
87
|
-
if @api_client.config.debugging
|
|
88
|
-
@api_client.config.logger.debug "API called: APIKeysApi#create_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
89
|
-
end
|
|
90
|
-
return data, status_code, headers
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
# List API keys
|
|
94
|
-
# Returns a single page of the project's API keys ordered by `created_at desc, id desc`, in the standard `{ data, next_cursor }` envelope. Use the `cursor` query parameter to paginate. Response fields are **snake_case** (`created_at`, `revoked_at`, `created_by_email`, `last4`). The raw token is never returned — only its `last4` tail, so a held key can be matched against the masked row. Revoked keys are included (with a non-null `revoked_at`). **Use case:** Audit which keys exist for a project — surface stale or never-expiring keys, or drive a CI check that asserts no `client` key is still active in `prod` after a rotation.
|
|
95
|
-
# @param [Hash] opts the optional parameters
|
|
96
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
97
|
-
# @option opts [Integer] :limit Page size (1–500). Defaults to 100. (default to 100)
|
|
98
|
-
# @option opts [String] :cursor Opaque cursor returned in the previous page's `next_cursor`. Omit for the first page.
|
|
99
|
-
# @return [ListKeysResponse]
|
|
100
|
-
def list_keys(opts = {})
|
|
101
|
-
data, _status_code, _headers = list_keys_with_http_info(opts)
|
|
102
|
-
data
|
|
103
|
-
end
|
|
104
|
-
|
|
105
|
-
# List API keys
|
|
106
|
-
# Returns a single page of the project's API keys ordered by `created_at desc, id desc`, in the standard `{ data, next_cursor }` envelope. Use the `cursor` query parameter to paginate. Response fields are **snake_case** (`created_at`, `revoked_at`, `created_by_email`, `last4`). The raw token is never returned — only its `last4` tail, so a held key can be matched against the masked row. Revoked keys are included (with a non-null `revoked_at`). **Use case:** Audit which keys exist for a project — surface stale or never-expiring keys, or drive a CI check that asserts no `client` key is still active in `prod` after a rotation.
|
|
107
|
-
# @param [Hash] opts the optional parameters
|
|
108
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
109
|
-
# @option opts [Integer] :limit Page size (1–500). Defaults to 100. (default to 100)
|
|
110
|
-
# @option opts [String] :cursor Opaque cursor returned in the previous page's `next_cursor`. Omit for the first page.
|
|
111
|
-
# @return [Array<(ListKeysResponse, Integer, Hash)>] ListKeysResponse data, response status code and response headers
|
|
112
|
-
def list_keys_with_http_info(opts = {})
|
|
113
|
-
if @api_client.config.debugging
|
|
114
|
-
@api_client.config.logger.debug 'Calling API: APIKeysApi.list_keys ...'
|
|
115
|
-
end
|
|
116
|
-
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
|
|
117
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling APIKeysApi.list_keys, must be smaller than or equal to 500.'
|
|
118
|
-
end
|
|
119
|
-
|
|
120
|
-
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
121
|
-
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling APIKeysApi.list_keys, must be greater than or equal to 1.'
|
|
122
|
-
end
|
|
123
|
-
|
|
124
|
-
# resource path
|
|
125
|
-
local_var_path = '/api/admin/keys'
|
|
126
|
-
|
|
127
|
-
# query parameters
|
|
128
|
-
query_params = opts[:query_params] || {}
|
|
129
|
-
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
130
|
-
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
131
|
-
|
|
132
|
-
# header parameters
|
|
133
|
-
header_params = opts[:header_params] || {}
|
|
134
|
-
# HTTP header 'Accept' (if needed)
|
|
135
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
136
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
137
|
-
|
|
138
|
-
# form parameters
|
|
139
|
-
form_params = opts[:form_params] || {}
|
|
140
|
-
|
|
141
|
-
# http body (model)
|
|
142
|
-
post_body = opts[:debug_body]
|
|
143
|
-
|
|
144
|
-
# return_type
|
|
145
|
-
return_type = opts[:debug_return_type] || 'ListKeysResponse'
|
|
146
|
-
|
|
147
|
-
# auth_names
|
|
148
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
149
|
-
|
|
150
|
-
new_options = opts.merge(
|
|
151
|
-
:operation => :"APIKeysApi.list_keys",
|
|
152
|
-
:header_params => header_params,
|
|
153
|
-
:query_params => query_params,
|
|
154
|
-
:form_params => form_params,
|
|
155
|
-
:body => post_body,
|
|
156
|
-
:auth_names => auth_names,
|
|
157
|
-
:return_type => return_type
|
|
158
|
-
)
|
|
159
|
-
|
|
160
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
161
|
-
if @api_client.config.debugging
|
|
162
|
-
@api_client.config.logger.debug "API called: APIKeysApi#list_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
163
|
-
end
|
|
164
|
-
return data, status_code, headers
|
|
165
|
-
end
|
|
166
|
-
|
|
167
|
-
# Revoke an API key
|
|
168
|
-
# Revokes a key by id — stamps its `revoked_at` and deletes the hot-path KV entry so the token stops authenticating immediately. Takes no body. Idempotent: revoking an already-revoked key is a no-op and returns the same `{ id, revoked: true }`. Returns `404` if no such key exists in the project. **Use case:** Rotate a leaked or stale credential — mint the replacement, then revoke the old key.
|
|
169
|
-
# @param id [String] Stable opaque key id (UUID) returned by `create` / `list`.
|
|
170
|
-
# @param [Hash] opts the optional parameters
|
|
171
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
172
|
-
# @return [RevokeKeyResponse]
|
|
173
|
-
def revoke_key(id, opts = {})
|
|
174
|
-
data, _status_code, _headers = revoke_key_with_http_info(id, opts)
|
|
175
|
-
data
|
|
176
|
-
end
|
|
177
|
-
|
|
178
|
-
# Revoke an API key
|
|
179
|
-
# Revokes a key by id — stamps its `revoked_at` and deletes the hot-path KV entry so the token stops authenticating immediately. Takes no body. Idempotent: revoking an already-revoked key is a no-op and returns the same `{ id, revoked: true }`. Returns `404` if no such key exists in the project. **Use case:** Rotate a leaked or stale credential — mint the replacement, then revoke the old key.
|
|
180
|
-
# @param id [String] Stable opaque key id (UUID) returned by `create` / `list`.
|
|
181
|
-
# @param [Hash] opts the optional parameters
|
|
182
|
-
# @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
|
|
183
|
-
# @return [Array<(RevokeKeyResponse, Integer, Hash)>] RevokeKeyResponse data, response status code and response headers
|
|
184
|
-
def revoke_key_with_http_info(id, opts = {})
|
|
185
|
-
if @api_client.config.debugging
|
|
186
|
-
@api_client.config.logger.debug 'Calling API: APIKeysApi.revoke_key ...'
|
|
187
|
-
end
|
|
188
|
-
# resource path
|
|
189
|
-
local_var_path = '/api/admin/keys/{id}/revoke'.sub('{id}', CGI.escape(id.to_s))
|
|
190
|
-
|
|
191
|
-
# query parameters
|
|
192
|
-
query_params = opts[:query_params] || {}
|
|
193
|
-
|
|
194
|
-
# header parameters
|
|
195
|
-
header_params = opts[:header_params] || {}
|
|
196
|
-
# HTTP header 'Accept' (if needed)
|
|
197
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
198
|
-
header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
|
|
199
|
-
|
|
200
|
-
# form parameters
|
|
201
|
-
form_params = opts[:form_params] || {}
|
|
202
|
-
|
|
203
|
-
# http body (model)
|
|
204
|
-
post_body = opts[:debug_body]
|
|
205
|
-
|
|
206
|
-
# return_type
|
|
207
|
-
return_type = opts[:debug_return_type] || 'RevokeKeyResponse'
|
|
208
|
-
|
|
209
|
-
# auth_names
|
|
210
|
-
auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
|
|
211
|
-
|
|
212
|
-
new_options = opts.merge(
|
|
213
|
-
:operation => :"APIKeysApi.revoke_key",
|
|
214
|
-
:header_params => header_params,
|
|
215
|
-
:query_params => query_params,
|
|
216
|
-
:form_params => form_params,
|
|
217
|
-
:body => post_body,
|
|
218
|
-
:auth_names => auth_names,
|
|
219
|
-
:return_type => return_type
|
|
220
|
-
)
|
|
221
|
-
|
|
222
|
-
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
223
|
-
if @api_client.config.debugging
|
|
224
|
-
@api_client.config.logger.debug "API called: APIKeysApi#revoke_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
225
|
-
end
|
|
226
|
-
return data, status_code, headers
|
|
227
|
-
end
|
|
228
|
-
end
|
|
229
|
-
end
|