shipeasy-sdk 2.3.0 → 2.3.1

data/lib/shipeasy_admin/models/test_connector_response.rb

@@ -0,0 +1,189 @@
+=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: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  # Result of testing a connector. `{ ok: true, issueUrl }` on success; `{ ok: false, issueUrl: null, error }` when the dispatch fails (the request still returns HTTP 200).
+  class TestConnectorResponse < ApiModelBase
+    # `true` when the test dispatch reached the destination; `false` when the dispatch itself failed (still HTTP 200, with `error` set).
+    attr_accessor :ok
+
+    # URL of the artifact the test produced (e.g. the GitHub Issue created by a `github` connector), or `null` when the provider produces no linkable artifact (or the dispatch failed).
+    attr_accessor :issue_url
+
+    # Failure reason. Present only when `ok` is `false` — the test reached the handler but the underlying dispatch to the provider failed.
+    attr_accessor :error
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ok' => :'ok',
+        :'issue_url' => :'issueUrl',
+        :'error' => :'error'
+      }
+    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
+      {
+        :'ok' => :'Boolean',
+        :'issue_url' => :'String',
+        :'error' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'issue_url',
+      ])
+    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::TestConnectorResponse` 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::TestConnectorResponse`. 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?(:'ok')
+        self.ok = attributes[:'ok']
+      else
+        self.ok = nil
+      end
+
+      if attributes.key?(:'issue_url')
+        self.issue_url = attributes[:'issue_url']
+      else
+        self.issue_url = nil
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      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 @ok.nil?
+        invalid_properties.push('invalid value for "ok", ok cannot be nil.')
+      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 @ok.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ok Value to be assigned
+    def ok=(ok)
+      if ok.nil?
+        fail ArgumentError, 'ok cannot be nil'
+      end
+
+      @ok = ok
+    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 &&
+          ok == o.ok &&
+          issue_url == o.issue_url &&
+          error == o.error
+    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
+      [ok, issue_url, error].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

data/lib/shipeasy_admin/models/unset_killswitch_switch_request.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -16,7 +16,6 @@ require 'time'
 module Shipeasy::Admin::Generated
   # Body for `DELETE /api/admin/killswitches/{id}/switch`. Removes one switch entry from one env.
   class UnsetKillswitchSwitchRequest < ApiModelBase
-    # Target environment.
     attr_accessor :env
 
     # Switch key to remove.
@@ -65,7 +64,7 @@ module Shipeasy::Admin::Generated
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'env' => :'String',
+        :'env' => :'Env',
         :'switch_key' => :'String'
       }
     end
@@ -135,21 +134,19 @@ module Shipeasy::Admin::Generated
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @env.nil?
-      env_validator = EnumAttributeValidator.new('String', ["dev", "staging", "prod"])
-      return false unless env_validator.valid?(@env)
       return false if @switch_key.nil?
       return false if @switch_key.to_s.length > 64
       return false if @switch_key !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/)
       true
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] env Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] env Value to be assigned
     def env=(env)
-      validator = EnumAttributeValidator.new('String', ["dev", "staging", "prod"])
-      unless validator.valid?(env)
-        fail ArgumentError, "invalid value for \"env\", must be one of #{validator.allowable_values}."
+      if env.nil?
+        fail ArgumentError, 'env cannot be nil'
       end
+
       @env = env
     end
 

data/lib/shipeasy_admin/models/unset_killswitch_switch_response.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -17,7 +17,6 @@ module Shipeasy::Admin::Generated
   class UnsetKillswitchSwitchResponse < ApiModelBase
     attr_accessor :id
 
-    # Target environment. One of the project's configured envs (`dev`, `stage`, `prod`).
     attr_accessor :env
 
     # Single-segment switch key (lowercase letters, digits, `_`/`-`; no dots). Used as the nested switch entry inside a killswitch's `switches` map.
@@ -72,7 +71,7 @@ module Shipeasy::Admin::Generated
     def self.openapi_types
       {
         :'id' => :'String',
-        :'env' => :'String',
+        :'env' => :'Env',
         :'switch_key' => :'String',
         :'removed' => :'Boolean'
       }
@@ -164,8 +163,6 @@ module Shipeasy::Admin::Generated
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @id.nil?
       return false if @env.nil?
-      env_validator = EnumAttributeValidator.new('String', ["dev", "staging", "prod"])
-      return false unless env_validator.valid?(@env)
       return false if @switch_key.nil?
       return false if @switch_key.to_s.length > 64
       return false if @switch_key !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/)
@@ -183,13 +180,13 @@ module Shipeasy::Admin::Generated
       @id = id
     end
 
-    # Custom attribute writer method checking allowed values (enum).
-    # @param [Object] env Object to be assigned
+    # Custom attribute writer method with validation
+    # @param [Object] env Value to be assigned
     def env=(env)
-      validator = EnumAttributeValidator.new('String', ["dev", "staging", "prod"])
-      unless validator.valid?(env)
-        fail ArgumentError, "invalid value for \"env\", must be one of #{validator.allowable_values}."
+      if env.nil?
+        fail ArgumentError, 'env cannot be nil'
       end
+
       @env = env
     end
 

data/lib/shipeasy_admin/models/update_alert_rule_request.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -19,7 +19,6 @@ module Shipeasy::Admin::Generated
 
     attr_accessor :comparator
 
-    # Minimum detectable effect (relative, 0–1) for power planning. `null` to omit.
     attr_accessor :threshold
 
     attr_accessor :window_hours
@@ -84,14 +83,13 @@ module Shipeasy::Admin::Generated
         :'window_hours' => :'Integer',
         :'severity' => :'String',
         :'enabled' => :'Boolean',
-        :'notify' => :'ListAlertRulesResponseInnerNotify'
+        :'notify' => :'NotificationTarget'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'threshold',
         :'notify'
       ])
     end

data/lib/shipeasy_admin/models/update_alert_rule_response.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0

data/lib/shipeasy_admin/models/update_config_request.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -21,7 +21,7 @@ module Shipeasy::Admin::Generated
 
     attr_accessor :value
 
-    # Optional folder name used to group items in the dashboard. Part of the SDK lookup key: an item in folder `checkout` named `new-cart` is referenced as `checkout/new-cart` from the SDK.
+    # Optional folder name grouping items in the dashboard. Alphanumeric, `_` or `-` (no `/`). Part of the SDK lookup key (`<folder>/<name>`).
     attr_accessor :folder
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/shipeasy_admin/models/update_config_response.rb

@@ -3,7 +3,7 @@
 
 #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
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0

data/lib/shipeasy_admin/models/update_config_schema_request.rb

@@ -0,0 +1,168 @@
+=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: 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 `PATCH /api/admin/configs/{id}/schema`. Schema-only update — replaces the config's schema and re-validates existing values.
+  class UpdateConfigSchemaRequest < ApiModelBase
+    # Replacement JSON Schema (draft 2020-12). Validated against every published value before it lands.
+    attr_accessor :schema
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'schema' => :'schema'
+      }
+    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
+      {
+        :'schema' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::UpdateConfigSchemaRequest` 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::UpdateConfigSchemaRequest`. 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?(:'schema')
+        if (value = attributes[:'schema']).is_a?(Hash)
+          self.schema = value
+        end
+      else
+        self.schema = nil
+      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 @schema.nil?
+        invalid_properties.push('invalid value for "schema", schema cannot be nil.')
+      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 @schema.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] schema Value to be assigned
+    def schema=(schema)
+      if schema.nil?
+        fail ArgumentError, 'schema cannot be nil'
+      end
+
+      @schema = schema
+    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 &&
+          schema == o.schema
+    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
+      [schema].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