shipeasy-sdk 2.3.0 → 2.3.1

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 (213) hide show
  1. checksums.yaml +4 -4
  2. data/lib/shipeasy/admin.rb +14 -8
  3. data/lib/shipeasy/sdk/version.rb +1 -1
  4. data/lib/shipeasy_admin/api/{alert_rules_api.rb → alerts_api.rb} +77 -17
  5. data/lib/shipeasy_admin/api/api_keys_api.rb +229 -0
  6. data/lib/shipeasy_admin/api/attributes_api.rb +1 -1
  7. data/lib/shipeasy_admin/api/configs_api.rb +78 -1
  8. data/lib/shipeasy_admin/api/connectors_api.rb +497 -0
  9. data/lib/shipeasy_admin/api/drafts_api.rb +82 -0
  10. data/lib/shipeasy_admin/api/errors_api.rb +389 -0
  11. data/lib/shipeasy_admin/api/events_api.rb +1 -1
  12. data/lib/shipeasy_admin/api/experiments_api.rb +1 -1
  13. data/lib/shipeasy_admin/api/{gates_api.rb → flags_api.rb} +27 -27
  14. data/lib/shipeasy_admin/api/{i18n_api.rb → keys_api.rb} +54 -244
  15. data/lib/shipeasy_admin/api/{killswitches_api.rb → killswitch_api.rb} +110 -33
  16. data/lib/shipeasy_admin/api/metrics_api.rb +1 -1
  17. data/lib/shipeasy_admin/api/ops_api.rb +3 -63
  18. data/lib/shipeasy_admin/api/profiles_api.rb +226 -0
  19. data/lib/shipeasy_admin/api/projects_api.rb +64 -1
  20. data/lib/shipeasy_admin/api/universes_api.rb +1 -1
  21. data/lib/shipeasy_admin/api_client.rb +1 -1
  22. data/lib/shipeasy_admin/api_error.rb +1 -1
  23. data/lib/shipeasy_admin/api_model_base.rb +1 -1
  24. data/lib/shipeasy_admin/configuration.rb +1 -1
  25. data/lib/shipeasy_admin/models/approve_event_request.rb +2 -2
  26. data/lib/shipeasy_admin/models/approve_event_response.rb +1 -1
  27. data/lib/shipeasy_admin/models/claude_trigger_config.rb +204 -0
  28. data/lib/shipeasy_admin/models/connector_event.rb +40 -0
  29. data/lib/shipeasy_admin/models/connector_provider.rb +45 -0
  30. data/lib/shipeasy_admin/models/connector_record.rb +468 -0
  31. data/lib/shipeasy_admin/models/copilot_trigger_config.rb +276 -0
  32. data/lib/shipeasy_admin/models/create_alert_rule_request.rb +6 -31
  33. data/lib/shipeasy_admin/models/create_alert_rule_response.rb +1 -1
  34. data/lib/shipeasy_admin/models/create_claude_trigger_request.rb +309 -0
  35. data/lib/shipeasy_admin/models/create_config_request.rb +14 -3
  36. data/lib/shipeasy_admin/models/create_config_response.rb +1 -1
  37. data/lib/shipeasy_admin/models/create_connector_request.rb +64 -0
  38. data/lib/shipeasy_admin/models/create_connector_response.rb +165 -0
  39. data/lib/shipeasy_admin/models/create_copilot_trigger_request.rb +316 -0
  40. data/lib/shipeasy_admin/models/create_cursor_trigger_request.rb +352 -0
  41. data/lib/shipeasy_admin/models/create_event_request.rb +2 -19
  42. data/lib/shipeasy_admin/models/create_event_response.rb +1 -1
  43. data/lib/shipeasy_admin/models/create_experiment_request.rb +39 -101
  44. data/lib/shipeasy_admin/models/create_experiment_response.rb +1 -1
  45. data/lib/shipeasy_admin/models/create_gate_request.rb +6 -43
  46. data/lib/shipeasy_admin/models/create_gate_response.rb +1 -1
  47. data/lib/shipeasy_admin/models/create_i18n_profile_request.rb +1 -1
  48. data/lib/shipeasy_admin/models/create_i18n_profile_response.rb +1 -1
  49. data/lib/shipeasy_admin/models/create_jules_trigger_request.rb +352 -0
  50. data/lib/shipeasy_admin/models/create_key_request.rb +297 -0
  51. data/lib/shipeasy_admin/models/create_key_response.rb +286 -0
  52. data/lib/shipeasy_admin/models/create_killswitch_request.rb +14 -3
  53. data/lib/shipeasy_admin/models/create_killswitch_response.rb +1 -1
  54. data/lib/shipeasy_admin/models/create_metric_request.rb +6 -18
  55. data/lib/shipeasy_admin/models/create_metric_response.rb +1 -1
  56. data/lib/shipeasy_admin/models/create_o_auth_connector_request.rb +273 -0
  57. data/lib/shipeasy_admin/models/create_ops_item_request.rb +2 -2
  58. data/lib/shipeasy_admin/models/create_ops_item_response.rb +2 -2
  59. data/lib/shipeasy_admin/models/create_universe_request.rb +6 -23
  60. data/lib/shipeasy_admin/models/create_universe_response.rb +1 -1
  61. data/lib/shipeasy_admin/models/cursor_trigger_config.rb +231 -0
  62. data/lib/shipeasy_admin/models/delete_alert_rule_response.rb +1 -1
  63. data/lib/shipeasy_admin/models/delete_config_response.rb +1 -1
  64. data/lib/shipeasy_admin/models/delete_connector_response.rb +188 -0
  65. data/lib/shipeasy_admin/models/delete_event_response.rb +1 -1
  66. data/lib/shipeasy_admin/models/delete_experiment_response.rb +1 -1
  67. data/lib/shipeasy_admin/models/delete_gate_response.rb +1 -1
  68. data/lib/shipeasy_admin/models/delete_killswitch_response.rb +1 -1
  69. data/lib/shipeasy_admin/models/delete_metric_response.rb +1 -1
  70. data/lib/shipeasy_admin/models/delete_universe_response.rb +1 -1
  71. data/lib/shipeasy_admin/models/disable_gate_response.rb +1 -1
  72. data/lib/shipeasy_admin/models/discard_config_draft_request.rb +7 -10
  73. data/lib/shipeasy_admin/models/discard_config_draft_response.rb +1 -1
  74. data/lib/shipeasy_admin/models/enable_gate_response.rb +1 -1
  75. data/lib/shipeasy_admin/models/env.rb +41 -0
  76. data/lib/shipeasy_admin/models/{error_response.rb → error.rb} +29 -7
  77. data/lib/shipeasy_admin/models/error_code.rb +52 -0
  78. data/lib/shipeasy_admin/models/error_record.rb +597 -0
  79. data/lib/shipeasy_admin/models/error_series_request.rb +251 -0
  80. data/lib/shipeasy_admin/models/error_series_response.rb +195 -0
  81. data/lib/shipeasy_admin/models/error_series_response_rows_inner.rb +192 -0
  82. data/lib/shipeasy_admin/models/{create_experiment_request_goal_metric.rb → experiment_inline_metric.rb} +9 -8
  83. data/lib/shipeasy_admin/models/file_error_ticket_response.rb +193 -0
  84. data/lib/shipeasy_admin/models/fire_connector_request.rb +149 -0
  85. data/lib/shipeasy_admin/models/fire_connector_response.rb +176 -0
  86. data/lib/shipeasy_admin/models/get_config_response.rb +1 -1
  87. data/lib/shipeasy_admin/models/get_current_project_response.rb +1 -1
  88. data/lib/shipeasy_admin/models/get_current_project_response_module_translations.rb +1 -1
  89. data/lib/shipeasy_admin/models/get_event_response.rb +1 -1
  90. data/lib/shipeasy_admin/models/get_experiment_response.rb +1 -1
  91. data/lib/shipeasy_admin/models/get_experiment_results_response.rb +1 -1
  92. data/lib/shipeasy_admin/models/get_experiment_results_response_experiment.rb +1 -1
  93. data/lib/shipeasy_admin/models/get_experiment_results_response_results_inner.rb +1 -1
  94. data/lib/shipeasy_admin/models/get_experiment_timeseries_response.rb +1 -1
  95. data/lib/shipeasy_admin/models/get_experiment_timeseries_response_experiment.rb +1 -1
  96. data/lib/shipeasy_admin/models/get_experiment_timeseries_response_series_inner.rb +1 -1
  97. data/lib/shipeasy_admin/models/get_killswitch_response.rb +1 -1
  98. data/lib/shipeasy_admin/models/get_metric_response.rb +1 -1
  99. data/lib/shipeasy_admin/models/get_ops_item_response.rb +1 -1
  100. data/lib/shipeasy_admin/models/jules_trigger_config.rb +240 -0
  101. data/lib/shipeasy_admin/models/key_record.rb +353 -0
  102. data/lib/shipeasy_admin/models/killswitch_value.rb +178 -0
  103. data/lib/shipeasy_admin/models/link_pr_to_ops_item_request.rb +1 -1
  104. data/lib/shipeasy_admin/models/link_pr_to_ops_item_response.rb +1 -1
  105. data/lib/shipeasy_admin/models/list_alert_rules_response_inner.rb +2 -2
  106. data/lib/shipeasy_admin/models/list_attributes_response_inner.rb +1 -1
  107. data/lib/shipeasy_admin/models/list_config_activity_response_inner.rb +1 -1
  108. data/lib/shipeasy_admin/models/list_configs_response.rb +1 -1
  109. data/lib/shipeasy_admin/models/list_configs_response_data_inner.rb +1 -1
  110. data/lib/shipeasy_admin/models/list_configs_response_data_inner_drafts_value.rb +1 -1
  111. data/lib/shipeasy_admin/models/list_configs_response_data_inner_envs_value.rb +1 -1
  112. data/lib/shipeasy_admin/models/list_events_response_inner.rb +1 -1
  113. data/lib/shipeasy_admin/models/list_events_response_inner_properties_inner.rb +1 -31
  114. data/lib/shipeasy_admin/models/list_experiments_response.rb +1 -1
  115. data/lib/shipeasy_admin/models/list_experiments_response_data_inner.rb +1 -1
  116. data/lib/shipeasy_admin/models/list_experiments_response_data_inner_groups_inner.rb +1 -18
  117. data/lib/shipeasy_admin/models/list_gates_response.rb +1 -1
  118. data/lib/shipeasy_admin/models/list_gates_response_data_inner.rb +1 -1
  119. data/lib/shipeasy_admin/models/list_gates_response_data_inner_enabled.rb +1 -1
  120. data/lib/shipeasy_admin/models/list_gates_response_data_inner_rules_inner.rb +1 -1
  121. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner.rb +1 -1
  122. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of.rb +1 -18
  123. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of1.rb +1 -1
  124. data/lib/shipeasy_admin/models/list_gates_response_data_inner_stack_inner_one_of_ramp.rb +1 -1
  125. data/lib/shipeasy_admin/models/list_i18n_drafts_response_inner.rb +1 -1
  126. data/lib/shipeasy_admin/models/list_i18n_keys_response.rb +1 -1
  127. data/lib/shipeasy_admin/models/list_i18n_keys_response_keys_inner.rb +1 -1
  128. data/lib/shipeasy_admin/models/list_i18n_profiles_response_inner.rb +1 -1
  129. data/lib/shipeasy_admin/models/list_keys_response.rb +180 -0
  130. data/lib/shipeasy_admin/models/list_killswitches_response.rb +1 -1
  131. data/lib/shipeasy_admin/models/list_killswitches_response_data_inner.rb +1 -1
  132. data/lib/shipeasy_admin/models/list_killswitches_response_data_inner_envs_value.rb +1 -1
  133. data/lib/shipeasy_admin/models/list_metrics_response_inner.rb +1 -1
  134. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir.rb +3 -10
  135. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg.rb +1 -1
  136. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of.rb +1 -1
  137. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of1.rb +1 -1
  138. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of2.rb +1 -1
  139. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of3.rb +1 -1
  140. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of4.rb +1 -1
  141. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of5.rb +1 -1
  142. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of6.rb +1 -1
  143. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of7.rb +1 -1
  144. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of8.rb +1 -1
  145. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9.rb +1 -1
  146. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator.rb +1 -1
  147. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_agg_one_of9_numerator_filters_inner.rb +1 -1
  148. data/lib/shipeasy_admin/models/list_metrics_response_inner_query_ir_group_by.rb +1 -1
  149. data/lib/shipeasy_admin/models/list_ops_items_response_inner.rb +1 -1
  150. data/lib/shipeasy_admin/models/list_slack_channels_response.rb +1 -1
  151. data/lib/shipeasy_admin/models/list_slack_channels_response_channels_inner.rb +1 -1
  152. data/lib/shipeasy_admin/models/list_universes_response.rb +1 -1
  153. data/lib/shipeasy_admin/models/list_universes_response_data_inner.rb +1 -1
  154. data/lib/shipeasy_admin/models/{list_alert_rules_response_inner_notify.rb → notification_target.rb} +6 -24
  155. data/lib/shipeasy_admin/models/{list_alert_rules_response_inner_notify_slack_channel.rb → notification_target_slack_channel.rb} +4 -7
  156. data/lib/shipeasy_admin/models/notify_ops_request.rb +1 -1
  157. data/lib/shipeasy_admin/models/notify_ops_response.rb +1 -1
  158. data/lib/shipeasy_admin/models/publish_config_draft_request.rb +7 -10
  159. data/lib/shipeasy_admin/models/publish_config_draft_response.rb +7 -10
  160. data/lib/shipeasy_admin/models/publish_i18n_profile_request.rb +1 -1
  161. data/lib/shipeasy_admin/models/publish_i18n_profile_response.rb +1 -1
  162. data/lib/shipeasy_admin/models/push_i18n_keys_request.rb +1 -1
  163. data/lib/shipeasy_admin/models/push_i18n_keys_request_keys_inner.rb +1 -1
  164. data/lib/shipeasy_admin/models/push_i18n_keys_response.rb +1 -1
  165. data/lib/shipeasy_admin/models/reanalyze_experiment_response.rb +1 -1
  166. data/lib/shipeasy_admin/models/revoke_key_response.rb +216 -0
  167. data/lib/shipeasy_admin/models/save_config_draft_request.rb +7 -10
  168. data/lib/shipeasy_admin/models/save_config_draft_response.rb +7 -10
  169. data/lib/shipeasy_admin/models/search_hit.rb +284 -0
  170. data/lib/shipeasy_admin/models/search_response.rb +167 -0
  171. data/lib/shipeasy_admin/models/set_experiment_metrics_request.rb +1 -1
  172. data/lib/shipeasy_admin/models/set_experiment_metrics_request_metrics_inner.rb +1 -1
  173. data/lib/shipeasy_admin/models/set_experiment_metrics_response.rb +1 -1
  174. data/lib/shipeasy_admin/models/set_experiment_metrics_response_metrics_inner.rb +1 -1
  175. data/lib/shipeasy_admin/models/set_experiment_status_request.rb +1 -1
  176. data/lib/shipeasy_admin/models/set_experiment_status_response.rb +1 -1
  177. data/lib/shipeasy_admin/models/set_i18n_label_request.rb +213 -0
  178. data/lib/shipeasy_admin/models/set_i18n_label_response.rb +472 -0
  179. data/lib/shipeasy_admin/models/set_killswitch_switch_request.rb +7 -10
  180. data/lib/shipeasy_admin/models/set_killswitch_switch_response.rb +7 -10
  181. data/lib/shipeasy_admin/models/set_killswitch_value_request.rb +214 -0
  182. data/lib/shipeasy_admin/models/set_killswitch_value_response.rb +283 -0
  183. data/lib/shipeasy_admin/models/test_connector_response.rb +189 -0
  184. data/lib/shipeasy_admin/models/unset_killswitch_switch_request.rb +7 -10
  185. data/lib/shipeasy_admin/models/unset_killswitch_switch_response.rb +7 -10
  186. data/lib/shipeasy_admin/models/update_alert_rule_request.rb +2 -4
  187. data/lib/shipeasy_admin/models/update_alert_rule_response.rb +1 -1
  188. data/lib/shipeasy_admin/models/update_config_request.rb +2 -2
  189. data/lib/shipeasy_admin/models/update_config_response.rb +1 -1
  190. data/lib/shipeasy_admin/models/update_config_schema_request.rb +168 -0
  191. data/lib/shipeasy_admin/models/update_config_schema_response.rb +165 -0
  192. data/lib/shipeasy_admin/models/update_connector_request.rb +211 -0
  193. data/lib/shipeasy_admin/models/update_connector_response.rb +166 -0
  194. data/lib/shipeasy_admin/models/update_error_status_request.rb +190 -0
  195. data/lib/shipeasy_admin/models/update_event_request.rb +2 -2
  196. data/lib/shipeasy_admin/models/update_event_response.rb +1 -1
  197. data/lib/shipeasy_admin/models/update_experiment_request.rb +5 -4
  198. data/lib/shipeasy_admin/models/update_experiment_response.rb +1 -1
  199. data/lib/shipeasy_admin/models/update_gate_request.rb +2 -2
  200. data/lib/shipeasy_admin/models/update_gate_response.rb +1 -1
  201. data/lib/shipeasy_admin/models/update_i18n_key_request.rb +1 -1
  202. data/lib/shipeasy_admin/models/update_i18n_key_response.rb +1 -1
  203. data/lib/shipeasy_admin/models/update_killswitch_request.rb +2 -2
  204. data/lib/shipeasy_admin/models/update_killswitch_response.rb +1 -1
  205. data/lib/shipeasy_admin/models/update_ops_item_request.rb +1 -1
  206. data/lib/shipeasy_admin/models/update_ops_item_response.rb +1 -1
  207. data/lib/shipeasy_admin/models/update_universe_request.rb +2 -2
  208. data/lib/shipeasy_admin/models/update_universe_response.rb +1 -1
  209. data/lib/shipeasy_admin/models/upsert_project_request.rb +1 -1
  210. data/lib/shipeasy_admin/models/upsert_project_response.rb +1 -1
  211. data/lib/shipeasy_admin/version.rb +1 -1
  212. data/lib/shipeasy_admin.rb +56 -9
  213. metadata +56 -9
@@ -3,7 +3,7 @@
3
3
 
4
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
5
 
6
- The version of the OpenAPI document: 1.0.0
6
+ The version of the OpenAPI document: 2.0.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.23.0
@@ -13,149 +13,19 @@ Generator version: 7.23.0
13
13
  require 'cgi'
14
14
 
15
15
  module Shipeasy::Admin::Generated
16
- class I18nApi
16
+ class KeysApi
17
17
  attr_accessor :api_client
18
18
 
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Create an i18n profile
23
- # Create a locale profile. `name` is the stable handle (e.g. `fr:prod`). **Use case:** Stand up a new locale before seeding its keys.
24
- # @param create_i18n_profile_request [CreateI18nProfileRequest]
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 [CreateI18nProfileResponse]
28
- def create_i18n_profile(create_i18n_profile_request, opts = {})
29
- data, _status_code, _headers = create_i18n_profile_with_http_info(create_i18n_profile_request, opts)
30
- data
31
- end
32
-
33
- # Create an i18n profile
34
- # Create a locale profile. `name` is the stable handle (e.g. `fr:prod`). **Use case:** Stand up a new locale before seeding its keys.
35
- # @param create_i18n_profile_request [CreateI18nProfileRequest]
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<(CreateI18nProfileResponse, Integer, Hash)>] CreateI18nProfileResponse data, response status code and response headers
39
- def create_i18n_profile_with_http_info(create_i18n_profile_request, opts = {})
40
- if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: I18nApi.create_i18n_profile ...'
42
- end
43
- # verify the required parameter 'create_i18n_profile_request' is set
44
- if @api_client.config.client_side_validation && create_i18n_profile_request.nil?
45
- fail ArgumentError, "Missing the required parameter 'create_i18n_profile_request' when calling I18nApi.create_i18n_profile"
46
- end
47
- # resource path
48
- local_var_path = '/api/admin/i18n/profiles'
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_i18n_profile_request)
69
-
70
- # return_type
71
- return_type = opts[:debug_return_type] || 'CreateI18nProfileResponse'
72
-
73
- # auth_names
74
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
75
-
76
- new_options = opts.merge(
77
- :operation => :"I18nApi.create_i18n_profile",
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: I18nApi#create_i18n_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
89
- end
90
- return data, status_code, headers
91
- end
92
-
93
- # List translation drafts
94
- # List staged translation drafts awaiting review/publish. **Use case:** Review machine-translation drafts before publishing them to a locale.
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
- # @return [Array<ListI18nDraftsResponseInner>]
98
- def list_i18n_drafts(opts = {})
99
- data, _status_code, _headers = list_i18n_drafts_with_http_info(opts)
100
- data
101
- end
102
-
103
- # List translation drafts
104
- # List staged translation drafts awaiting review/publish. **Use case:** Review machine-translation drafts before publishing them to a locale.
105
- # @param [Hash] opts the optional parameters
106
- # @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).
107
- # @return [Array<(Array<ListI18nDraftsResponseInner>, Integer, Hash)>] Array<ListI18nDraftsResponseInner> data, response status code and response headers
108
- def list_i18n_drafts_with_http_info(opts = {})
109
- if @api_client.config.debugging
110
- @api_client.config.logger.debug 'Calling API: I18nApi.list_i18n_drafts ...'
111
- end
112
- # resource path
113
- local_var_path = '/api/admin/i18n/drafts'
114
-
115
- # query parameters
116
- query_params = opts[:query_params] || {}
117
-
118
- # header parameters
119
- header_params = opts[:header_params] || {}
120
- # HTTP header 'Accept' (if needed)
121
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
122
- header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
123
-
124
- # form parameters
125
- form_params = opts[:form_params] || {}
126
-
127
- # http body (model)
128
- post_body = opts[:debug_body]
129
-
130
- # return_type
131
- return_type = opts[:debug_return_type] || 'Array<ListI18nDraftsResponseInner>'
132
-
133
- # auth_names
134
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
135
-
136
- new_options = opts.merge(
137
- :operation => :"I18nApi.list_i18n_drafts",
138
- :header_params => header_params,
139
- :query_params => query_params,
140
- :form_params => form_params,
141
- :body => post_body,
142
- :auth_names => auth_names,
143
- :return_type => return_type
144
- )
145
-
146
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
147
- if @api_client.config.debugging
148
- @api_client.config.logger.debug "API called: I18nApi#list_i18n_drafts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
149
- end
150
- return data, status_code, headers
151
- end
152
-
153
22
  # List i18n keys
154
23
  # List keys for a profile, optionally filtered to a name `prefix`. **Use case:** Read the current keys (and values) for a profile — e.g. to diff before a push.
155
24
  # @param [Hash] opts the optional parameters
156
25
  # @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).
157
26
  # @option opts [String] :profile_id Profile id to list keys for.
158
27
  # @option opts [String] :prefix Only keys whose name starts with this.
28
+ # @option opts [String] :q Free-text search — matches keys whose name OR value contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy.
159
29
  # @option opts [Integer] :limit Max keys to return (1–500).
160
30
  # @return [ListI18nKeysResponse]
161
31
  def list_i18n_keys(opts = {})
@@ -169,18 +39,19 @@ module Shipeasy::Admin::Generated
169
39
  # @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).
170
40
  # @option opts [String] :profile_id Profile id to list keys for.
171
41
  # @option opts [String] :prefix Only keys whose name starts with this.
42
+ # @option opts [String] :q Free-text search — matches keys whose name OR value contains this substring (case-insensitive). Use it to find the key behind a piece of on-screen copy.
172
43
  # @option opts [Integer] :limit Max keys to return (1–500).
173
44
  # @return [Array<(ListI18nKeysResponse, Integer, Hash)>] ListI18nKeysResponse data, response status code and response headers
174
45
  def list_i18n_keys_with_http_info(opts = {})
175
46
  if @api_client.config.debugging
176
- @api_client.config.logger.debug 'Calling API: I18nApi.list_i18n_keys ...'
47
+ @api_client.config.logger.debug 'Calling API: KeysApi.list_i18n_keys ...'
177
48
  end
178
49
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
179
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling I18nApi.list_i18n_keys, must be smaller than or equal to 500.'
50
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KeysApi.list_i18n_keys, must be smaller than or equal to 500.'
180
51
  end
181
52
 
182
53
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
183
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling I18nApi.list_i18n_keys, must be greater than or equal to 1.'
54
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KeysApi.list_i18n_keys, must be greater than or equal to 1.'
184
55
  end
185
56
 
186
57
  # resource path
@@ -190,6 +61,7 @@ module Shipeasy::Admin::Generated
190
61
  query_params = opts[:query_params] || {}
191
62
  query_params[:'profile_id'] = opts[:'profile_id'] if !opts[:'profile_id'].nil?
192
63
  query_params[:'prefix'] = opts[:'prefix'] if !opts[:'prefix'].nil?
64
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
193
65
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
194
66
 
195
67
  # header parameters
@@ -211,7 +83,7 @@ module Shipeasy::Admin::Generated
211
83
  auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
212
84
 
213
85
  new_options = opts.merge(
214
- :operation => :"I18nApi.list_i18n_keys",
86
+ :operation => :"KeysApi.list_i18n_keys",
215
87
  :header_params => header_params,
216
88
  :query_params => query_params,
217
89
  :form_params => form_params,
@@ -222,100 +94,38 @@ module Shipeasy::Admin::Generated
222
94
 
223
95
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
224
96
  if @api_client.config.debugging
225
- @api_client.config.logger.debug "API called: I18nApi#list_i18n_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
97
+ @api_client.config.logger.debug "API called: KeysApi#list_i18n_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
226
98
  end
227
99
  return data, status_code, headers
228
100
  end
229
101
 
230
- # List i18n profiles
231
- # Returns every locale profile in the project (e.g. `en:prod`, `fr:prod`). **Use case:** Discover which locale profiles exist before pushing keys or publishing a chunk.
232
- # @param [Hash] opts the optional parameters
233
- # @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).
234
- # @return [Array<ListI18nProfilesResponseInner>]
235
- def list_i18n_profiles(opts = {})
236
- data, _status_code, _headers = list_i18n_profiles_with_http_info(opts)
237
- data
238
- end
239
-
240
- # List i18n profiles
241
- # Returns every locale profile in the project (e.g. &#x60;en:prod&#x60;, &#x60;fr:prod&#x60;). **Use case:** Discover which locale profiles exist before pushing keys or publishing a chunk.
242
- # @param [Hash] opts the optional parameters
243
- # @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).
244
- # @return [Array<(Array<ListI18nProfilesResponseInner>, Integer, Hash)>] Array<ListI18nProfilesResponseInner> data, response status code and response headers
245
- def list_i18n_profiles_with_http_info(opts = {})
246
- if @api_client.config.debugging
247
- @api_client.config.logger.debug 'Calling API: I18nApi.list_i18n_profiles ...'
248
- end
249
- # resource path
250
- local_var_path = '/api/admin/i18n/profiles'
251
-
252
- # query parameters
253
- query_params = opts[:query_params] || {}
254
-
255
- # header parameters
256
- header_params = opts[:header_params] || {}
257
- # HTTP header 'Accept' (if needed)
258
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
259
- header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
260
-
261
- # form parameters
262
- form_params = opts[:form_params] || {}
263
-
264
- # http body (model)
265
- post_body = opts[:debug_body]
266
-
267
- # return_type
268
- return_type = opts[:debug_return_type] || 'Array<ListI18nProfilesResponseInner>'
269
-
270
- # auth_names
271
- auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
272
-
273
- new_options = opts.merge(
274
- :operation => :"I18nApi.list_i18n_profiles",
275
- :header_params => header_params,
276
- :query_params => query_params,
277
- :form_params => form_params,
278
- :body => post_body,
279
- :auth_names => auth_names,
280
- :return_type => return_type
281
- )
282
-
283
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
284
- if @api_client.config.debugging
285
- @api_client.config.logger.debug "API called: I18nApi#list_i18n_profiles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
286
- end
287
- return data, status_code, headers
288
- end
289
-
290
- # Publish a profile chunk
291
- # Publish a profile's chunk to the CDN (rebuild KV manifest + purge). Defaults to the `default` chunk. **Use case:** Ship the latest translations live after pushing/updating keys.
292
- # @param profile_id [String] The profile id to publish.
293
- # @param publish_i18n_profile_request [PublishI18nProfileRequest]
102
+ # Push new i18n keys (insert-only)
103
+ # Add NEW keys to a profile. Insert-only existing keys are left untouched (overwrite one with `updateI18nKey`). **Use case:** Seed newly-extracted keys without clobbering translations already in the profile.
104
+ # @param push_i18n_keys_request [PushI18nKeysRequest]
294
105
  # @param [Hash] opts the optional parameters
295
106
  # @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).
296
- # @return [PublishI18nProfileResponse]
297
- def publish_i18n_profile(profile_id, publish_i18n_profile_request, opts = {})
298
- data, _status_code, _headers = publish_i18n_profile_with_http_info(profile_id, publish_i18n_profile_request, opts)
107
+ # @return [PushI18nKeysResponse]
108
+ def push_i18n_keys(push_i18n_keys_request, opts = {})
109
+ data, _status_code, _headers = push_i18n_keys_with_http_info(push_i18n_keys_request, opts)
299
110
  data
300
111
  end
301
112
 
302
- # Publish a profile chunk
303
- # Publish a profile&#39;s chunk to the CDN (rebuild KV manifest + purge). Defaults to the &#x60;default&#x60; chunk. **Use case:** Ship the latest translations live after pushing/updating keys.
304
- # @param profile_id [String] The profile id to publish.
305
- # @param publish_i18n_profile_request [PublishI18nProfileRequest]
113
+ # Push new i18n keys (insert-only)
114
+ # Add NEW keys to a profile. Insert-only existing keys are left untouched (overwrite one with &#x60;updateI18nKey&#x60;). **Use case:** Seed newly-extracted keys without clobbering translations already in the profile.
115
+ # @param push_i18n_keys_request [PushI18nKeysRequest]
306
116
  # @param [Hash] opts the optional parameters
307
117
  # @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).
308
- # @return [Array<(PublishI18nProfileResponse, Integer, Hash)>] PublishI18nProfileResponse data, response status code and response headers
309
- def publish_i18n_profile_with_http_info(profile_id, publish_i18n_profile_request, opts = {})
118
+ # @return [Array<(PushI18nKeysResponse, Integer, Hash)>] PushI18nKeysResponse data, response status code and response headers
119
+ def push_i18n_keys_with_http_info(push_i18n_keys_request, opts = {})
310
120
  if @api_client.config.debugging
311
- @api_client.config.logger.debug 'Calling API: I18nApi.publish_i18n_profile ...'
121
+ @api_client.config.logger.debug 'Calling API: KeysApi.push_i18n_keys ...'
312
122
  end
313
- # verify the required parameter 'publish_i18n_profile_request' is set
314
- if @api_client.config.client_side_validation && publish_i18n_profile_request.nil?
315
- fail ArgumentError, "Missing the required parameter 'publish_i18n_profile_request' when calling I18nApi.publish_i18n_profile"
123
+ # verify the required parameter 'push_i18n_keys_request' is set
124
+ if @api_client.config.client_side_validation && push_i18n_keys_request.nil?
125
+ fail ArgumentError, "Missing the required parameter 'push_i18n_keys_request' when calling KeysApi.push_i18n_keys"
316
126
  end
317
127
  # resource path
318
- local_var_path = '/api/admin/i18n/profiles/{profileId}/publish'.sub('{profileId}', CGI.escape(profile_id.to_s))
128
+ local_var_path = '/api/admin/i18n/keys'
319
129
 
320
130
  # query parameters
321
131
  query_params = opts[:query_params] || {}
@@ -335,16 +145,16 @@ module Shipeasy::Admin::Generated
335
145
  form_params = opts[:form_params] || {}
336
146
 
337
147
  # http body (model)
338
- post_body = opts[:debug_body] || @api_client.object_to_http_body(publish_i18n_profile_request)
148
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(push_i18n_keys_request)
339
149
 
340
150
  # return_type
341
- return_type = opts[:debug_return_type] || 'PublishI18nProfileResponse'
151
+ return_type = opts[:debug_return_type] || 'PushI18nKeysResponse'
342
152
 
343
153
  # auth_names
344
154
  auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
345
155
 
346
156
  new_options = opts.merge(
347
- :operation => :"I18nApi.publish_i18n_profile",
157
+ :operation => :"KeysApi.push_i18n_keys",
348
158
  :header_params => header_params,
349
159
  :query_params => query_params,
350
160
  :form_params => form_params,
@@ -355,38 +165,38 @@ module Shipeasy::Admin::Generated
355
165
 
356
166
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
357
167
  if @api_client.config.debugging
358
- @api_client.config.logger.debug "API called: I18nApi#publish_i18n_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
168
+ @api_client.config.logger.debug "API called: KeysApi#push_i18n_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
359
169
  end
360
170
  return data, status_code, headers
361
171
  end
362
172
 
363
- # Push new i18n keys (insert-only)
364
- # Add NEW keys to a profile. Insert-only existing keys are left untouched (overwrite one with `updateI18nKey`). **Use case:** Seed newly-extracted keys without clobbering translations already in the profile.
365
- # @param push_i18n_keys_request [PushI18nKeysRequest]
173
+ # Set a key's value and publish it live
174
+ # Upsert a single key's value into a profile and immediately publish the whole profile (KV rebuild + CDN purge) so the new value is live in one call. The key is inserted when new and overwritten when it already exists. `profile` is a profile name — omit it to target the project's default-marked profile, or pass a name to target another locale. **Use case:** Correct or replace one live string and ship it without a separate `push` + `publish`.
175
+ # @param set_i18n_label_request [SetI18nLabelRequest]
366
176
  # @param [Hash] opts the optional parameters
367
177
  # @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).
368
- # @return [PushI18nKeysResponse]
369
- def push_i18n_keys(push_i18n_keys_request, opts = {})
370
- data, _status_code, _headers = push_i18n_keys_with_http_info(push_i18n_keys_request, opts)
178
+ # @return [SetI18nLabelResponse]
179
+ def set_i18n_label(set_i18n_label_request, opts = {})
180
+ data, _status_code, _headers = set_i18n_label_with_http_info(set_i18n_label_request, opts)
371
181
  data
372
182
  end
373
183
 
374
- # Push new i18n keys (insert-only)
375
- # Add NEW keys to a profile. Insert-only existing keys are left untouched (overwrite one with &#x60;updateI18nKey&#x60;). **Use case:** Seed newly-extracted keys without clobbering translations already in the profile.
376
- # @param push_i18n_keys_request [PushI18nKeysRequest]
184
+ # Set a key&#39;s value and publish it live
185
+ # Upsert a single key&#39;s value into a profile and immediately publish the whole profile (KV rebuild + CDN purge) so the new value is live in one call. The key is inserted when new and overwritten when it already exists. &#x60;profile&#x60; is a profile name — omit it to target the project&#39;s default-marked profile, or pass a name to target another locale. **Use case:** Correct or replace one live string and ship it without a separate &#x60;push&#x60; + &#x60;publish&#x60;.
186
+ # @param set_i18n_label_request [SetI18nLabelRequest]
377
187
  # @param [Hash] opts the optional parameters
378
188
  # @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).
379
- # @return [Array<(PushI18nKeysResponse, Integer, Hash)>] PushI18nKeysResponse data, response status code and response headers
380
- def push_i18n_keys_with_http_info(push_i18n_keys_request, opts = {})
189
+ # @return [Array<(SetI18nLabelResponse, Integer, Hash)>] SetI18nLabelResponse data, response status code and response headers
190
+ def set_i18n_label_with_http_info(set_i18n_label_request, opts = {})
381
191
  if @api_client.config.debugging
382
- @api_client.config.logger.debug 'Calling API: I18nApi.push_i18n_keys ...'
192
+ @api_client.config.logger.debug 'Calling API: KeysApi.set_i18n_label ...'
383
193
  end
384
- # verify the required parameter 'push_i18n_keys_request' is set
385
- if @api_client.config.client_side_validation && push_i18n_keys_request.nil?
386
- fail ArgumentError, "Missing the required parameter 'push_i18n_keys_request' when calling I18nApi.push_i18n_keys"
194
+ # verify the required parameter 'set_i18n_label_request' is set
195
+ if @api_client.config.client_side_validation && set_i18n_label_request.nil?
196
+ fail ArgumentError, "Missing the required parameter 'set_i18n_label_request' when calling KeysApi.set_i18n_label"
387
197
  end
388
198
  # resource path
389
- local_var_path = '/api/admin/i18n/keys'
199
+ local_var_path = '/api/admin/i18n/set'
390
200
 
391
201
  # query parameters
392
202
  query_params = opts[:query_params] || {}
@@ -406,16 +216,16 @@ module Shipeasy::Admin::Generated
406
216
  form_params = opts[:form_params] || {}
407
217
 
408
218
  # http body (model)
409
- post_body = opts[:debug_body] || @api_client.object_to_http_body(push_i18n_keys_request)
219
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(set_i18n_label_request)
410
220
 
411
221
  # return_type
412
- return_type = opts[:debug_return_type] || 'PushI18nKeysResponse'
222
+ return_type = opts[:debug_return_type] || 'SetI18nLabelResponse'
413
223
 
414
224
  # auth_names
415
225
  auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
416
226
 
417
227
  new_options = opts.merge(
418
- :operation => :"I18nApi.push_i18n_keys",
228
+ :operation => :"KeysApi.set_i18n_label",
419
229
  :header_params => header_params,
420
230
  :query_params => query_params,
421
231
  :form_params => form_params,
@@ -426,7 +236,7 @@ module Shipeasy::Admin::Generated
426
236
 
427
237
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
428
238
  if @api_client.config.debugging
429
- @api_client.config.logger.debug "API called: I18nApi#push_i18n_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
239
+ @api_client.config.logger.debug "API called: KeysApi#set_i18n_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
430
240
  end
431
241
  return data, status_code, headers
432
242
  end
@@ -452,11 +262,11 @@ module Shipeasy::Admin::Generated
452
262
  # @return [Array<(UpdateI18nKeyResponse, Integer, Hash)>] UpdateI18nKeyResponse data, response status code and response headers
453
263
  def update_i18n_key_with_http_info(id, update_i18n_key_request, opts = {})
454
264
  if @api_client.config.debugging
455
- @api_client.config.logger.debug 'Calling API: I18nApi.update_i18n_key ...'
265
+ @api_client.config.logger.debug 'Calling API: KeysApi.update_i18n_key ...'
456
266
  end
457
267
  # verify the required parameter 'update_i18n_key_request' is set
458
268
  if @api_client.config.client_side_validation && update_i18n_key_request.nil?
459
- fail ArgumentError, "Missing the required parameter 'update_i18n_key_request' when calling I18nApi.update_i18n_key"
269
+ fail ArgumentError, "Missing the required parameter 'update_i18n_key_request' when calling KeysApi.update_i18n_key"
460
270
  end
461
271
  # resource path
462
272
  local_var_path = '/api/admin/i18n/keys/{id}'.sub('{id}', CGI.escape(id.to_s))
@@ -488,7 +298,7 @@ module Shipeasy::Admin::Generated
488
298
  auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
489
299
 
490
300
  new_options = opts.merge(
491
- :operation => :"I18nApi.update_i18n_key",
301
+ :operation => :"KeysApi.update_i18n_key",
492
302
  :header_params => header_params,
493
303
  :query_params => query_params,
494
304
  :form_params => form_params,
@@ -499,7 +309,7 @@ module Shipeasy::Admin::Generated
499
309
 
500
310
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
501
311
  if @api_client.config.debugging
502
- @api_client.config.logger.debug "API called: I18nApi#update_i18n_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
312
+ @api_client.config.logger.debug "API called: KeysApi#update_i18n_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
503
313
  end
504
314
  return data, status_code, headers
505
315
  end