shipeasy-sdk 3.7.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.
Files changed (220) hide show
  1. checksums.yaml +4 -4
  2. data/docs/skill/SKILL.md +7 -4
  3. data/lib/shipeasy/admin.rb +23 -20
  4. data/lib/shipeasy/engine.rb +6 -4
  5. data/lib/shipeasy/sdk/see.rb +7 -5
  6. data/lib/shipeasy/sdk/version.rb +1 -1
  7. data/lib/shipeasy_admin/api/flags_api.rb +127 -214
  8. data/lib/shipeasy_admin/api/killswitch_api.rb +25 -525
  9. data/lib/shipeasy_admin/api/ops_api.rb +44 -351
  10. data/lib/shipeasy_admin/api_client.rb +2 -2
  11. data/lib/shipeasy_admin/api_error.rb +2 -2
  12. data/lib/shipeasy_admin/api_model_base.rb +2 -2
  13. data/lib/shipeasy_admin/configuration.rb +29 -2
  14. data/lib/shipeasy_admin/models/{set_killswitch_value_request.rb → add_to_gate_whitelist_request.rb} +37 -42
  15. data/lib/shipeasy_admin/models/create_public_bug_request.rb +464 -0
  16. data/lib/shipeasy_admin/models/create_public_feature_request_request.rb +407 -0
  17. data/lib/shipeasy_admin/models/{file_error_ticket_response.rb → create_public_ticket_response.rb} +22 -29
  18. data/lib/shipeasy_admin/models/env.rb +2 -2
  19. data/lib/shipeasy_admin/models/error.rb +41 -7
  20. data/lib/shipeasy_admin/models/error_code.rb +14 -3
  21. data/lib/shipeasy_admin/models/{get_experiment_timeseries_response_experiment.rb → gate_whitelist.rb} +51 -42
  22. data/lib/shipeasy_admin/models/gate_whitelist_attr.rb +40 -0
  23. data/lib/shipeasy_admin/models/killswitch_value.rb +2 -2
  24. data/lib/shipeasy_admin/models/notification_target.rb +2 -2
  25. data/lib/shipeasy_admin/models/notification_target_slack_channel.rb +2 -2
  26. data/lib/shipeasy_admin/models/ops_item_priority.rb +42 -0
  27. data/lib/shipeasy_admin/models/ops_item_status.rb +46 -0
  28. data/lib/shipeasy_admin/models/{discard_config_draft_request.rb → remove_from_gate_whitelist_request.rb} +34 -44
  29. data/lib/shipeasy_admin/models/{delete_alert_rule_response.rb → set_gate_whitelist_request.rb} +37 -25
  30. data/lib/shipeasy_admin/models/{set_killswitch_switch_request.rb → toggle_killswitch_request.rb} +30 -72
  31. data/lib/shipeasy_admin/models/{set_killswitch_value_response.rb → toggle_killswitch_response.rb} +100 -6
  32. data/lib/shipeasy_admin/version.rb +2 -2
  33. data/lib/shipeasy_admin.rb +14 -195
  34. metadata +14 -195
  35. data/lib/shipeasy_admin/api/alerts_api.rb +0 -352
  36. data/lib/shipeasy_admin/api/api_keys_api.rb +0 -229
  37. data/lib/shipeasy_admin/api/attributes_api.rb +0 -82
  38. data/lib/shipeasy_admin/api/configs_api.rb +0 -757
  39. data/lib/shipeasy_admin/api/connectors_api.rb +0 -497
  40. data/lib/shipeasy_admin/api/drafts_api.rb +0 -82
  41. data/lib/shipeasy_admin/api/errors_api.rb +0 -389
  42. data/lib/shipeasy_admin/api/events_api.rb +0 -438
  43. data/lib/shipeasy_admin/api/experiments_api.rb +0 -727
  44. data/lib/shipeasy_admin/api/keys_api.rb +0 -317
  45. data/lib/shipeasy_admin/api/metrics_api.rb +0 -281
  46. data/lib/shipeasy_admin/api/profiles_api.rb +0 -222
  47. data/lib/shipeasy_admin/api/projects_api.rb +0 -216
  48. data/lib/shipeasy_admin/api/universes_api.rb +0 -306
  49. data/lib/shipeasy_admin/models/approve_event_request.rb +0 -198
  50. data/lib/shipeasy_admin/models/approve_event_response.rb +0 -166
  51. data/lib/shipeasy_admin/models/claude_trigger_config.rb +0 -204
  52. data/lib/shipeasy_admin/models/connector_event.rb +0 -40
  53. data/lib/shipeasy_admin/models/connector_provider.rb +0 -45
  54. data/lib/shipeasy_admin/models/connector_record.rb +0 -468
  55. data/lib/shipeasy_admin/models/copilot_trigger_config.rb +0 -276
  56. data/lib/shipeasy_admin/models/create_alert_rule_request.rb +0 -383
  57. data/lib/shipeasy_admin/models/create_alert_rule_response.rb +0 -165
  58. data/lib/shipeasy_admin/models/create_claude_trigger_request.rb +0 -309
  59. data/lib/shipeasy_admin/models/create_config_request.rb +0 -291
  60. data/lib/shipeasy_admin/models/create_config_response.rb +0 -201
  61. data/lib/shipeasy_admin/models/create_connector_request.rb +0 -64
  62. data/lib/shipeasy_admin/models/create_connector_response.rb +0 -165
  63. data/lib/shipeasy_admin/models/create_copilot_trigger_request.rb +0 -316
  64. data/lib/shipeasy_admin/models/create_cursor_trigger_request.rb +0 -352
  65. data/lib/shipeasy_admin/models/create_event_request.rb +0 -236
  66. data/lib/shipeasy_admin/models/create_event_response.rb +0 -193
  67. data/lib/shipeasy_admin/models/create_experiment_request.rb +0 -807
  68. data/lib/shipeasy_admin/models/create_experiment_response.rb +0 -212
  69. data/lib/shipeasy_admin/models/create_gate_request.rb +0 -492
  70. data/lib/shipeasy_admin/models/create_gate_response.rb +0 -212
  71. data/lib/shipeasy_admin/models/create_i18n_profile_request.rb +0 -188
  72. data/lib/shipeasy_admin/models/create_i18n_profile_response.rb +0 -193
  73. data/lib/shipeasy_admin/models/create_jules_trigger_request.rb +0 -352
  74. data/lib/shipeasy_admin/models/create_key_request.rb +0 -297
  75. data/lib/shipeasy_admin/models/create_key_response.rb +0 -286
  76. data/lib/shipeasy_admin/models/create_killswitch_request.rb +0 -274
  77. data/lib/shipeasy_admin/models/create_killswitch_response.rb +0 -201
  78. data/lib/shipeasy_admin/models/create_metric_request.rb +0 -403
  79. data/lib/shipeasy_admin/models/create_metric_response.rb +0 -193
  80. data/lib/shipeasy_admin/models/create_o_auth_connector_request.rb +0 -273
  81. data/lib/shipeasy_admin/models/create_ops_item_request.rb +0 -287
  82. data/lib/shipeasy_admin/models/create_ops_item_response.rb +0 -177
  83. data/lib/shipeasy_admin/models/create_universe_request.rb +0 -272
  84. data/lib/shipeasy_admin/models/create_universe_response.rb +0 -212
  85. data/lib/shipeasy_admin/models/cursor_trigger_config.rb +0 -231
  86. data/lib/shipeasy_admin/models/delete_config_response.rb +0 -188
  87. data/lib/shipeasy_admin/models/delete_connector_response.rb +0 -188
  88. data/lib/shipeasy_admin/models/delete_event_response.rb +0 -189
  89. data/lib/shipeasy_admin/models/delete_experiment_response.rb +0 -188
  90. data/lib/shipeasy_admin/models/delete_gate_response.rb +0 -188
  91. data/lib/shipeasy_admin/models/delete_killswitch_response.rb +0 -188
  92. data/lib/shipeasy_admin/models/delete_metric_response.rb +0 -189
  93. data/lib/shipeasy_admin/models/delete_universe_response.rb +0 -188
  94. data/lib/shipeasy_admin/models/disable_gate_response.rb +0 -190
  95. data/lib/shipeasy_admin/models/discard_config_draft_response.rb +0 -188
  96. data/lib/shipeasy_admin/models/enable_gate_response.rb +0 -190
  97. data/lib/shipeasy_admin/models/error_record.rb +0 -597
  98. data/lib/shipeasy_admin/models/error_series_request.rb +0 -251
  99. data/lib/shipeasy_admin/models/error_series_response.rb +0 -195
  100. data/lib/shipeasy_admin/models/error_series_response_rows_inner.rb +0 -192
  101. data/lib/shipeasy_admin/models/experiment_inline_metric.rb +0 -337
  102. data/lib/shipeasy_admin/models/fire_connector_request.rb +0 -149
  103. data/lib/shipeasy_admin/models/fire_connector_response.rb +0 -176
  104. data/lib/shipeasy_admin/models/get_config_response.rb +0 -351
  105. data/lib/shipeasy_admin/models/get_current_project_response.rb +0 -606
  106. data/lib/shipeasy_admin/models/get_current_project_response_module_translations.rb +0 -104
  107. data/lib/shipeasy_admin/models/get_event_response.rb +0 -344
  108. data/lib/shipeasy_admin/models/get_experiment_response.rb +0 -688
  109. data/lib/shipeasy_admin/models/get_experiment_results_response.rb +0 -243
  110. data/lib/shipeasy_admin/models/get_experiment_results_response_experiment.rb +0 -248
  111. data/lib/shipeasy_admin/models/get_experiment_results_response_results_inner.rb +0 -252
  112. data/lib/shipeasy_admin/models/get_experiment_timeseries_response.rb +0 -192
  113. data/lib/shipeasy_admin/models/get_experiment_timeseries_response_series_inner.rb +0 -278
  114. data/lib/shipeasy_admin/models/get_killswitch_response.rb +0 -270
  115. data/lib/shipeasy_admin/models/get_metric_response.rb +0 -378
  116. data/lib/shipeasy_admin/models/get_ops_item_response.rb +0 -349
  117. data/lib/shipeasy_admin/models/jules_trigger_config.rb +0 -240
  118. data/lib/shipeasy_admin/models/key_record.rb +0 -353
  119. data/lib/shipeasy_admin/models/link_pr_to_ops_item_request.rb +0 -186
  120. data/lib/shipeasy_admin/models/link_pr_to_ops_item_response.rb +0 -166
  121. data/lib/shipeasy_admin/models/list_alert_rules_response_inner.rb +0 -478
  122. data/lib/shipeasy_admin/models/list_attributes_response_inner.rb +0 -176
  123. data/lib/shipeasy_admin/models/list_config_activity_response_inner.rb +0 -280
  124. data/lib/shipeasy_admin/models/list_configs_response.rb +0 -178
  125. data/lib/shipeasy_admin/models/list_configs_response_data_inner.rb +0 -351
  126. data/lib/shipeasy_admin/models/list_configs_response_data_inner_drafts_value.rb +0 -237
  127. data/lib/shipeasy_admin/models/list_configs_response_data_inner_envs_value.rb +0 -237
  128. data/lib/shipeasy_admin/models/list_events_response_inner.rb +0 -344
  129. data/lib/shipeasy_admin/models/list_events_response_inner_properties_inner.rb +0 -259
  130. data/lib/shipeasy_admin/models/list_experiments_response.rb +0 -178
  131. data/lib/shipeasy_admin/models/list_experiments_response_data_inner.rb +0 -688
  132. data/lib/shipeasy_admin/models/list_experiments_response_data_inner_groups_inner.rb +0 -241
  133. data/lib/shipeasy_admin/models/list_gates_response.rb +0 -178
  134. data/lib/shipeasy_admin/models/list_gates_response_data_inner.rb +0 -395
  135. data/lib/shipeasy_admin/models/list_gates_response_data_inner_enabled.rb +0 -104
  136. data/lib/shipeasy_admin/models/list_gates_response_data_inner_rules_inner.rb +0 -238
  137. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner.rb +0 -105
  138. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of.rb +0 -358
  139. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of1.rb +0 -331
  140. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of_ramp.rb +0 -319
  141. data/lib/shipeasy_admin/models/list_i18n_drafts_response_inner.rb +0 -272
  142. data/lib/shipeasy_admin/models/list_i18n_keys_response.rb +0 -195
  143. data/lib/shipeasy_admin/models/list_i18n_keys_response_keys_inner.rb +0 -274
  144. data/lib/shipeasy_admin/models/list_i18n_profiles_response_inner.rb +0 -224
  145. data/lib/shipeasy_admin/models/list_keys_response.rb +0 -180
  146. data/lib/shipeasy_admin/models/list_killswitches_response.rb +0 -178
  147. data/lib/shipeasy_admin/models/list_killswitches_response_data_inner.rb +0 -270
  148. data/lib/shipeasy_admin/models/list_killswitches_response_data_inner_envs_value.rb +0 -248
  149. data/lib/shipeasy_admin/models/list_metrics_response_inner.rb +0 -378
  150. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir.rb +0 -288
  151. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg.rb +0 -113
  152. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of.rb +0 -188
  153. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of1.rb +0 -188
  154. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of2.rb +0 -188
  155. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of3.rb +0 -188
  156. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of4.rb +0 -188
  157. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of5.rb +0 -188
  158. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of6.rb +0 -188
  159. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of7.rb +0 -217
  160. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of8.rb +0 -233
  161. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9.rb +0 -240
  162. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator.rb +0 -266
  163. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator_filters_inner.rb +0 -264
  164. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_group_by.rb +0 -228
  165. data/lib/shipeasy_admin/models/list_ops_items_response_inner.rb +0 -349
  166. data/lib/shipeasy_admin/models/list_slack_channels_response.rb +0 -195
  167. data/lib/shipeasy_admin/models/list_slack_channels_response_channels_inner.rb +0 -203
  168. data/lib/shipeasy_admin/models/list_universes_response.rb +0 -178
  169. data/lib/shipeasy_admin/models/list_universes_response_data_inner.rb +0 -305
  170. data/lib/shipeasy_admin/models/notify_ops_request.rb +0 -261
  171. data/lib/shipeasy_admin/models/notify_ops_response.rb +0 -193
  172. data/lib/shipeasy_admin/models/publish_config_draft_request.rb +0 -187
  173. data/lib/shipeasy_admin/models/publish_config_draft_response.rb +0 -257
  174. data/lib/shipeasy_admin/models/publish_i18n_profile_response.rb +0 -391
  175. data/lib/shipeasy_admin/models/push_i18n_keys_request.rb +0 -195
  176. data/lib/shipeasy_admin/models/push_i18n_keys_request_keys_inner.rb +0 -192
  177. data/lib/shipeasy_admin/models/push_i18n_keys_response.rb +0 -251
  178. data/lib/shipeasy_admin/models/reanalyze_experiment_response.rb +0 -214
  179. data/lib/shipeasy_admin/models/revoke_key_response.rb +0 -216
  180. data/lib/shipeasy_admin/models/save_config_draft_request.rb +0 -199
  181. data/lib/shipeasy_admin/models/save_config_draft_response.rb +0 -283
  182. data/lib/shipeasy_admin/models/search_hit.rb +0 -284
  183. data/lib/shipeasy_admin/models/search_response.rb +0 -167
  184. data/lib/shipeasy_admin/models/set_experiment_metrics_request.rb +0 -168
  185. data/lib/shipeasy_admin/models/set_experiment_metrics_request_metrics_inner.rb +0 -216
  186. data/lib/shipeasy_admin/models/set_experiment_metrics_response.rb +0 -179
  187. data/lib/shipeasy_admin/models/set_experiment_metrics_response_metrics_inner.rb +0 -201
  188. data/lib/shipeasy_admin/models/set_experiment_status_request.rb +0 -190
  189. data/lib/shipeasy_admin/models/set_experiment_status_response.rb +0 -214
  190. data/lib/shipeasy_admin/models/set_i18n_label_request.rb +0 -213
  191. data/lib/shipeasy_admin/models/set_i18n_label_response.rb +0 -472
  192. data/lib/shipeasy_admin/models/set_killswitch_switch_response.rb +0 -285
  193. data/lib/shipeasy_admin/models/test_connector_response.rb +0 -189
  194. data/lib/shipeasy_admin/models/unset_killswitch_switch_request.rb +0 -234
  195. data/lib/shipeasy_admin/models/unset_killswitch_switch_response.rb +0 -286
  196. data/lib/shipeasy_admin/models/update_alert_rule_request.rb +0 -304
  197. data/lib/shipeasy_admin/models/update_alert_rule_response.rb +0 -165
  198. data/lib/shipeasy_admin/models/update_config_request.rb +0 -198
  199. data/lib/shipeasy_admin/models/update_config_response.rb +0 -165
  200. data/lib/shipeasy_admin/models/update_config_schema_request.rb +0 -168
  201. data/lib/shipeasy_admin/models/update_config_schema_response.rb +0 -165
  202. data/lib/shipeasy_admin/models/update_connector_request.rb +0 -211
  203. data/lib/shipeasy_admin/models/update_connector_response.rb +0 -166
  204. data/lib/shipeasy_admin/models/update_error_status_request.rb +0 -190
  205. data/lib/shipeasy_admin/models/update_event_request.rb +0 -198
  206. data/lib/shipeasy_admin/models/update_event_response.rb +0 -166
  207. data/lib/shipeasy_admin/models/update_experiment_request.rb +0 -747
  208. data/lib/shipeasy_admin/models/update_experiment_response.rb +0 -165
  209. data/lib/shipeasy_admin/models/update_gate_request.rb +0 -403
  210. data/lib/shipeasy_admin/models/update_gate_response.rb +0 -166
  211. data/lib/shipeasy_admin/models/update_i18n_key_request.rb +0 -176
  212. data/lib/shipeasy_admin/models/update_i18n_key_response.rb +0 -166
  213. data/lib/shipeasy_admin/models/update_killswitch_request.rb +0 -224
  214. data/lib/shipeasy_admin/models/update_killswitch_response.rb +0 -165
  215. data/lib/shipeasy_admin/models/update_ops_item_request.rb +0 -205
  216. data/lib/shipeasy_admin/models/update_ops_item_response.rb +0 -166
  217. data/lib/shipeasy_admin/models/update_universe_request.rb +0 -213
  218. data/lib/shipeasy_admin/models/update_universe_response.rb +0 -165
  219. data/lib/shipeasy_admin/models/upsert_project_request.rb +0 -222
  220. data/lib/shipeasy_admin/models/upsert_project_response.rb +0 -260
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #Shipeasy Admin API
2
+ #Shipeasy Admin API (server-SDK surface)
3
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.
4
+ #The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -19,33 +19,31 @@ module Shipeasy::Admin::Generated
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # File a queue item
23
- # Files one queue item a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack). `type` selects which; only the two user-fileable types are accepted (`error`/`alert` tickets are auto-filed by the platform). Returns the new id and per-project number. **Use cases** - **File a bug** — `{ \"type\": \"bug\", \"title\": \"Checkout 500s on Safari\", \"stepsToReproduce\": \"…\" }`. - **File a feature request** — `{ \"type\": \"feature_request\", \"title\": \"Dark mode\", \"priority\": \"nice_to_have\" }`.
24
- # @param create_ops_item_request [CreateOpsItemRequest]
22
+ # File a bug
23
+ # Files one bug onto a project's queue, awaiting human approval. This is the **public** intake: it authenticates with a *client* SDK key rather than an admin key, so it can be called from a CLI, an installer script, a devtools overlay, or any shipped code the same places a client key already lives. Three gates decide whether a ticket is filed, and nothing else the caller sends can widen them: 1. the key is a `client` key carrying the `tickets:public_create` scope, 2. the key's project has public ticket creation enabled, and 3. the item is filed as `pending_approval` parked out of the work queue until a human promotes it in the dashboard. The project is the key's own project; there is no `X-Project-Id` to pass and no way to file into someone else's queue. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again. This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API see `servers` below. **Use case:** `shipeasy setup` fails on a customer's machine and self-reports the failure with the user's consent — `{ \"title\": \"Setup failed at Feature installs\", \"stepsToReproduce\": \"…\", \"actualResult\": \"…\" }`.
24
+ # @param create_public_bug_request [CreatePublicBugRequest]
25
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 [CreateOpsItemResponse]
28
- def create_ops_item(create_ops_item_request, opts = {})
29
- data, _status_code, _headers = create_ops_item_with_http_info(create_ops_item_request, opts)
26
+ # @return [CreatePublicTicketResponse]
27
+ def create_public_bug(create_public_bug_request, opts = {})
28
+ data, _status_code, _headers = create_public_bug_with_http_info(create_public_bug_request, opts)
30
29
  data
31
30
  end
32
31
 
33
- # File a queue item
34
- # Files one queue item a bug report or a feature request — and fires the project's connectors (GitHub issue / Slack). `type` selects which; only the two user-fileable types are accepted (`error`/`alert` tickets are auto-filed by the platform). Returns the new id and per-project number. **Use cases** - **File a bug** — `{ \"type\": \"bug\", \"title\": \"Checkout 500s on Safari\", \"stepsToReproduce\": \"…\" }`. - **File a feature request** — `{ \"type\": \"feature_request\", \"title\": \"Dark mode\", \"priority\": \"nice_to_have\" }`.
35
- # @param create_ops_item_request [CreateOpsItemRequest]
32
+ # File a bug
33
+ # Files one bug onto a project's queue, awaiting human approval. This is the **public** intake: it authenticates with a *client* SDK key rather than an admin key, so it can be called from a CLI, an installer script, a devtools overlay, or any shipped code the same places a client key already lives. Three gates decide whether a ticket is filed, and nothing else the caller sends can widen them: 1. the key is a `client` key carrying the `tickets:public_create` scope, 2. the key's project has public ticket creation enabled, and 3. the item is filed as `pending_approval` parked out of the work queue until a human promotes it in the dashboard. The project is the key's own project; there is no `X-Project-Id` to pass and no way to file into someone else's queue. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again. This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API see `servers` below. **Use case:** `shipeasy setup` fails on a customer's machine and self-reports the failure with the user's consent — `{ \"title\": \"Setup failed at Feature installs\", \"stepsToReproduce\": \"…\", \"actualResult\": \"…\" }`.
34
+ # @param create_public_bug_request [CreatePublicBugRequest]
36
35
  # @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<(CreateOpsItemResponse, Integer, Hash)>] CreateOpsItemResponse data, response status code and response headers
39
- def create_ops_item_with_http_info(create_ops_item_request, opts = {})
36
+ # @return [Array<(CreatePublicTicketResponse, Integer, Hash)>] CreatePublicTicketResponse data, response status code and response headers
37
+ def create_public_bug_with_http_info(create_public_bug_request, opts = {})
40
38
  if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: OpsApi.create_ops_item ...'
39
+ @api_client.config.logger.debug 'Calling API: OpsApi.create_public_bug ...'
42
40
  end
43
- # verify the required parameter 'create_ops_item_request' is set
44
- if @api_client.config.client_side_validation && create_ops_item_request.nil?
45
- fail ArgumentError, "Missing the required parameter 'create_ops_item_request' when calling OpsApi.create_ops_item"
41
+ # verify the required parameter 'create_public_bug_request' is set
42
+ if @api_client.config.client_side_validation && create_public_bug_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'create_public_bug_request' when calling OpsApi.create_public_bug"
46
44
  end
47
45
  # resource path
48
- local_var_path = '/api/admin/ops'
46
+ local_var_path = '/ops/bug'
49
47
 
50
48
  # query parameters
51
49
  query_params = opts[:query_params] || {}
@@ -59,22 +57,21 @@ module Shipeasy::Admin::Generated
59
57
  if !content_type.nil?
60
58
  header_params['Content-Type'] = content_type
61
59
  end
62
- header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
63
60
 
64
61
  # form parameters
65
62
  form_params = opts[:form_params] || {}
66
63
 
67
64
  # http body (model)
68
- post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ops_item_request)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_public_bug_request)
69
66
 
70
67
  # return_type
71
- return_type = opts[:debug_return_type] || 'CreateOpsItemResponse'
68
+ return_type = opts[:debug_return_type] || 'CreatePublicTicketResponse'
72
69
 
73
70
  # auth_names
74
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
71
+ auth_names = opts[:debug_auth_names] || ['clientSdkKey']
75
72
 
76
73
  new_options = opts.merge(
77
- :operation => :"OpsApi.create_ops_item",
74
+ :operation => :"OpsApi.create_public_bug",
78
75
  :header_params => header_params,
79
76
  :query_params => query_params,
80
77
  :form_params => form_params,
@@ -85,106 +82,36 @@ module Shipeasy::Admin::Generated
85
82
 
86
83
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
87
84
  if @api_client.config.debugging
88
- @api_client.config.logger.debug "API called: OpsApi#create_ops_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
85
+ @api_client.config.logger.debug "API called: OpsApi#create_public_bug\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
89
86
  end
90
87
  return data, status_code, headers
91
88
  end
92
89
 
93
- # Get one queue item
94
- # Fetch a single queue item by its per-project `number` or full id. **Use case:** Inspect one item's full detail before updating its status or linking a PR.
95
- # @param handle [String] Per-project item number (e.g. &#x60;7&#x60;) or the full ops item id.
90
+ # File a feature request
91
+ # Files one feature request onto a project's queue, awaiting human approval. The feature-request counterpart to `POST /ops/bug`, with the same three gates: a `client` key carrying `tickets:public_create`, a project that has opted in, and a `pending_approval` state forced server-side. The project is the key's own project; there is no `X-Project-Id` to pass. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again. This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API — see `servers` below. **Use case:** An in-product \"request a feature\" form posts what the user asked for — `{ \"title\": \"Dark mode\", \"useCase\": \"Reduce eye strain at night\" }`.
92
+ # @param create_public_feature_request_request [CreatePublicFeatureRequestRequest]
96
93
  # @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 [GetOpsItemResponse]
99
- def get_ops_item(handle, opts = {})
100
- data, _status_code, _headers = get_ops_item_with_http_info(handle, opts)
94
+ # @return [CreatePublicTicketResponse]
95
+ def create_public_feature_request(create_public_feature_request_request, opts = {})
96
+ data, _status_code, _headers = create_public_feature_request_with_http_info(create_public_feature_request_request, opts)
101
97
  data
102
98
  end
103
99
 
104
- # Get one queue item
105
- # Fetch a single queue item by its per-project &#x60;number&#x60; or full id. **Use case:** Inspect one item&#39;s full detail before updating its status or linking a PR.
106
- # @param handle [String] Per-project item number (e.g. &#x60;7&#x60;) or the full ops item id.
100
+ # File a feature request
101
+ # Files one feature request onto a project&#39;s queue, awaiting human approval. The feature-request counterpart to &#x60;POST /ops/bug&#x60;, with the same three gates: a &#x60;client&#x60; key carrying &#x60;tickets:public_create&#x60;, a project that has opted in, and a &#x60;pending_approval&#x60; state forced server-side. The project is the key&#39;s own project; there is no &#x60;X-Project-Id&#x60; to pass. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns &#x60;200&#x60; with &#x60;deduped: true&#x60; instead of filing again. This endpoint is served by the Shipeasy **edge worker** (&#x60;api.shipeasy.ai&#x60;), not the admin API — see &#x60;servers&#x60; below. **Use case:** An in-product \&quot;request a feature\&quot; form posts what the user asked for — &#x60;{ \&quot;title\&quot;: \&quot;Dark mode\&quot;, \&quot;useCase\&quot;: \&quot;Reduce eye strain at night\&quot; }&#x60;.
102
+ # @param create_public_feature_request_request [CreatePublicFeatureRequestRequest]
107
103
  # @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<(GetOpsItemResponse, Integer, Hash)>] GetOpsItemResponse data, response status code and response headers
110
- def get_ops_item_with_http_info(handle, opts = {})
104
+ # @return [Array<(CreatePublicTicketResponse, Integer, Hash)>] CreatePublicTicketResponse data, response status code and response headers
105
+ def create_public_feature_request_with_http_info(create_public_feature_request_request, opts = {})
111
106
  if @api_client.config.debugging
112
- @api_client.config.logger.debug 'Calling API: OpsApi.get_ops_item ...'
107
+ @api_client.config.logger.debug 'Calling API: OpsApi.create_public_feature_request ...'
113
108
  end
114
- # resource path
115
- local_var_path = '/api/admin/ops/{handle}'.sub('{handle}', CGI.escape(handle.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] || 'GetOpsItemResponse'
134
-
135
- # auth_names
136
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
137
-
138
- new_options = opts.merge(
139
- :operation => :"OpsApi.get_ops_item",
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(:GET, local_var_path, new_options)
149
- if @api_client.config.debugging
150
- @api_client.config.logger.debug "API called: OpsApi#get_ops_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
151
- end
152
- return data, status_code, headers
153
- end
154
-
155
- # Link a fixing PR
156
- # Record the pull request that fixes a queue item (and clears the link with `prNumber: null`). **Use case:** Tie the fixing PR to the item so closing the PR can flip it to ready_for_qa.
157
- # @param handle [String] Per-project item number (e.g. &#x60;7&#x60;) or the full ops item id.
158
- # @param link_pr_to_ops_item_request [LinkPrToOpsItemRequest]
159
- # @param [Hash] opts the optional parameters
160
- # @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).
161
- # @return [LinkPrToOpsItemResponse]
162
- def link_pr_to_ops_item(handle, link_pr_to_ops_item_request, opts = {})
163
- data, _status_code, _headers = link_pr_to_ops_item_with_http_info(handle, link_pr_to_ops_item_request, opts)
164
- data
165
- end
166
-
167
- # Link a fixing PR
168
- # Record the pull request that fixes a queue item (and clears the link with &#x60;prNumber: null&#x60;). **Use case:** Tie the fixing PR to the item so closing the PR can flip it to ready_for_qa.
169
- # @param handle [String] Per-project item number (e.g. &#x60;7&#x60;) or the full ops item id.
170
- # @param link_pr_to_ops_item_request [LinkPrToOpsItemRequest]
171
- # @param [Hash] opts the optional parameters
172
- # @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).
173
- # @return [Array<(LinkPrToOpsItemResponse, Integer, Hash)>] LinkPrToOpsItemResponse data, response status code and response headers
174
- def link_pr_to_ops_item_with_http_info(handle, link_pr_to_ops_item_request, opts = {})
175
- if @api_client.config.debugging
176
- @api_client.config.logger.debug 'Calling API: OpsApi.link_pr_to_ops_item ...'
177
- end
178
- # verify the required parameter 'handle' is set
179
- if @api_client.config.client_side_validation && handle.nil?
180
- fail ArgumentError, "Missing the required parameter 'handle' when calling OpsApi.link_pr_to_ops_item"
181
- end
182
- # verify the required parameter 'link_pr_to_ops_item_request' is set
183
- if @api_client.config.client_side_validation && link_pr_to_ops_item_request.nil?
184
- fail ArgumentError, "Missing the required parameter 'link_pr_to_ops_item_request' when calling OpsApi.link_pr_to_ops_item"
109
+ # verify the required parameter 'create_public_feature_request_request' is set
110
+ if @api_client.config.client_side_validation && create_public_feature_request_request.nil?
111
+ fail ArgumentError, "Missing the required parameter 'create_public_feature_request_request' when calling OpsApi.create_public_feature_request"
185
112
  end
186
113
  # resource path
187
- local_var_path = '/api/admin/ops/{handle}/link-pr'.sub('{handle}', CGI.escape(handle.to_s))
114
+ local_var_path = '/ops/feature-request'
188
115
 
189
116
  # query parameters
190
117
  query_params = opts[:query_params] || {}
@@ -198,22 +125,21 @@ module Shipeasy::Admin::Generated
198
125
  if !content_type.nil?
199
126
  header_params['Content-Type'] = content_type
200
127
  end
201
- header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
202
128
 
203
129
  # form parameters
204
130
  form_params = opts[:form_params] || {}
205
131
 
206
132
  # http body (model)
207
- post_body = opts[:debug_body] || @api_client.object_to_http_body(link_pr_to_ops_item_request)
133
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_public_feature_request_request)
208
134
 
209
135
  # return_type
210
- return_type = opts[:debug_return_type] || 'LinkPrToOpsItemResponse'
136
+ return_type = opts[:debug_return_type] || 'CreatePublicTicketResponse'
211
137
 
212
138
  # auth_names
213
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
139
+ auth_names = opts[:debug_auth_names] || ['clientSdkKey']
214
140
 
215
141
  new_options = opts.merge(
216
- :operation => :"OpsApi.link_pr_to_ops_item",
142
+ :operation => :"OpsApi.create_public_feature_request",
217
143
  :header_params => header_params,
218
144
  :query_params => query_params,
219
145
  :form_params => form_params,
@@ -224,240 +150,7 @@ module Shipeasy::Admin::Generated
224
150
 
225
151
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
226
152
  if @api_client.config.debugging
227
- @api_client.config.logger.debug "API called: OpsApi#link_pr_to_ops_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
228
- end
229
- return data, status_code, headers
230
- end
231
-
232
- # List the operational queue
233
- # Returns the unified ops queue (bugs, feature requests, errors, alerts), newest first. Filter by `type` and/or `status`, and cap with `limit`. **Use case:** Pull the open queue to triage — e.g. every `bug` still `open` — before working items down one by one.
234
- # @param [Hash] opts the optional parameters
235
- # @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).
236
- # @option opts [String] :type Filter by item type (&#x60;bug&#x60;/&#x60;feature_request&#x60;/&#x60;error&#x60;/&#x60;alert&#x60;), or &#x60;all&#x60;.
237
- # @option opts [String] :status Filter by lifecycle status, or &#x60;all&#x60;.
238
- # @option opts [Integer] :limit Max items to return (1–500).
239
- # @return [Array<ListOpsItemsResponseInner>]
240
- def list_ops_items(opts = {})
241
- data, _status_code, _headers = list_ops_items_with_http_info(opts)
242
- data
243
- end
244
-
245
- # List the operational queue
246
- # Returns the unified ops queue (bugs, feature requests, errors, alerts), newest first. Filter by &#x60;type&#x60; and/or &#x60;status&#x60;, and cap with &#x60;limit&#x60;. **Use case:** Pull the open queue to triage — e.g. every &#x60;bug&#x60; still &#x60;open&#x60; — before working items down one by one.
247
- # @param [Hash] opts the optional parameters
248
- # @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).
249
- # @option opts [String] :type Filter by item type (&#x60;bug&#x60;/&#x60;feature_request&#x60;/&#x60;error&#x60;/&#x60;alert&#x60;), or &#x60;all&#x60;.
250
- # @option opts [String] :status Filter by lifecycle status, or &#x60;all&#x60;.
251
- # @option opts [Integer] :limit Max items to return (1–500).
252
- # @return [Array<(Array<ListOpsItemsResponseInner>, Integer, Hash)>] Array<ListOpsItemsResponseInner> data, response status code and response headers
253
- def list_ops_items_with_http_info(opts = {})
254
- if @api_client.config.debugging
255
- @api_client.config.logger.debug 'Calling API: OpsApi.list_ops_items ...'
256
- end
257
- allowable_values = ["bug", "feature_request", "error", "alert", "all"]
258
- if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
259
- fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
260
- end
261
- allowable_values = ["open", "triaged", "in_progress", "ready_for_qa", "resolved", "wont_fix", "all"]
262
- if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
263
- fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
264
- end
265
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
266
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OpsApi.list_ops_items, must be smaller than or equal to 500.'
267
- end
268
-
269
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
270
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OpsApi.list_ops_items, must be greater than or equal to 1.'
271
- end
272
-
273
- # resource path
274
- local_var_path = '/api/admin/ops'
275
-
276
- # query parameters
277
- query_params = opts[:query_params] || {}
278
- query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
279
- query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
280
- query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
281
-
282
- # header parameters
283
- header_params = opts[:header_params] || {}
284
- # HTTP header 'Accept' (if needed)
285
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
286
- header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
287
-
288
- # form parameters
289
- form_params = opts[:form_params] || {}
290
-
291
- # http body (model)
292
- post_body = opts[:debug_body]
293
-
294
- # return_type
295
- return_type = opts[:debug_return_type] || 'Array<ListOpsItemsResponseInner>'
296
-
297
- # auth_names
298
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
299
-
300
- new_options = opts.merge(
301
- :operation => :"OpsApi.list_ops_items",
302
- :header_params => header_params,
303
- :query_params => query_params,
304
- :form_params => form_params,
305
- :body => post_body,
306
- :auth_names => auth_names,
307
- :return_type => return_type
308
- )
309
-
310
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
311
- if @api_client.config.debugging
312
- @api_client.config.logger.debug "API called: OpsApi#list_ops_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
313
- end
314
- return data, status_code, headers
315
- end
316
-
317
- # Raise an attention notification
318
- # Raise a 'needs your attention' bell notification. Create-only and idempotent on `dedupeKey`. **Use case:** Escalate something that needs a human, deduped so repeats don't spam the bell.
319
- # @param notify_ops_request [NotifyOpsRequest]
320
- # @param [Hash] opts the optional parameters
321
- # @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).
322
- # @return [NotifyOpsResponse]
323
- def notify_ops(notify_ops_request, opts = {})
324
- data, _status_code, _headers = notify_ops_with_http_info(notify_ops_request, opts)
325
- data
326
- end
327
-
328
- # Raise an attention notification
329
- # Raise a &#39;needs your attention&#39; bell notification. Create-only and idempotent on &#x60;dedupeKey&#x60;. **Use case:** Escalate something that needs a human, deduped so repeats don&#39;t spam the bell.
330
- # @param notify_ops_request [NotifyOpsRequest]
331
- # @param [Hash] opts the optional parameters
332
- # @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).
333
- # @return [Array<(NotifyOpsResponse, Integer, Hash)>] NotifyOpsResponse data, response status code and response headers
334
- def notify_ops_with_http_info(notify_ops_request, opts = {})
335
- if @api_client.config.debugging
336
- @api_client.config.logger.debug 'Calling API: OpsApi.notify_ops ...'
337
- end
338
- # verify the required parameter 'notify_ops_request' is set
339
- if @api_client.config.client_side_validation && notify_ops_request.nil?
340
- fail ArgumentError, "Missing the required parameter 'notify_ops_request' when calling OpsApi.notify_ops"
341
- end
342
- # resource path
343
- local_var_path = '/api/admin/notifications'
344
-
345
- # query parameters
346
- query_params = opts[:query_params] || {}
347
-
348
- # header parameters
349
- header_params = opts[:header_params] || {}
350
- # HTTP header 'Accept' (if needed)
351
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
352
- # HTTP header 'Content-Type'
353
- content_type = @api_client.select_header_content_type(['application/json'])
354
- if !content_type.nil?
355
- header_params['Content-Type'] = content_type
356
- end
357
- header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
358
-
359
- # form parameters
360
- form_params = opts[:form_params] || {}
361
-
362
- # http body (model)
363
- post_body = opts[:debug_body] || @api_client.object_to_http_body(notify_ops_request)
364
-
365
- # return_type
366
- return_type = opts[:debug_return_type] || 'NotifyOpsResponse'
367
-
368
- # auth_names
369
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
370
-
371
- new_options = opts.merge(
372
- :operation => :"OpsApi.notify_ops",
373
- :header_params => header_params,
374
- :query_params => query_params,
375
- :form_params => form_params,
376
- :body => post_body,
377
- :auth_names => auth_names,
378
- :return_type => return_type
379
- )
380
-
381
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
382
- if @api_client.config.debugging
383
- @api_client.config.logger.debug "API called: OpsApi#notify_ops\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
384
- end
385
- return data, status_code, headers
386
- end
387
-
388
- # Update a queue item
389
- # Update a queue item's `status` and/or `priority`. Other fields are immutable. **Use case:** Move an item through its lifecycle (triage → in_progress → resolved) as you work it.
390
- # @param handle [String] Per-project item number (e.g. &#x60;7&#x60;) or the full ops item id.
391
- # @param update_ops_item_request [UpdateOpsItemRequest]
392
- # @param [Hash] opts the optional parameters
393
- # @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).
394
- # @return [UpdateOpsItemResponse]
395
- def update_ops_item(handle, update_ops_item_request, opts = {})
396
- data, _status_code, _headers = update_ops_item_with_http_info(handle, update_ops_item_request, opts)
397
- data
398
- end
399
-
400
- # Update a queue item
401
- # Update a queue item&#39;s &#x60;status&#x60; and/or &#x60;priority&#x60;. Other fields are immutable. **Use case:** Move an item through its lifecycle (triage → in_progress → resolved) as you work it.
402
- # @param handle [String] Per-project item number (e.g. &#x60;7&#x60;) or the full ops item id.
403
- # @param update_ops_item_request [UpdateOpsItemRequest]
404
- # @param [Hash] opts the optional parameters
405
- # @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).
406
- # @return [Array<(UpdateOpsItemResponse, Integer, Hash)>] UpdateOpsItemResponse data, response status code and response headers
407
- def update_ops_item_with_http_info(handle, update_ops_item_request, opts = {})
408
- if @api_client.config.debugging
409
- @api_client.config.logger.debug 'Calling API: OpsApi.update_ops_item ...'
410
- end
411
- # verify the required parameter 'handle' is set
412
- if @api_client.config.client_side_validation && handle.nil?
413
- fail ArgumentError, "Missing the required parameter 'handle' when calling OpsApi.update_ops_item"
414
- end
415
- # verify the required parameter 'update_ops_item_request' is set
416
- if @api_client.config.client_side_validation && update_ops_item_request.nil?
417
- fail ArgumentError, "Missing the required parameter 'update_ops_item_request' when calling OpsApi.update_ops_item"
418
- end
419
- # resource path
420
- local_var_path = '/api/admin/ops/{handle}'.sub('{handle}', CGI.escape(handle.to_s))
421
-
422
- # query parameters
423
- query_params = opts[:query_params] || {}
424
-
425
- # header parameters
426
- header_params = opts[:header_params] || {}
427
- # HTTP header 'Accept' (if needed)
428
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
429
- # HTTP header 'Content-Type'
430
- content_type = @api_client.select_header_content_type(['application/json'])
431
- if !content_type.nil?
432
- header_params['Content-Type'] = content_type
433
- end
434
- header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
435
-
436
- # form parameters
437
- form_params = opts[:form_params] || {}
438
-
439
- # http body (model)
440
- post_body = opts[:debug_body] || @api_client.object_to_http_body(update_ops_item_request)
441
-
442
- # return_type
443
- return_type = opts[:debug_return_type] || 'UpdateOpsItemResponse'
444
-
445
- # auth_names
446
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
447
-
448
- new_options = opts.merge(
449
- :operation => :"OpsApi.update_ops_item",
450
- :header_params => header_params,
451
- :query_params => query_params,
452
- :form_params => form_params,
453
- :body => post_body,
454
- :auth_names => auth_names,
455
- :return_type => return_type
456
- )
457
-
458
- data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
459
- if @api_client.config.debugging
460
- @api_client.config.logger.debug "API called: OpsApi#update_ops_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
153
+ @api_client.config.logger.debug "API called: OpsApi#create_public_feature_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
461
154
  end
462
155
  return data, status_code, headers
463
156
  end
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #Shipeasy Admin API
2
+ #Shipeasy Admin API (server-SDK surface)
3
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.
4
+ #The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #Shipeasy Admin API
2
+ #Shipeasy Admin API (server-SDK surface)
3
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.
4
+ #The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #Shipeasy Admin API
2
+ #Shipeasy Admin API (server-SDK surface)
3
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.
4
+ #The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
- #Shipeasy Admin API
2
+ #Shipeasy Admin API (server-SDK surface)
3
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.
4
+ #The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Three capabilities, nothing else: - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule. Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -256,6 +256,13 @@ module Shipeasy::Admin::Generated
256
256
  key: 'Authorization',
257
257
  value: "Bearer #{access_token_with_refresh}"
258
258
  },
259
+ 'clientSdkKey' =>
260
+ {
261
+ type: 'api_key',
262
+ in: 'header',
263
+ key: 'X-SDK-Key',
264
+ value: api_key_with_prefix('X-SDK-Key')
265
+ },
259
266
  }
260
267
  end
261
268
 
@@ -275,6 +282,26 @@ module Shipeasy::Admin::Generated
275
282
 
276
283
  def operation_server_settings
277
284
  {
285
+ "OpsApi.create_public_bug": [
286
+ {
287
+ url: "https://api.shipeasy.ai",
288
+ description: "Shipeasy edge worker (production)",
289
+ },
290
+ {
291
+ url: "http://localhost:8787",
292
+ description: "Local `wrangler dev`",
293
+ }
294
+ ],
295
+ "OpsApi.create_public_feature_request": [
296
+ {
297
+ url: "https://api.shipeasy.ai",
298
+ description: "Shipeasy edge worker (production)",
299
+ },
300
+ {
301
+ url: "http://localhost:8787",
302
+ description: "Local `wrangler dev`",
303
+ }
304
+ ],
278
305
  }
279
306
  end
280
307