shipeasy-sdk 2.3.0 → 2.3.1

data/lib/shipeasy_admin/models/set_i18n_label_request.rb

@@ -0,0 +1,213 @@
+=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 `POST /api/admin/i18n/set`. Upserts one key's value and publishes the profile live.
+  class SetI18nLabelRequest < ApiModelBase
+    # Dotted key path to set, e.g. `home.cta`.
+    attr_accessor :key
+
+    # New value for the key. Inserted when the key is new, overwritten when it exists.
+    attr_accessor :value
+
+    # Profile name to target, e.g. `en:prod`. Omit to target the project's default-marked profile.
+    attr_accessor :profile
+
+    # Optional human note to store with the key.
+    attr_accessor :description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'key' => :'key',
+        :'value' => :'value',
+        :'profile' => :'profile',
+        :'description' => :'description'
+      }
+    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
+      {
+        :'key' => :'String',
+        :'value' => :'String',
+        :'profile' => :'String',
+        :'description' => :'String'
+      }
+    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::SetI18nLabelRequest` 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::SetI18nLabelRequest`. 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?(:'key')
+        self.key = attributes[:'key']
+      else
+        self.key = nil
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      else
+        self.value = nil
+      end
+
+      if attributes.key?(:'profile')
+        self.profile = attributes[:'profile']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      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 @key.nil?
+        invalid_properties.push('invalid value for "key", key cannot be nil.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value 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 @key.nil?
+      return false if @value.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      if key.nil?
+        fail ArgumentError, 'key cannot be nil'
+      end
+
+      @key = key
+    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'
+      end
+
+      @value = value
+    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 &&
+          key == o.key &&
+          value == o.value &&
+          profile == o.profile &&
+          description == o.description
+    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
+      [key, value, profile, description].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/set_i18n_label_response.rb

@@ -0,0 +1,472 @@
+=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 a one-shot set-and-publish.
+  class SetI18nLabelResponse < ApiModelBase
+    # Always `true` on success.
+    attr_accessor :ok
+
+    # Name of the profile that was published.
+    attr_accessor :profile
+
+    # Id of the profile that was published.
+    attr_accessor :profile_id
+
+    # The key that was set.
+    attr_accessor :key
+
+    # The value that was stored.
+    attr_accessor :value
+
+    # ISO-8601 timestamp of the publish.
+    attr_accessor :published_at
+
+    # New KV snapshot version that was shipped.
+    attr_accessor :version
+
+    # Number of keys in the published snapshot.
+    attr_accessor :key_count
+
+    # Whether the snapshot's contents actually changed since the last publish.
+    attr_accessor :changed
+
+    # CDN purge outcome: `purged` ok, `skipped` (no creds), or `failed` (edge still stale).
+    attr_accessor :purged
+
+    # Whether a KV read-back confirmed the new version persisted.
+    attr_accessor :kv_verified
+
+    # Human-readable caveat when the publish landed but is not fully live.
+    attr_accessor :warning
+
+    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
+      {
+        :'ok' => :'ok',
+        :'profile' => :'profile',
+        :'profile_id' => :'profile_id',
+        :'key' => :'key',
+        :'value' => :'value',
+        :'published_at' => :'published_at',
+        :'version' => :'version',
+        :'key_count' => :'key_count',
+        :'changed' => :'changed',
+        :'purged' => :'purged',
+        :'kv_verified' => :'kv_verified',
+        :'warning' => :'warning'
+      }
+    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',
+        :'profile' => :'String',
+        :'profile_id' => :'String',
+        :'key' => :'String',
+        :'value' => :'String',
+        :'published_at' => :'String',
+        :'version' => :'String',
+        :'key_count' => :'Float',
+        :'changed' => :'Boolean',
+        :'purged' => :'String',
+        :'kv_verified' => :'Boolean',
+        :'warning' => :'String'
+      }
+    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::SetI18nLabelResponse` 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::SetI18nLabelResponse`. 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?(:'profile')
+        self.profile = attributes[:'profile']
+      else
+        self.profile = nil
+      end
+
+      if attributes.key?(:'profile_id')
+        self.profile_id = attributes[:'profile_id']
+      else
+        self.profile_id = nil
+      end
+
+      if attributes.key?(:'key')
+        self.key = attributes[:'key']
+      else
+        self.key = nil
+      end
+
+      if attributes.key?(:'value')
+        self.value = attributes[:'value']
+      else
+        self.value = nil
+      end
+
+      if attributes.key?(:'published_at')
+        self.published_at = attributes[:'published_at']
+      else
+        self.published_at = nil
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      else
+        self.version = nil
+      end
+
+      if attributes.key?(:'key_count')
+        self.key_count = attributes[:'key_count']
+      else
+        self.key_count = nil
+      end
+
+      if attributes.key?(:'changed')
+        self.changed = attributes[:'changed']
+      else
+        self.changed = nil
+      end
+
+      if attributes.key?(:'purged')
+        self.purged = attributes[:'purged']
+      else
+        self.purged = nil
+      end
+
+      if attributes.key?(:'kv_verified')
+        self.kv_verified = attributes[:'kv_verified']
+      else
+        self.kv_verified = nil
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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
+
+      if @profile.nil?
+        invalid_properties.push('invalid value for "profile", profile cannot be nil.')
+      end
+
+      if @profile_id.nil?
+        invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
+      end
+
+      if @key.nil?
+        invalid_properties.push('invalid value for "key", key cannot be nil.')
+      end
+
+      if @value.nil?
+        invalid_properties.push('invalid value for "value", value cannot be nil.')
+      end
+
+      if @published_at.nil?
+        invalid_properties.push('invalid value for "published_at", published_at cannot be nil.')
+      end
+
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version cannot be nil.')
+      end
+
+      if @key_count.nil?
+        invalid_properties.push('invalid value for "key_count", key_count cannot be nil.')
+      end
+
+      if @changed.nil?
+        invalid_properties.push('invalid value for "changed", changed cannot be nil.')
+      end
+
+      if @purged.nil?
+        invalid_properties.push('invalid value for "purged", purged cannot be nil.')
+      end
+
+      if @kv_verified.nil?
+        invalid_properties.push('invalid value for "kv_verified", kv_verified 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?
+      ok_validator = EnumAttributeValidator.new('Boolean', ["true"])
+      return false unless ok_validator.valid?(@ok)
+      return false if @profile.nil?
+      return false if @profile_id.nil?
+      return false if @key.nil?
+      return false if @value.nil?
+      return false if @published_at.nil?
+      return false if @version.nil?
+      return false if @key_count.nil?
+      return false if @changed.nil?
+      return false if @purged.nil?
+      purged_validator = EnumAttributeValidator.new('String', ["purged", "skipped", "failed"])
+      return false unless purged_validator.valid?(@purged)
+      return false if @kv_verified.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ok Object to be assigned
+    def ok=(ok)
+      validator = EnumAttributeValidator.new('Boolean', ["true"])
+      unless validator.valid?(ok)
+        fail ArgumentError, "invalid value for \"ok\", must be one of #{validator.allowable_values}."
+      end
+      @ok = ok
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] profile Value to be assigned
+    def profile=(profile)
+      if profile.nil?
+        fail ArgumentError, 'profile cannot be nil'
+      end
+
+      @profile = profile
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] profile_id Value to be assigned
+    def profile_id=(profile_id)
+      if profile_id.nil?
+        fail ArgumentError, 'profile_id cannot be nil'
+      end
+
+      @profile_id = profile_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key Value to be assigned
+    def key=(key)
+      if key.nil?
+        fail ArgumentError, 'key cannot be nil'
+      end
+
+      @key = key
+    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'
+      end
+
+      @value = value
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] published_at Value to be assigned
+    def published_at=(published_at)
+      if published_at.nil?
+        fail ArgumentError, 'published_at cannot be nil'
+      end
+
+      @published_at = published_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] version Value to be assigned
+    def version=(version)
+      if version.nil?
+        fail ArgumentError, 'version cannot be nil'
+      end
+
+      @version = version
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] key_count Value to be assigned
+    def key_count=(key_count)
+      if key_count.nil?
+        fail ArgumentError, 'key_count cannot be nil'
+      end
+
+      @key_count = key_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] changed Value to be assigned
+    def changed=(changed)
+      if changed.nil?
+        fail ArgumentError, 'changed cannot be nil'
+      end
+
+      @changed = changed
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] purged Object to be assigned
+    def purged=(purged)
+      validator = EnumAttributeValidator.new('String', ["purged", "skipped", "failed"])
+      unless validator.valid?(purged)
+        fail ArgumentError, "invalid value for \"purged\", must be one of #{validator.allowable_values}."
+      end
+      @purged = purged
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] kv_verified Value to be assigned
+    def kv_verified=(kv_verified)
+      if kv_verified.nil?
+        fail ArgumentError, 'kv_verified cannot be nil'
+      end
+
+      @kv_verified = kv_verified
+    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 &&
+          profile == o.profile &&
+          profile_id == o.profile_id &&
+          key == o.key &&
+          value == o.value &&
+          published_at == o.published_at &&
+          version == o.version &&
+          key_count == o.key_count &&
+          changed == o.changed &&
+          purged == o.purged &&
+          kv_verified == o.kv_verified &&
+          warning == o.warning
+    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, profile, profile_id, key, value, published_at, version, key_count, changed, purged, kv_verified, warning].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