shipeasy-sdk 3.8.0 → 4.1.0

data/lib/shipeasy_admin/models/{set_killswitch_value_request.rb → add_to_gate_whitelist_request.rb}

@@ -1,7 +1,7 @@
 =begin
-#Shipeasy Admin API
+#Shipeasy Admin API (server-SDK surface)
 
-#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 slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Three capabilities, nothing else:  - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule.  Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
 
 The version of the OpenAPI document: 2.0.0
 
@@ -14,12 +14,13 @@ require 'date'
 require 'time'
 
 module Shipeasy::Admin::Generated
-  # Body for `PUT /api/admin/killswitches/{id}/value`. Sets the flat `value` on one env without touching `switches` or other envs.
-  class SetKillswitchValueRequest < ApiModelBase
-    attr_accessor :env
+  # Body for `POST /api/admin/gates/{id}/whitelist`. Adds entries to the whitelist, creating it if the gate doesn't have one.
+  class AddToGateWhitelistRequest < ApiModelBase
+    # Identity attribute to match on. Only honoured when the gate has no whitelist yet (this call creates it); passing an attribute that disagrees with an existing whitelist is a 409 rather than a silent re-key of the entries already there.
+    attr_accessor :attr
 
-    # Flat boolean to publish on `env`. Publishes a new version on that env only.
-    attr_accessor :value
+    # Identities to admit. Already-listed entries are skipped, so the call is idempotent.
+    attr_accessor :entries
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -46,8 +47,8 @@ module Shipeasy::Admin::Generated
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'env' => :'env',
-        :'value' => :'value'
+        :'attr' => :'attr',
+        :'entries' => :'entries'
       }
     end
 
@@ -64,8 +65,8 @@ module Shipeasy::Admin::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'env' => :'Env',
-        :'value' => :'Boolean'
+        :'attr' => :'GateWhitelistAttr',
+        :'entries' => :'Array<String>'
       }
     end
 
@@ -79,28 +80,28 @@ module Shipeasy::Admin::Generated
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::SetKillswitchValueRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::AddToGateWhitelistRequest` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       acceptable_attribute_map = self.class.acceptable_attribute_map
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::SetKillswitchValueRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::AddToGateWhitelistRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'env')
-        self.env = attributes[:'env']
-      else
-        self.env = nil
+      if attributes.key?(:'attr')
+        self.attr = attributes[:'attr']
       end
 
-      if attributes.key?(:'value')
-        self.value = attributes[:'value']
+      if attributes.key?(:'entries')
+        if (value = attributes[:'entries']).is_a?(Array)
+          self.entries = value
+        end
       else
-        self.value = nil
+        self.entries = nil
       end
     end
 
@@ -109,12 +110,12 @@ module Shipeasy::Admin::Generated
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @env.nil?
-        invalid_properties.push('invalid value for "env", env cannot be nil.')
+      if @entries.nil?
+        invalid_properties.push('invalid value for "entries", entries cannot be nil.')
       end
 
-      if @value.nil?
-        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      if @entries.length < 1
+        invalid_properties.push('invalid value for "entries", number of items must be greater than or equal to 1.')
       end
 
       invalid_properties
@@ -124,29 +125,23 @@ module Shipeasy::Admin::Generated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @env.nil?
-      return false if @value.nil?
+      return false if @entries.nil?
+      return false if @entries.length < 1
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] env Value to be assigned
-    def env=(env)
-      if env.nil?
-        fail ArgumentError, 'env cannot be nil'
+    # @param [Object] entries Value to be assigned
+    def entries=(entries)
+      if entries.nil?
+        fail ArgumentError, 'entries cannot be nil'
       end
 
-      @env = env
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] value Value to be assigned
-    def value=(value)
-      if value.nil?
-        fail ArgumentError, 'value cannot be nil'
+      if entries.length < 1
+        fail ArgumentError, 'invalid value for "entries", number of items must be greater than or equal to 1.'
       end
 
-      @value = value
+      @entries = entries
     end
 
     # Checks equality by comparing each attribute.
@@ -154,8 +149,8 @@ module Shipeasy::Admin::Generated
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          env == o.env &&
-          value == o.value
+          attr == o.attr &&
+          entries == o.entries
     end
 
     # @see the `==` method
@@ -167,7 +162,7 @@ module Shipeasy::Admin::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [env, value].hash
+      [attr, entries].hash
     end
 
     # Builds the object from hash

data/lib/shipeasy_admin/models/create_public_bug_request.rb

@@ -0,0 +1,493 @@
+=begin
+#Shipeasy Admin API (server-SDK surface)
+
+#The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Three capabilities, nothing else:  - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule.  Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  # Body for `POST /ops/bug`. The same bug fields as `CreateBugRequest`, minus the `type` discriminator — the path already says what is being filed, plus the public intake's own `dedupKey`.
+  class CreatePublicBugRequest < ApiModelBase
+    # One-line bug title (no leading/trailing whitespace).
+    attr_accessor :title
+
+    # How to reproduce the bug.
+    attr_accessor :steps_to_reproduce
+
+    # What actually happened.
+    attr_accessor :actual_result
+
+    # What was expected instead.
+    attr_accessor :expected_result
+
+    # Initial triage priority, or `null`.
+    attr_accessor :priority
+
+    # Initial lifecycle status; defaults to `open` when omitted.
+    attr_accessor :status
+
+    # The `users.id` of the person to assign as owner at creation, or `null`.
+    attr_accessor :assignee_id
+
+    # Emails of teammates to subscribe to this item's Slack pings at creation.
+    attr_accessor :subscribers
+
+    # Tag names to attach at creation (get-or-created by name, deduped case-insensitively).
+    attr_accessor :tags
+
+    # Email of the reporter, or `null`.
+    attr_accessor :reporter_email
+
+    # URL of the page the bug relates to, or `null`.
+    attr_accessor :page_url
+
+    # Reporter's user-agent string, or `null`.
+    attr_accessor :user_agent
+
+    # Reporter's viewport (e.g. `1280x720`), or `null`.
+    attr_accessor :viewport
+
+    # Arbitrary capture context, or `null`.
+    attr_accessor :context
+
+    # Caller-chosen dedupe identity for this report, stored on the ticket. A repeat submission carrying the same key does NOT file a second ticket: the open ticket already holding that key is refreshed from this payload (title and the report fields overwritten, a \"re-triggered\" comment appended) and returned with `deduped: true` and `updated: true`. Triage state a human owns — status, priority, assignee, tags — is left untouched, and a `resolved`/`wont_fix` ticket no longer holds the key, so a failure that comes back after being closed files a fresh ticket. Omit it to fall back to the derived (title + `context.step`) dedupe, whose repeats return the existing ticket unchanged.
+    attr_accessor :dedup_key
+
+    # Where this bug's completion notification lands.
+    attr_accessor :notify
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'title' => :'title',
+        :'steps_to_reproduce' => :'stepsToReproduce',
+        :'actual_result' => :'actualResult',
+        :'expected_result' => :'expectedResult',
+        :'priority' => :'priority',
+        :'status' => :'status',
+        :'assignee_id' => :'assigneeId',
+        :'subscribers' => :'subscribers',
+        :'tags' => :'tags',
+        :'reporter_email' => :'reporterEmail',
+        :'page_url' => :'pageUrl',
+        :'user_agent' => :'userAgent',
+        :'viewport' => :'viewport',
+        :'context' => :'context',
+        :'dedup_key' => :'dedupKey',
+        :'notify' => :'notify'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'title' => :'String',
+        :'steps_to_reproduce' => :'String',
+        :'actual_result' => :'String',
+        :'expected_result' => :'String',
+        :'priority' => :'OpsItemPriority',
+        :'status' => :'OpsItemStatus',
+        :'assignee_id' => :'String',
+        :'subscribers' => :'Array<String>',
+        :'tags' => :'Array<String>',
+        :'reporter_email' => :'String',
+        :'page_url' => :'String',
+        :'user_agent' => :'String',
+        :'viewport' => :'String',
+        :'context' => :'Hash<String, Object>',
+        :'dedup_key' => :'String',
+        :'notify' => :'NotificationTarget'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'priority',
+        :'assignee_id',
+        :'reporter_email',
+        :'page_url',
+        :'user_agent',
+        :'viewport',
+        :'context',
+        :'notify'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::CreatePublicBugRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::CreatePublicBugRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'steps_to_reproduce')
+        self.steps_to_reproduce = attributes[:'steps_to_reproduce']
+      else
+        self.steps_to_reproduce = ''
+      end
+
+      if attributes.key?(:'actual_result')
+        self.actual_result = attributes[:'actual_result']
+      else
+        self.actual_result = ''
+      end
+
+      if attributes.key?(:'expected_result')
+        self.expected_result = attributes[:'expected_result']
+      else
+        self.expected_result = ''
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'assignee_id')
+        self.assignee_id = attributes[:'assignee_id']
+      end
+
+      if attributes.key?(:'subscribers')
+        if (value = attributes[:'subscribers']).is_a?(Array)
+          self.subscribers = value
+        end
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'reporter_email')
+        self.reporter_email = attributes[:'reporter_email']
+      end
+
+      if attributes.key?(:'page_url')
+        self.page_url = attributes[:'page_url']
+      end
+
+      if attributes.key?(:'user_agent')
+        self.user_agent = attributes[:'user_agent']
+      end
+
+      if attributes.key?(:'viewport')
+        self.viewport = attributes[:'viewport']
+      end
+
+      if attributes.key?(:'context')
+        if (value = attributes[:'context']).is_a?(Hash)
+          self.context = value
+        end
+      end
+
+      if attributes.key?(:'dedup_key')
+        self.dedup_key = attributes[:'dedup_key']
+      end
+
+      if attributes.key?(:'notify')
+        self.notify = attributes[:'notify']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @title.to_s.length > 200
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 200.')
+      end
+
+      if @title.to_s.length < 1
+        invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^\S(.*\S)?$/)
+      if @title !~ pattern
+        invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@steps_to_reproduce.nil? && @steps_to_reproduce.to_s.length > 8000
+        invalid_properties.push('invalid value for "steps_to_reproduce", the character length must be smaller than or equal to 8000.')
+      end
+
+      if !@actual_result.nil? && @actual_result.to_s.length > 8000
+        invalid_properties.push('invalid value for "actual_result", the character length must be smaller than or equal to 8000.')
+      end
+
+      if !@expected_result.nil? && @expected_result.to_s.length > 8000
+        invalid_properties.push('invalid value for "expected_result", the character length must be smaller than or equal to 8000.')
+      end
+
+      if !@user_agent.nil? && @user_agent.to_s.length > 500
+        invalid_properties.push('invalid value for "user_agent", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@viewport.nil? && @viewport.to_s.length > 40
+        invalid_properties.push('invalid value for "viewport", the character length must be smaller than or equal to 40.')
+      end
+
+      if !@dedup_key.nil? && @dedup_key.to_s.length > 200
+        invalid_properties.push('invalid value for "dedup_key", the character length must be smaller than or equal to 200.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @title.nil?
+      return false if @title.to_s.length > 200
+      return false if @title.to_s.length < 1
+      return false if @title !~ Regexp.new(/^\S(.*\S)?$/)
+      return false if !@steps_to_reproduce.nil? && @steps_to_reproduce.to_s.length > 8000
+      return false if !@actual_result.nil? && @actual_result.to_s.length > 8000
+      return false if !@expected_result.nil? && @expected_result.to_s.length > 8000
+      return false if !@user_agent.nil? && @user_agent.to_s.length > 500
+      return false if !@viewport.nil? && @viewport.to_s.length > 40
+      return false if !@dedup_key.nil? && @dedup_key.to_s.length > 200
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 200
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 200.'
+      end
+
+      if title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^\S(.*\S)?$/)
+      if title !~ pattern
+        fail ArgumentError, "invalid value for \"title\", must conform to the pattern #{pattern}."
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] steps_to_reproduce Value to be assigned
+    def steps_to_reproduce=(steps_to_reproduce)
+      if steps_to_reproduce.nil?
+        fail ArgumentError, 'steps_to_reproduce cannot be nil'
+      end
+
+      if steps_to_reproduce.to_s.length > 8000
+        fail ArgumentError, 'invalid value for "steps_to_reproduce", the character length must be smaller than or equal to 8000.'
+      end
+
+      @steps_to_reproduce = steps_to_reproduce
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] actual_result Value to be assigned
+    def actual_result=(actual_result)
+      if actual_result.nil?
+        fail ArgumentError, 'actual_result cannot be nil'
+      end
+
+      if actual_result.to_s.length > 8000
+        fail ArgumentError, 'invalid value for "actual_result", the character length must be smaller than or equal to 8000.'
+      end
+
+      @actual_result = actual_result
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expected_result Value to be assigned
+    def expected_result=(expected_result)
+      if expected_result.nil?
+        fail ArgumentError, 'expected_result cannot be nil'
+      end
+
+      if expected_result.to_s.length > 8000
+        fail ArgumentError, 'invalid value for "expected_result", the character length must be smaller than or equal to 8000.'
+      end
+
+      @expected_result = expected_result
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_agent Value to be assigned
+    def user_agent=(user_agent)
+      if !user_agent.nil? && user_agent.to_s.length > 500
+        fail ArgumentError, 'invalid value for "user_agent", the character length must be smaller than or equal to 500.'
+      end
+
+      @user_agent = user_agent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] viewport Value to be assigned
+    def viewport=(viewport)
+      if !viewport.nil? && viewport.to_s.length > 40
+        fail ArgumentError, 'invalid value for "viewport", the character length must be smaller than or equal to 40.'
+      end
+
+      @viewport = viewport
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dedup_key Value to be assigned
+    def dedup_key=(dedup_key)
+      if dedup_key.nil?
+        fail ArgumentError, 'dedup_key cannot be nil'
+      end
+
+      if dedup_key.to_s.length > 200
+        fail ArgumentError, 'invalid value for "dedup_key", the character length must be smaller than or equal to 200.'
+      end
+
+      @dedup_key = dedup_key
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          title == o.title &&
+          steps_to_reproduce == o.steps_to_reproduce &&
+          actual_result == o.actual_result &&
+          expected_result == o.expected_result &&
+          priority == o.priority &&
+          status == o.status &&
+          assignee_id == o.assignee_id &&
+          subscribers == o.subscribers &&
+          tags == o.tags &&
+          reporter_email == o.reporter_email &&
+          page_url == o.page_url &&
+          user_agent == o.user_agent &&
+          viewport == o.viewport &&
+          context == o.context &&
+          dedup_key == o.dedup_key &&
+          notify == o.notify
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [title, steps_to_reproduce, actual_result, expected_result, priority, status, assignee_id, subscribers, tags, reporter_email, page_url, user_agent, viewport, context, dedup_key, notify].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end