RubyGems - shipeasy-sdk - Versions diffs - 2.1.0 → 2.3.0 - Mend

shipeasy-sdk 2.1.0 → 2.3.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 (171) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f3b0db78c3e6319bafac4913bb823b3dbc24a2e5f7166b1fe9a820f5588fadc
-  data.tar.gz: f232c0e140c5891bfd19112e8cea8877b42159806c5aba46185f54bd52b8d3ec
+  metadata.gz: 434e056f9f0849c73316e812f9ff8918ad838d9161283db0b3a8c9c7450b1077
+  data.tar.gz: beb6a893abc08ec7463a64fb2ec22f7df014f4da147b824a5f7b8d70ed3f34a0
 SHA512:
-  metadata.gz: 546b88ba03ff9944de78b6982c142b4beba2325dd2b07702bf83518ce7b29778ca2f963c69b3fdfa30fab4a65ff3327ef700666a648e07d4fc2f70d2f57fd03a
-  data.tar.gz: eb288754985044ef4d2c3094ce6eb78172eb107394e66a191d6a3740afe167b9b5621a4a4e3ee618d51d62aa1f1f7ce3d1daa873243996cbd4037e62e4ba390f
+  metadata.gz: 17339d55c4ed50599d3cc2cfa04f2f5a53e57a5478fb626bbf999ac6297da3a35a47e9a139150b4cfcce209c6e29f1b033180c9f5cc64923f106f5c1379adff8
+  data.tar.gz: 57fb7a408683111fd2f0aee2b389c97f5de038b22b2b6bbf0ff757c193220740a766951a7cda8baa59c58fc83bc26ea7e1103a07944e9206555a22970d071b19

data/README.md CHANGED Viewed

@@ -84,6 +84,7 @@ Constructing `Shipeasy::Client.new(user)` before `Shipeasy.configure` raises
 | [Testing](https://github.com/shipeasy-ai/sdk-ruby/blob/main/docs/pages/testing.md) | `configure_for_testing` / `configure_for_offline`, overrides. |
 | [OpenFeature](https://github.com/shipeasy-ai/sdk-ruby/blob/main/docs/pages/openfeature.md) | `Shipeasy::OpenFeature::Provider` (OpenFeature server provider). |
 | [Advanced](https://github.com/shipeasy-ai/sdk-ruby/blob/main/docs/pages/advanced.md) | Anon-id middleware, private attributes, sticky bucketing, SSR. |
+| [Admin API client](https://github.com/shipeasy-ai/sdk-ruby/blob/main/docs/pages/admin-api.md) | Optional `Shipeasy::Admin::Client` for administering resources (generated from the Open… |
 Copy-paste snippets live under [`docs/snippets/`](https://github.com/shipeasy-ai/sdk-ruby/blob/main/docs/snippets)
 (release · metrics · i18n · ops); an installable agent skill is at

data/docs/skill/SKILL.md CHANGED Viewed

@@ -37,8 +37,12 @@ Omit `c.attributes` if your user object is already the attribute hash. For a
 long-running server set `c.poll = true` to keep the blob fresh in the background;
 the default (one-shot fetch, no thread) is serverless-friendly.
-→ More: `pages/installation.md` (per-framework setup), `pages/configuration.md`
-(every option).
+**Rails:** don't write the initializer by hand — run the generator:
+`bin/rails generate shipeasy:install` (add `--i18n` to also inject
+`<%= i18n_head_tags %>` into the app layout, `--no-poll` for serverless).
+→ More: `pages/installation.md` (per-framework setup + generator),
+`pages/configuration.md` (every option).
 ## Evaluate (bound `Client.new(user)` — NO user arg)

data/lib/generators/shipeasy/install/USAGE ADDED Viewed

@@ -0,0 +1,24 @@
+Description:
+    Install Shipeasy into a Rails app. Creates the config/initializers/shipeasy.rb
+    initializer that calls `Shipeasy.configure` once at boot. With --i18n it also
+    sets the public client key and injects `<%= i18n_head_tags %>` into your
+    application layout's <head>.
+    The gem's Railties already auto-mount the anon-id Rack middleware and the i18n
+    view helpers, so this generator only creates what your app must own — the
+    initializer, the (optional) layout tag, and a reminder to set your keys.
+Example:
+    rails generate shipeasy:install
+        Creates:
+            config/initializers/shipeasy.rb   (server key + background poll)
+    rails generate shipeasy:install --i18n
+        Also sets the public client key in the initializer and injects
+        <%= i18n_head_tags %> into app/views/layouts/application.html.erb
+    rails generate shipeasy:install --no-poll
+        One-shot fetch instead of the background poll (serverless / Lambda).

data/lib/generators/shipeasy/install/install_generator.rb ADDED Viewed

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+require "rails/generators/base"
+module Shipeasy
+  module Generators
+    # `rails generate shipeasy:install`
+    #
+    # Scaffolds Shipeasy into a Rails app the Rails way:
+    #
+    #   - writes config/initializers/shipeasy.rb (the single Shipeasy.configure call)
+    #   - with --i18n, sets the public client key in that initializer AND injects
+    #     `<%= i18n_head_tags %>` into the application layout's <head>
+    #   - prints the keys / credentials next steps
+    #
+    # The gem's Railties already auto-mount the anon-id Rack middleware and the
+    # i18n view helpers, so this generator never touches middleware wiring — it
+    # only creates the things an app must own: the initializer, the layout tag,
+    # and your keys.
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Create config/initializers/shipeasy.rb (and, with --i18n, wire the i18n view helpers)."
+      class_option :i18n, type: :boolean, default: false,
+        desc: "Also enable i18n: set the public client key and inject i18n_head_tags into the app layout"
+      class_option :poll, type: :boolean, default: true,
+        desc: "Use the background poll (long-running server). Pass --no-poll for a serverless one-shot fetch"
+      APP_LAYOUT = "app/views/layouts/application.html.erb"
+      def create_initializer
+        template "initializer.rb.tt", "config/initializers/shipeasy.rb"
+      end
+      def inject_layout_helpers
+        return unless options[:i18n]
+        unless layout_exists?
+          say_status :skip, "#{APP_LAYOUT} not found — add <%= i18n_head_tags %> to your <head> by hand", :yellow
+          return
+        end
+        if layout_already_wired?
+          say_status :identical, "#{APP_LAYOUT} already has i18n_head_tags", :blue
+          return
+        end
+        # Insert just before the closing </head>, picking up its indentation.
+        inject_into_file APP_LAYOUT, "<%= i18n_head_tags %>\n  ", before: "</head>"
+      end
+      def print_next_steps
+        say ""
+        say "  Shipeasy installed → config/initializers/shipeasy.rb", :green
+        say ""
+        say "  Next steps:"
+        say "    1. Mint your keys: https://app.shipeasy.ai → Settings → SDK keys"
+        say "    2. Provide them (pick one):"
+        say "         • ENV — set SHIPEASY_SERVER_KEY#{options[:i18n] ? " and SHIPEASY_CLIENT_KEY" : ""}"
+        say "         • Rails credentials — bin/rails credentials:edit, then read"
+        say "           them from Rails.application.credentials in the initializer"
+        if options[:i18n]
+          say "    3. i18n_head_tags is wired into your layout — run the Shipeasy"
+          say "       i18n install to create your en:prod profile, then translate."
+        end
+        say ""
+        say "  Read a flag anywhere per request:"
+        say "    Shipeasy::Client.new(current_user).get_flag(\"new_checkout\")"
+        say ""
+        say "  Docs: https://docs.shipeasy.ai", :cyan
+        say ""
+      end
+      private
+      def layout_exists?
+        File.exist?(File.join(destination_root, APP_LAYOUT))
+      end
+      def layout_already_wired?
+        File.read(File.join(destination_root, APP_LAYOUT)).include?("i18n_head_tags")
+      end
+    end
+  end
+end

data/lib/generators/shipeasy/install/templates/initializer.rb.tt ADDED Viewed

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+# Shipeasy — feature flags, dynamic configs, kill switches, A/B experiments,
+# metrics and (optional) i18n. Generated by `rails generate shipeasy:install`.
+#
+# Configure the SDK ONCE here at boot, then construct a cheap, user-bound
+# `Shipeasy::Client.new(current_user)` per request — every read takes no user
+# argument because the user is bound at construction:
+#
+#   flags = Shipeasy::Client.new(current_user)
+#   flags.get_flag("new_checkout")        # NO user arg — bound at construction
+#
+# Docs: https://docs.shipeasy.ai
+Shipeasy.configure do |c|
+  # Required — your Shipeasy SERVER key. A server-side secret; never embed it in
+  # the browser. Read it from the environment, or from Rails credentials:
+  #   c.api_key = Rails.application.credentials.dig(:shipeasy, :server_key)
+  c.api_key = ENV.fetch("SHIPEASY_SERVER_KEY", nil)
+<% if options[:poll] -%>
+  # Long-running server (Puma): keep flags fresh with the background poll
+  # (initial fetch + periodic refresh). Set to false for serverless /
+  # short-lived processes — they get a one-shot fetch and no background thread.
+  c.poll = true
+<% else -%>
+  # Serverless / short-lived process: one-shot fetch, no background thread.
+  c.poll = false
+<% end -%>
+  # Optional — map YOUR user object to the Shipeasy attribute hash that
+  # targeting evaluates against. Runs once, in the Shipeasy::Client constructor.
+  # Delete this line to pass the object through unchanged (identity default).
+  c.attributes = ->(user) { { "user_id" => user.id } }
+<% if options[:i18n] -%>
+  # i18n view helpers (i18n_head_tags / i18n_t) — the PUBLIC client key. Safe to
+  # expose to the browser via the loader tag these helpers emit.
+  c.public_key = ENV.fetch("SHIPEASY_CLIENT_KEY", nil)
+  c.profile    = "en:prod"
+<% end -%>
+end

data/lib/shipeasy/admin.rb ADDED Viewed

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+# Optional Admin API client for the Shipeasy Ruby SDK.
+#
+# This subpackage is OFF by default: the main `shipeasy-sdk` entrypoint never
+# requires it, and its HTTP dependency (`faraday`) is an optional development
+# dependency — so `require "shipeasy-sdk"` never pulls it in. Require it
+# explicitly when you want to *administer* resources (create gates, start
+# experiments, …) from server code:
+#
+#   require "faraday"
+#   require "shipeasy/admin"
+#
+#   admin = Shipeasy::Admin::Client.new(
+#     api_key: ENV.fetch("SHIPEASY_ADMIN_KEY"),
+#     project_id: ENV.fetch("SHIPEASY_PROJECT_ID"),
+#   )
+#   admin.gates.list_gates
+#
+# Everything under `Shipeasy::Admin::Generated` (lib/shipeasy_admin*) is produced
+# by scripts/gen_admin.sh from the OpenAPI spec and must not be edited by hand.
+# `Client` is a thin auth/scoping wrapper; it does NOT add name->id resolution or
+# percent->basis-point conversion (that facade lives in the Shipeasy CLI/MCP). The
+# surface here is the raw, 1:1-with-the-spec REST API.
+# Define the namespace BEFORE loading the generated client: its files use the
+# compact `module Shipeasy::Admin::Generated` form, which requires Shipeasy::Admin
+# to already exist (and `require "shipeasy/admin"` may run without the main SDK).
+module Shipeasy
+  module Admin
+  end
+end
+require "shipeasy_admin" # the generated client (loads faraday transitively)
+module Shipeasy
+  module Admin
+    # Programmatic client for the Shipeasy Admin REST API. Each resource group is
+    # a lazily-constructed, memoized reader whose methods map 1:1 to the OpenAPI
+    # operations: #gates, #configs, #killswitches, #experiments, #universes,
+    # #metrics, #events, #alert_rules, #attributes, #projects, #ops, #i18n.
+    class Client
+      # Friendly reader name => generated Api class.
+      APIS = {
+        gates: Generated::GatesApi,
+        configs: Generated::ConfigsApi,
+        killswitches: Generated::KillswitchesApi,
+        experiments: Generated::ExperimentsApi,
+        universes: Generated::UniversesApi,
+        metrics: Generated::MetricsApi,
+        events: Generated::EventsApi,
+        alert_rules: Generated::AlertRulesApi,
+        attributes: Generated::AttributesApi,
+        projects: Generated::ProjectsApi,
+        ops: Generated::OpsApi,
+        i18n: Generated::I18nApi,
+      }.freeze
+      # @param api_key [String] admin SDK key, sent as `Authorization: Bearer <api_key>`.
+      # @param project_id [String, nil] optional project id sent as the `X-Project-Id`
+      #   header on every request. Operations also accept an explicit `x_project_id:`
+      #   argument to override per call.
+      # @param base_url [String] API base URL. Defaults to https://shipeasy.ai
+      #   (the spec's production server); use http://localhost:3000 for local dev.
+      def initialize(api_key:, project_id: nil, base_url: "https://shipeasy.ai")
+        config = Generated::Configuration.new
+        config.access_token = api_key
+        scheme, _, host = base_url.rpartition("://")
+        config.scheme = scheme unless scheme.empty?
+        config.host = host.empty? ? base_url : host
+        @api_client = Generated::ApiClient.new(config)
+        @api_client.default_headers["X-Project-Id"] = project_id if project_id
+        @apis = {}
+      end
+      # The underlying generated ApiClient (advanced/escape hatch).
+      attr_reader :api_client
+      APIS.each_key do |name|
+        define_method(name) { @apis[name] ||= APIS.fetch(name).new(@api_client) }
+      end
+    end
+  end
+end

data/lib/shipeasy/sdk/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Shipeasy
   module SDK
-    VERSION = "2.1.0"
+    VERSION = "2.3.0"
   end
 end

data/lib/shipeasy_admin/api/alert_rules_api.rb ADDED Viewed

@@ -0,0 +1,292 @@
+=begin
+#Shipeasy Admin API
+#REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
+The version of the OpenAPI document: 1.0.0
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+=end
+require 'cgi'
+module Shipeasy::Admin::Generated
+  class AlertRulesApi
+    attr_accessor :api_client
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an alert rule
+    # Creates a metric-threshold alert rule. `name`, `metricId`, `comparator`, and `threshold` are required; `windowHours` defaults to `24`, `severity` to `warn`, and `enabled` to `true`.  Returns `404` if `metricId` does not resolve, and `400` for a metric with no scalar form over a window (e.g. retention metrics) — the cron can't evaluate those.  **Use cases**  - **Threshold alert** — warn when an error/latency metric crosses a value over a rolling window. - **Routed alert** — set `notify` to page a specific Slack channel or on-call email instead of the project default.
+    # @param create_alert_rule_request [CreateAlertRuleRequest]
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [CreateAlertRuleResponse]
+    def create_alert_rule(create_alert_rule_request, opts = {})
+      data, _status_code, _headers = create_alert_rule_with_http_info(create_alert_rule_request, opts)
+      data
+    end
+    # Create an alert rule
+    # Creates a metric-threshold alert rule. &#x60;name&#x60;, &#x60;metricId&#x60;, &#x60;comparator&#x60;, and &#x60;threshold&#x60; are required; &#x60;windowHours&#x60; defaults to &#x60;24&#x60;, &#x60;severity&#x60; to &#x60;warn&#x60;, and &#x60;enabled&#x60; to &#x60;true&#x60;.  Returns &#x60;404&#x60; if &#x60;metricId&#x60; does not resolve, and &#x60;400&#x60; for a metric with no scalar form over a window (e.g. retention metrics) — the cron can&#39;t evaluate those.  **Use cases**  - **Threshold alert** — warn when an error/latency metric crosses a value over a rolling window. - **Routed alert** — set &#x60;notify&#x60; to page a specific Slack channel or on-call email instead of the project default.
+    # @param create_alert_rule_request [CreateAlertRuleRequest]
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [Array<(CreateAlertRuleResponse, Integer, Hash)>] CreateAlertRuleResponse data, response status code and response headers
+    def create_alert_rule_with_http_info(create_alert_rule_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertRulesApi.create_alert_rule ...'
+      end
+      # verify the required parameter 'create_alert_rule_request' is set
+      if @api_client.config.client_side_validation && create_alert_rule_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_alert_rule_request' when calling AlertRulesApi.create_alert_rule"
+      end
+      # resource path
+      local_var_path = '/api/admin/alert-rules'
+      # query parameters
+      query_params = opts[:query_params] || {}
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
+      # form parameters
+      form_params = opts[:form_params] || {}
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_alert_rule_request)
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateAlertRuleResponse'
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
+      new_options = opts.merge(
+        :operation => :"AlertRulesApi.create_alert_rule",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AlertRulesApi#create_alert_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Delete an alert rule
+    # Deletes the alert rule. The cron stops evaluating it immediately. Use this (then create a new rule) to repoint alerting at a different metric, since `metricId` is immutable.  **Use case:** Remove an alert rule that is no longer needed, or as the first half of repointing a rule at a different metric.
+    # @param id [String] Stable opaque alert-rule id (&#x60;ar_…&#x60;) or the rule&#39;s &#x60;name&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [DeleteAlertRuleResponse]
+    def delete_alert_rule(id, opts = {})
+      data, _status_code, _headers = delete_alert_rule_with_http_info(id, opts)
+      data
+    end
+    # Delete an alert rule
+    # Deletes the alert rule. The cron stops evaluating it immediately. Use this (then create a new rule) to repoint alerting at a different metric, since &#x60;metricId&#x60; is immutable.  **Use case:** Remove an alert rule that is no longer needed, or as the first half of repointing a rule at a different metric.
+    # @param id [String] Stable opaque alert-rule id (&#x60;ar_…&#x60;) or the rule&#39;s &#x60;name&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [Array<(DeleteAlertRuleResponse, Integer, Hash)>] DeleteAlertRuleResponse data, response status code and response headers
+    def delete_alert_rule_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertRulesApi.delete_alert_rule ...'
+      end
+      # resource path
+      local_var_path = '/api/admin/alert-rules/{id}'.sub('{id}', CGI.escape(id.to_s))
+      # query parameters
+      query_params = opts[:query_params] || {}
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
+      # form parameters
+      form_params = opts[:form_params] || {}
+      # http body (model)
+      post_body = opts[:debug_body]
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeleteAlertRuleResponse'
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
+      new_options = opts.merge(
+        :operation => :"AlertRulesApi.delete_alert_rule",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AlertRulesApi#delete_alert_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # List alert rules
+    # Returns every alert rule in the project (not paginated). Each rule carries its bound `metricId`, the denormalised `metricName` (or `null` if the metric was removed), the comparator/threshold/window, severity, enabled flag, and delivery target.  **Use case:** Audit which metrics have alerting configured — for example to confirm an on-call threshold is set before a launch.
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [Array<ListAlertRulesResponseInner>]
+    def list_alert_rules(opts = {})
+      data, _status_code, _headers = list_alert_rules_with_http_info(opts)
+      data
+    end
+    # List alert rules
+    # Returns every alert rule in the project (not paginated). Each rule carries its bound &#x60;metricId&#x60;, the denormalised &#x60;metricName&#x60; (or &#x60;null&#x60; if the metric was removed), the comparator/threshold/window, severity, enabled flag, and delivery target.  **Use case:** Audit which metrics have alerting configured — for example to confirm an on-call threshold is set before a launch.
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [Array<(Array<ListAlertRulesResponseInner>, Integer, Hash)>] Array<ListAlertRulesResponseInner> data, response status code and response headers
+    def list_alert_rules_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertRulesApi.list_alert_rules ...'
+      end
+      # resource path
+      local_var_path = '/api/admin/alert-rules'
+      # query parameters
+      query_params = opts[:query_params] || {}
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
+      # form parameters
+      form_params = opts[:form_params] || {}
+      # http body (model)
+      post_body = opts[:debug_body]
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ListAlertRulesResponseInner>'
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
+      new_options = opts.merge(
+        :operation => :"AlertRulesApi.list_alert_rules",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AlertRulesApi#list_alert_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update an alert rule
+    # Partial update of a rule's tunable knobs. `metricId` is immutable — it is rejected by the schema (the metric also pins the aggregation), so delete + recreate to repoint a rule.  Pass `\"notify\": null` to revert the rule's delivery target back to the project default.  **Use cases**  - **Tune sensitivity** — change `threshold`/`comparator`/`windowHours` as the metric's baseline shifts. - **Pause without losing config** — `{ \"enabled\": false }` instead of deleting the rule.
+    # @param id [String] Stable opaque alert-rule id (&#x60;ar_…&#x60;) or the rule&#39;s &#x60;name&#x60;.
+    # @param update_alert_rule_request [UpdateAlertRuleRequest]
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [UpdateAlertRuleResponse]
+    def update_alert_rule(id, update_alert_rule_request, opts = {})
+      data, _status_code, _headers = update_alert_rule_with_http_info(id, update_alert_rule_request, opts)
+      data
+    end
+    # Update an alert rule
+    # Partial update of a rule&#39;s tunable knobs. &#x60;metricId&#x60; is immutable — it is rejected by the schema (the metric also pins the aggregation), so delete + recreate to repoint a rule.  Pass &#x60;\&quot;notify\&quot;: null&#x60; to revert the rule&#39;s delivery target back to the project default.  **Use cases**  - **Tune sensitivity** — change &#x60;threshold&#x60;/&#x60;comparator&#x60;/&#x60;windowHours&#x60; as the metric&#39;s baseline shifts. - **Pause without losing config** — &#x60;{ \&quot;enabled\&quot;: false }&#x60; instead of deleting the rule.
+    # @param id [String] Stable opaque alert-rule id (&#x60;ar_…&#x60;) or the rule&#39;s &#x60;name&#x60;.
+    # @param update_alert_rule_request [UpdateAlertRuleRequest]
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [Array<(UpdateAlertRuleResponse, Integer, Hash)>] UpdateAlertRuleResponse data, response status code and response headers
+    def update_alert_rule_with_http_info(id, update_alert_rule_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AlertRulesApi.update_alert_rule ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AlertRulesApi.update_alert_rule"
+      end
+      # verify the required parameter 'update_alert_rule_request' is set
+      if @api_client.config.client_side_validation && update_alert_rule_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_alert_rule_request' when calling AlertRulesApi.update_alert_rule"
+      end
+      # resource path
+      local_var_path = '/api/admin/alert-rules/{id}'.sub('{id}', CGI.escape(id.to_s))
+      # query parameters
+      query_params = opts[:query_params] || {}
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
+      # form parameters
+      form_params = opts[:form_params] || {}
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_alert_rule_request)
+      # return_type
+      return_type = opts[:debug_return_type] || 'UpdateAlertRuleResponse'
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
+      new_options = opts.merge(
+        :operation => :"AlertRulesApi.update_alert_rule",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AlertRulesApi#update_alert_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/shipeasy_admin/api/attributes_api.rb ADDED Viewed

@@ -0,0 +1,82 @@
+=begin
+#Shipeasy Admin API
+#REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
+The version of the OpenAPI document: 1.0.0
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+=end
+require 'cgi'
+module Shipeasy::Admin::Generated
+  class AttributesApi
+    attr_accessor :api_client
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List targeting attributes
+    # Returns every auto-inferred targeting attribute in the project — the `name` and (when known) the value `type` — for building gate/experiment targeting rules.  **Use case:** Discover which user-context keys are available before authoring a targeting rule, instead of guessing attribute names.
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [Array<ListAttributesResponseInner>]
+    def list_attributes(opts = {})
+      data, _status_code, _headers = list_attributes_with_http_info(opts)
+      data
+    end
+    # List targeting attributes
+    # Returns every auto-inferred targeting attribute in the project — the &#x60;name&#x60; and (when known) the value &#x60;type&#x60; — for building gate/experiment targeting rules.  **Use case:** Discover which user-context keys are available before authoring a targeting rule, instead of guessing attribute names.
+    # @param [Hash] opts the optional parameters
+    # @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).
+    # @return [Array<(Array<ListAttributesResponseInner>, Integer, Hash)>] Array<ListAttributesResponseInner> data, response status code and response headers
+    def list_attributes_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttributesApi.list_attributes ...'
+      end
+      # resource path
+      local_var_path = '/api/admin/attributes'
+      # query parameters
+      query_params = opts[:query_params] || {}
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
+      # form parameters
+      form_params = opts[:form_params] || {}
+      # http body (model)
+      post_body = opts[:debug_body]
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<ListAttributesResponseInner>'
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
+      new_options = opts.merge(
+        :operation => :"AttributesApi.list_attributes",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttributesApi#list_attributes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end