plainrouter-sdk 0.1.1 → 0.5.0

data/lib/plainrouter/openapi/models/action_proposal_input.rb

@@ -0,0 +1,406 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class ActionProposalInput < ApiModelBase
+    attr_accessor :actions
+
+    attr_accessor :rationale
+
+    attr_accessor :idempotency_key
+
+    attr_accessor :evidence
+
+    attr_accessor :target_source
+
+    attr_accessor :account_id
+
+    attr_accessor :workspace_id
+
+    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
+      {
+        :'actions' => :'actions',
+        :'rationale' => :'rationale',
+        :'idempotency_key' => :'idempotency_key',
+        :'evidence' => :'evidence',
+        :'target_source' => :'target_source',
+        :'account_id' => :'account_id',
+        :'workspace_id' => :'workspace_id'
+      }
+    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
+      {
+        :'actions' => :'Array<ActionProposalInputActionsInner>',
+        :'rationale' => :'String',
+        :'idempotency_key' => :'String',
+        :'evidence' => :'Array<ActionProposalInputEvidenceInner>',
+        :'target_source' => :'String',
+        :'account_id' => :'Integer',
+        :'workspace_id' => :'Integer'
+      }
+    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 `PlainRouter::OpenAPI::ActionProposalInput` 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 `PlainRouter::OpenAPI::ActionProposalInput`. 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?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
+        end
+      else
+        self.actions = nil
+      end
+
+      if attributes.key?(:'rationale')
+        self.rationale = attributes[:'rationale']
+      else
+        self.rationale = nil
+      end
+
+      if attributes.key?(:'idempotency_key')
+        self.idempotency_key = attributes[:'idempotency_key']
+      else
+        self.idempotency_key = nil
+      end
+
+      if attributes.key?(:'evidence')
+        if (value = attributes[:'evidence']).is_a?(Array)
+          self.evidence = value
+        end
+      else
+        self.evidence = nil
+      end
+
+      if attributes.key?(:'target_source')
+        self.target_source = attributes[:'target_source']
+      else
+        self.target_source = nil
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'workspace_id')
+        self.workspace_id = attributes[:'workspace_id']
+      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 @actions.nil?
+        invalid_properties.push('invalid value for "actions", actions cannot be nil.')
+      end
+
+      if @actions.length > 25
+        invalid_properties.push('invalid value for "actions", number of items must be less than or equal to 25.')
+      end
+
+      if @actions.length < 1
+        invalid_properties.push('invalid value for "actions", number of items must be greater than or equal to 1.')
+      end
+
+      if @rationale.nil?
+        invalid_properties.push('invalid value for "rationale", rationale cannot be nil.')
+      end
+
+      if @rationale.to_s.length > 4000
+        invalid_properties.push('invalid value for "rationale", the character length must be smaller than or equal to 4000.')
+      end
+
+      if @idempotency_key.nil?
+        invalid_properties.push('invalid value for "idempotency_key", idempotency_key cannot be nil.')
+      end
+
+      if @idempotency_key.to_s.length > 64
+        invalid_properties.push('invalid value for "idempotency_key", the character length must be smaller than or equal to 64.')
+      end
+
+      if @evidence.nil?
+        invalid_properties.push('invalid value for "evidence", evidence cannot be nil.')
+      end
+
+      if @evidence.length > 3
+        invalid_properties.push('invalid value for "evidence", number of items must be less than or equal to 3.')
+      end
+
+      if @evidence.length < 1
+        invalid_properties.push('invalid value for "evidence", number of items must be greater than or equal to 1.')
+      end
+
+      if @target_source.nil?
+        invalid_properties.push('invalid value for "target_source", target_source cannot be nil.')
+      end
+
+      if !@account_id.nil? && @account_id < 1
+        invalid_properties.push('invalid value for "account_id", must be greater than or equal to 1.')
+      end
+
+      if !@workspace_id.nil? && @workspace_id < 1
+        invalid_properties.push('invalid value for "workspace_id", must be greater than or equal to 1.')
+      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 @actions.nil?
+      return false if @actions.length > 25
+      return false if @actions.length < 1
+      return false if @rationale.nil?
+      return false if @rationale.to_s.length > 4000
+      return false if @idempotency_key.nil?
+      return false if @idempotency_key.to_s.length > 64
+      return false if @evidence.nil?
+      return false if @evidence.length > 3
+      return false if @evidence.length < 1
+      return false if @target_source.nil?
+      target_source_validator = EnumAttributeValidator.new('String', ["human_supplied"])
+      return false unless target_source_validator.valid?(@target_source)
+      return false if !@account_id.nil? && @account_id < 1
+      return false if !@workspace_id.nil? && @workspace_id < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] actions Value to be assigned
+    def actions=(actions)
+      if actions.nil?
+        fail ArgumentError, 'actions cannot be nil'
+      end
+
+      if actions.length > 25
+        fail ArgumentError, 'invalid value for "actions", number of items must be less than or equal to 25.'
+      end
+
+      if actions.length < 1
+        fail ArgumentError, 'invalid value for "actions", number of items must be greater than or equal to 1.'
+      end
+
+      @actions = actions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rationale Value to be assigned
+    def rationale=(rationale)
+      if rationale.nil?
+        fail ArgumentError, 'rationale cannot be nil'
+      end
+
+      if rationale.to_s.length > 4000
+        fail ArgumentError, 'invalid value for "rationale", the character length must be smaller than or equal to 4000.'
+      end
+
+      @rationale = rationale
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] idempotency_key Value to be assigned
+    def idempotency_key=(idempotency_key)
+      if idempotency_key.nil?
+        fail ArgumentError, 'idempotency_key cannot be nil'
+      end
+
+      if idempotency_key.to_s.length > 64
+        fail ArgumentError, 'invalid value for "idempotency_key", the character length must be smaller than or equal to 64.'
+      end
+
+      @idempotency_key = idempotency_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] evidence Value to be assigned
+    def evidence=(evidence)
+      if evidence.nil?
+        fail ArgumentError, 'evidence cannot be nil'
+      end
+
+      if evidence.length > 3
+        fail ArgumentError, 'invalid value for "evidence", number of items must be less than or equal to 3.'
+      end
+
+      if evidence.length < 1
+        fail ArgumentError, 'invalid value for "evidence", number of items must be greater than or equal to 1.'
+      end
+
+      @evidence = evidence
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] target_source Object to be assigned
+    def target_source=(target_source)
+      validator = EnumAttributeValidator.new('String', ["human_supplied"])
+      unless validator.valid?(target_source)
+        fail ArgumentError, "invalid value for \"target_source\", must be one of #{validator.allowable_values}."
+      end
+      @target_source = target_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      if account_id < 1
+        fail ArgumentError, 'invalid value for "account_id", must be greater than or equal to 1.'
+      end
+
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] workspace_id Value to be assigned
+    def workspace_id=(workspace_id)
+      if workspace_id.nil?
+        fail ArgumentError, 'workspace_id cannot be nil'
+      end
+
+      if workspace_id < 1
+        fail ArgumentError, 'invalid value for "workspace_id", must be greater than or equal to 1.'
+      end
+
+      @workspace_id = workspace_id
+    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 &&
+          actions == o.actions &&
+          rationale == o.rationale &&
+          idempotency_key == o.idempotency_key &&
+          evidence == o.evidence &&
+          target_source == o.target_source &&
+          account_id == o.account_id &&
+          workspace_id == o.workspace_id
+    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
+      [actions, rationale, idempotency_key, evidence, target_source, account_id, workspace_id].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/plainrouter/openapi/models/action_proposal_input_actions_inner.rb

@@ -0,0 +1,115 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  module ActionProposalInputActionsInner
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'ActionProposalInputActionsInnerAnyOf',
+          :'ActionProposalInputActionsInnerAnyOf1',
+          :'ActionProposalInputActionsInnerAnyOf10',
+          :'ActionProposalInputActionsInnerAnyOf11',
+          :'ActionProposalInputActionsInnerAnyOf12',
+          :'ActionProposalInputActionsInnerAnyOf13',
+          :'ActionProposalInputActionsInnerAnyOf2',
+          :'ActionProposalInputActionsInnerAnyOf3',
+          :'ActionProposalInputActionsInnerAnyOf4',
+          :'ActionProposalInputActionsInnerAnyOf5',
+          :'ActionProposalInputActionsInnerAnyOf6',
+          :'ActionProposalInputActionsInnerAnyOf7',
+          :'ActionProposalInputActionsInnerAnyOf8',
+          :'ActionProposalInputActionsInnerAnyOf9'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = PlainRouter::OpenAPI.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end