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,201 +0,0 @@
1
- =begin
2
- #Shipeasy Admin API
3
-
4
- #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
5
-
6
- The version of the OpenAPI document: 2.0.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.23.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module Shipeasy::Admin::Generated
17
- class CreateKillswitchResponse < ApiModelBase
18
- # Newly assigned killswitch id.
19
- attr_accessor :id
20
-
21
- # Stable config key in `folder.name` form (two lowercase segments separated by a dot, e.g. `pricing.tiers`). Used by SDKs as `Shipeasy.getConfig('<name>')`. Immutable after create.
22
- attr_accessor :name
23
-
24
- # Attribute mapping from ruby-style variable name to JSON key.
25
- def self.attribute_map
26
- {
27
- :'id' => :'id',
28
- :'name' => :'name'
29
- }
30
- end
31
-
32
- # Returns attribute mapping this model knows about
33
- def self.acceptable_attribute_map
34
- attribute_map
35
- end
36
-
37
- # Returns all the JSON keys this model knows about
38
- def self.acceptable_attributes
39
- acceptable_attribute_map.values
40
- end
41
-
42
- # Attribute type mapping.
43
- def self.openapi_types
44
- {
45
- :'id' => :'String',
46
- :'name' => :'String'
47
- }
48
- end
49
-
50
- # List of attributes with nullable: true
51
- def self.openapi_nullable
52
- Set.new([
53
- ])
54
- end
55
-
56
- # Initializes the object
57
- # @param [Hash] attributes Model attributes in the form of hash
58
- def initialize(attributes = {})
59
- if (!attributes.is_a?(Hash))
60
- fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::CreateKillswitchResponse` initialize method"
61
- end
62
-
63
- # check to see if the attribute exists and convert string to symbol for hash key
64
- acceptable_attribute_map = self.class.acceptable_attribute_map
65
- attributes = attributes.each_with_object({}) { |(k, v), h|
66
- if (!acceptable_attribute_map.key?(k.to_sym))
67
- fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::CreateKillswitchResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
68
- end
69
- h[k.to_sym] = v
70
- }
71
-
72
- if attributes.key?(:'id')
73
- self.id = attributes[:'id']
74
- else
75
- self.id = nil
76
- end
77
-
78
- if attributes.key?(:'name')
79
- self.name = attributes[:'name']
80
- else
81
- self.name = nil
82
- end
83
- end
84
-
85
- # Show invalid properties with the reasons. Usually used together with valid?
86
- # @return Array for valid properties with the reasons
87
- def list_invalid_properties
88
- warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
89
- invalid_properties = Array.new
90
- if @id.nil?
91
- invalid_properties.push('invalid value for "id", id cannot be nil.')
92
- end
93
-
94
- if @name.nil?
95
- invalid_properties.push('invalid value for "name", name cannot be nil.')
96
- end
97
-
98
- if @name.to_s.length > 128
99
- invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
100
- end
101
-
102
- invalid_properties
103
- end
104
-
105
- # Check to see if the all the properties in the model are valid
106
- # @return true if the model is valid
107
- def valid?
108
- warn '[DEPRECATED] the `valid?` method is obsolete'
109
- return false if @id.nil?
110
- return false if @name.nil?
111
- return false if @name.to_s.length > 128
112
- true
113
- end
114
-
115
- # Custom attribute writer method with validation
116
- # @param [Object] id Value to be assigned
117
- def id=(id)
118
- if id.nil?
119
- fail ArgumentError, 'id cannot be nil'
120
- end
121
-
122
- @id = id
123
- end
124
-
125
- # Custom attribute writer method with validation
126
- # @param [Object] name Value to be assigned
127
- def name=(name)
128
- if name.nil?
129
- fail ArgumentError, 'name cannot be nil'
130
- end
131
-
132
- if name.to_s.length > 128
133
- fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 128.'
134
- end
135
-
136
- @name = name
137
- end
138
-
139
- # Checks equality by comparing each attribute.
140
- # @param [Object] Object to be compared
141
- def ==(o)
142
- return true if self.equal?(o)
143
- self.class == o.class &&
144
- id == o.id &&
145
- name == o.name
146
- end
147
-
148
- # @see the `==` method
149
- # @param [Object] Object to be compared
150
- def eql?(o)
151
- self == o
152
- end
153
-
154
- # Calculates hash code according to all attributes.
155
- # @return [Integer] Hash code
156
- def hash
157
- [id, name].hash
158
- end
159
-
160
- # Builds the object from hash
161
- # @param [Hash] attributes Model attributes in the form of hash
162
- # @return [Object] Returns the model itself
163
- def self.build_from_hash(attributes)
164
- return nil unless attributes.is_a?(Hash)
165
- attributes = attributes.transform_keys(&:to_sym)
166
- transformed_hash = {}
167
- openapi_types.each_pair do |key, type|
168
- if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
169
- transformed_hash["#{key}"] = nil
170
- elsif type =~ /\AArray<(.*)>/i
171
- # check to ensure the input is an array given that the attribute
172
- # is documented as an array but the input is not
173
- if attributes[attribute_map[key]].is_a?(Array)
174
- transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
175
- end
176
- elsif !attributes[attribute_map[key]].nil?
177
- transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
178
- end
179
- end
180
- new(transformed_hash)
181
- end
182
-
183
- # Returns the object in the form of hash
184
- # @return [Hash] Returns the object in the form of hash
185
- def to_hash
186
- hash = {}
187
- self.class.attribute_map.each_pair do |attr, param|
188
- value = self.send(attr)
189
- if value.nil?
190
- is_nullable = self.class.openapi_nullable.include?(attr)
191
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
192
- end
193
-
194
- hash[param] = _to_hash(value)
195
- end
196
- hash
197
- end
198
-
199
- end
200
-
201
- end
@@ -1,403 +0,0 @@
1
- =begin
2
- #Shipeasy Admin API
3
-
4
- #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header. Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
5
-
6
- The version of the OpenAPI document: 2.0.0
7
-
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.23.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module Shipeasy::Admin::Generated
17
- # Body for `POST /api/admin/metrics`. Requires `name`, `event_name`, and exactly one of `query` / `query_ir`.
18
- class CreateMetricRequest < ApiModelBase
19
- # Stable metric key. Single segment or `folder.name`; lowercase letters, digits, `_`/`-`; max 128 chars.
20
- attr_accessor :name
21
-
22
- # Optional folder name grouping items in the dashboard. Alphanumeric, `_` or `-` (no `/`). Part of the SDK lookup key (`<folder>/<name>`).
23
- attr_accessor :folder
24
-
25
- # Source event the query reads from.
26
- attr_accessor :event_name
27
-
28
- # Metric query DSL string, e.g. `sum(purchase, amount)`. Provide this OR `query_ir`.
29
- attr_accessor :query
30
-
31
- attr_accessor :query_ir
32
-
33
- # Winsorise percentile (1–99) to clamp outliers. Defaults to 99.
34
- attr_accessor :winsorize_pct
35
-
36
- # Minimum detectable effect (relative, 0–1) for power planning. `null` to omit.
37
- attr_accessor :min_detectable_effect
38
-
39
- # Desired direction of movement. `higher_better` (default), `lower_better`, or `neutral` (guardrail).
40
- attr_accessor :direction
41
-
42
- class EnumAttributeValidator
43
- attr_reader :datatype
44
- attr_reader :allowable_values
45
-
46
- def initialize(datatype, allowable_values)
47
- @allowable_values = allowable_values.map do |value|
48
- case datatype.to_s
49
- when /Integer/i
50
- value.to_i
51
- when /Float/i
52
- value.to_f
53
- else
54
- value
55
- end
56
- end
57
- end
58
-
59
- def valid?(value)
60
- !value || allowable_values.include?(value)
61
- end
62
- end
63
-
64
- # Attribute mapping from ruby-style variable name to JSON key.
65
- def self.attribute_map
66
- {
67
- :'name' => :'name',
68
- :'folder' => :'folder',
69
- :'event_name' => :'event_name',
70
- :'query' => :'query',
71
- :'query_ir' => :'query_ir',
72
- :'winsorize_pct' => :'winsorize_pct',
73
- :'min_detectable_effect' => :'min_detectable_effect',
74
- :'direction' => :'direction'
75
- }
76
- end
77
-
78
- # Returns attribute mapping this model knows about
79
- def self.acceptable_attribute_map
80
- attribute_map
81
- end
82
-
83
- # Returns all the JSON keys this model knows about
84
- def self.acceptable_attributes
85
- acceptable_attribute_map.values
86
- end
87
-
88
- # Attribute type mapping.
89
- def self.openapi_types
90
- {
91
- :'name' => :'String',
92
- :'folder' => :'String',
93
- :'event_name' => :'String',
94
- :'query' => :'String',
95
- :'query_ir' => :'ListMetricsResponseInnerQueryIr',
96
- :'winsorize_pct' => :'Integer',
97
- :'min_detectable_effect' => :'Float',
98
- :'direction' => :'String'
99
- }
100
- end
101
-
102
- # List of attributes with nullable: true
103
- def self.openapi_nullable
104
- Set.new([
105
- :'folder',
106
- :'min_detectable_effect',
107
- ])
108
- end
109
-
110
- # Initializes the object
111
- # @param [Hash] attributes Model attributes in the form of hash
112
- def initialize(attributes = {})
113
- if (!attributes.is_a?(Hash))
114
- fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::CreateMetricRequest` initialize method"
115
- end
116
-
117
- # check to see if the attribute exists and convert string to symbol for hash key
118
- acceptable_attribute_map = self.class.acceptable_attribute_map
119
- attributes = attributes.each_with_object({}) { |(k, v), h|
120
- if (!acceptable_attribute_map.key?(k.to_sym))
121
- fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::CreateMetricRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
122
- end
123
- h[k.to_sym] = v
124
- }
125
-
126
- if attributes.key?(:'name')
127
- self.name = attributes[:'name']
128
- else
129
- self.name = nil
130
- end
131
-
132
- if attributes.key?(:'folder')
133
- self.folder = attributes[:'folder']
134
- end
135
-
136
- if attributes.key?(:'event_name')
137
- self.event_name = attributes[:'event_name']
138
- else
139
- self.event_name = nil
140
- end
141
-
142
- if attributes.key?(:'query')
143
- self.query = attributes[:'query']
144
- end
145
-
146
- if attributes.key?(:'query_ir')
147
- self.query_ir = attributes[:'query_ir']
148
- end
149
-
150
- if attributes.key?(:'winsorize_pct')
151
- self.winsorize_pct = attributes[:'winsorize_pct']
152
- else
153
- self.winsorize_pct = 99
154
- end
155
-
156
- if attributes.key?(:'min_detectable_effect')
157
- self.min_detectable_effect = attributes[:'min_detectable_effect']
158
- end
159
-
160
- if attributes.key?(:'direction')
161
- self.direction = attributes[:'direction']
162
- else
163
- self.direction = 'higher_better'
164
- end
165
- end
166
-
167
- # Show invalid properties with the reasons. Usually used together with valid?
168
- # @return Array for valid properties with the reasons
169
- def list_invalid_properties
170
- warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
171
- invalid_properties = Array.new
172
- if @name.nil?
173
- invalid_properties.push('invalid value for "name", name cannot be nil.')
174
- end
175
-
176
- if @name.to_s.length > 128
177
- invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
178
- end
179
-
180
- pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
181
- if @name !~ pattern
182
- invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
183
- end
184
-
185
- if !@folder.nil? && @folder.to_s.length > 256
186
- invalid_properties.push('invalid value for "folder", the character length must be smaller than or equal to 256.')
187
- end
188
-
189
- pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
190
- if !@folder.nil? && @folder !~ pattern
191
- invalid_properties.push("invalid value for \"folder\", must conform to the pattern #{pattern}.")
192
- end
193
-
194
- if @event_name.nil?
195
- invalid_properties.push('invalid value for "event_name", event_name cannot be nil.')
196
- end
197
-
198
- if @event_name.to_s.length < 1
199
- invalid_properties.push('invalid value for "event_name", the character length must be greater than or equal to 1.')
200
- end
201
-
202
- if !@query.nil? && @query.to_s.length > 4096
203
- invalid_properties.push('invalid value for "query", the character length must be smaller than or equal to 4096.')
204
- end
205
-
206
- if !@query.nil? && @query.to_s.length < 1
207
- invalid_properties.push('invalid value for "query", the character length must be greater than or equal to 1.')
208
- end
209
-
210
- if !@winsorize_pct.nil? && @winsorize_pct > 99
211
- invalid_properties.push('invalid value for "winsorize_pct", must be smaller than or equal to 99.')
212
- end
213
-
214
- if !@winsorize_pct.nil? && @winsorize_pct < 1
215
- invalid_properties.push('invalid value for "winsorize_pct", must be greater than or equal to 1.')
216
- end
217
-
218
- invalid_properties
219
- end
220
-
221
- # Check to see if the all the properties in the model are valid
222
- # @return true if the model is valid
223
- def valid?
224
- warn '[DEPRECATED] the `valid?` method is obsolete'
225
- return false if @name.nil?
226
- return false if @name.to_s.length > 128
227
- return false if @name !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
228
- return false if !@folder.nil? && @folder.to_s.length > 256
229
- return false if !@folder.nil? && @folder !~ Regexp.new(/^[a-zA-Z0-9_-]+$/)
230
- return false if @event_name.nil?
231
- return false if @event_name.to_s.length < 1
232
- return false if !@query.nil? && @query.to_s.length > 4096
233
- return false if !@query.nil? && @query.to_s.length < 1
234
- return false if !@winsorize_pct.nil? && @winsorize_pct > 99
235
- return false if !@winsorize_pct.nil? && @winsorize_pct < 1
236
- direction_validator = EnumAttributeValidator.new('String', ["higher_better", "lower_better", "neutral"])
237
- return false unless direction_validator.valid?(@direction)
238
- true
239
- end
240
-
241
- # Custom attribute writer method with validation
242
- # @param [Object] name Value to be assigned
243
- def name=(name)
244
- if name.nil?
245
- fail ArgumentError, 'name cannot be nil'
246
- end
247
-
248
- if name.to_s.length > 128
249
- fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 128.'
250
- end
251
-
252
- pattern = Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
253
- if name !~ pattern
254
- fail ArgumentError, "invalid value for \"name\", must conform to the pattern #{pattern}."
255
- end
256
-
257
- @name = name
258
- end
259
-
260
- # Custom attribute writer method with validation
261
- # @param [Object] folder Value to be assigned
262
- def folder=(folder)
263
- if !folder.nil? && folder.to_s.length > 256
264
- fail ArgumentError, 'invalid value for "folder", the character length must be smaller than or equal to 256.'
265
- end
266
-
267
- pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
268
- if !folder.nil? && folder !~ pattern
269
- fail ArgumentError, "invalid value for \"folder\", must conform to the pattern #{pattern}."
270
- end
271
-
272
- @folder = folder
273
- end
274
-
275
- # Custom attribute writer method with validation
276
- # @param [Object] event_name Value to be assigned
277
- def event_name=(event_name)
278
- if event_name.nil?
279
- fail ArgumentError, 'event_name cannot be nil'
280
- end
281
-
282
- if event_name.to_s.length < 1
283
- fail ArgumentError, 'invalid value for "event_name", the character length must be greater than or equal to 1.'
284
- end
285
-
286
- @event_name = event_name
287
- end
288
-
289
- # Custom attribute writer method with validation
290
- # @param [Object] query Value to be assigned
291
- def query=(query)
292
- if query.nil?
293
- fail ArgumentError, 'query cannot be nil'
294
- end
295
-
296
- if query.to_s.length > 4096
297
- fail ArgumentError, 'invalid value for "query", the character length must be smaller than or equal to 4096.'
298
- end
299
-
300
- if query.to_s.length < 1
301
- fail ArgumentError, 'invalid value for "query", the character length must be greater than or equal to 1.'
302
- end
303
-
304
- @query = query
305
- end
306
-
307
- # Custom attribute writer method with validation
308
- # @param [Object] winsorize_pct Value to be assigned
309
- def winsorize_pct=(winsorize_pct)
310
- if winsorize_pct.nil?
311
- fail ArgumentError, 'winsorize_pct cannot be nil'
312
- end
313
-
314
- if winsorize_pct > 99
315
- fail ArgumentError, 'invalid value for "winsorize_pct", must be smaller than or equal to 99.'
316
- end
317
-
318
- if winsorize_pct < 1
319
- fail ArgumentError, 'invalid value for "winsorize_pct", must be greater than or equal to 1.'
320
- end
321
-
322
- @winsorize_pct = winsorize_pct
323
- end
324
-
325
- # Custom attribute writer method checking allowed values (enum).
326
- # @param [Object] direction Object to be assigned
327
- def direction=(direction)
328
- validator = EnumAttributeValidator.new('String', ["higher_better", "lower_better", "neutral"])
329
- unless validator.valid?(direction)
330
- fail ArgumentError, "invalid value for \"direction\", must be one of #{validator.allowable_values}."
331
- end
332
- @direction = direction
333
- end
334
-
335
- # Checks equality by comparing each attribute.
336
- # @param [Object] Object to be compared
337
- def ==(o)
338
- return true if self.equal?(o)
339
- self.class == o.class &&
340
- name == o.name &&
341
- folder == o.folder &&
342
- event_name == o.event_name &&
343
- query == o.query &&
344
- query_ir == o.query_ir &&
345
- winsorize_pct == o.winsorize_pct &&
346
- min_detectable_effect == o.min_detectable_effect &&
347
- direction == o.direction
348
- end
349
-
350
- # @see the `==` method
351
- # @param [Object] Object to be compared
352
- def eql?(o)
353
- self == o
354
- end
355
-
356
- # Calculates hash code according to all attributes.
357
- # @return [Integer] Hash code
358
- def hash
359
- [name, folder, event_name, query, query_ir, winsorize_pct, min_detectable_effect, direction].hash
360
- end
361
-
362
- # Builds the object from hash
363
- # @param [Hash] attributes Model attributes in the form of hash
364
- # @return [Object] Returns the model itself
365
- def self.build_from_hash(attributes)
366
- return nil unless attributes.is_a?(Hash)
367
- attributes = attributes.transform_keys(&:to_sym)
368
- transformed_hash = {}
369
- openapi_types.each_pair do |key, type|
370
- if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
371
- transformed_hash["#{key}"] = nil
372
- elsif type =~ /\AArray<(.*)>/i
373
- # check to ensure the input is an array given that the attribute
374
- # is documented as an array but the input is not
375
- if attributes[attribute_map[key]].is_a?(Array)
376
- transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
377
- end
378
- elsif !attributes[attribute_map[key]].nil?
379
- transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
380
- end
381
- end
382
- new(transformed_hash)
383
- end
384
-
385
- # Returns the object in the form of hash
386
- # @return [Hash] Returns the object in the form of hash
387
- def to_hash
388
- hash = {}
389
- self.class.attribute_map.each_pair do |attr, param|
390
- value = self.send(attr)
391
- if value.nil?
392
- is_nullable = self.class.openapi_nullable.include?(attr)
393
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
394
- end
395
-
396
- hash[param] = _to_hash(value)
397
- end
398
- hash
399
- end
400
-
401
- end
402
-
403
- end