plainrouter-sdk 0.2.0 → 0.6.0

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

@@ -0,0 +1,319 @@
+=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
+  # Frozen proposal-time target figures over completed account-local dates. Purchase values are decimal strings in the account currency; counted values in other currencies are excluded and never converted. Null means figures were not captured. Display only; never an enforcement input.
+  class ActionReadItemCountedEvidence < ApiModelBase
+    attr_accessor :target
+
+    attr_accessor :captured_at
+
+    attr_accessor :window
+
+    attr_accessor :currency
+
+    attr_accessor :currency_note
+
+    attr_accessor :meta_reported
+
+    attr_accessor :counted
+
+    attr_accessor :coverage
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'target' => :'target',
+        :'captured_at' => :'captured_at',
+        :'window' => :'window',
+        :'currency' => :'currency',
+        :'currency_note' => :'currency_note',
+        :'meta_reported' => :'meta_reported',
+        :'counted' => :'counted',
+        :'coverage' => :'coverage'
+      }
+    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
+      {
+        :'target' => :'ActionReadItemCountedEvidenceTarget',
+        :'captured_at' => :'String',
+        :'window' => :'ActionReadItemCountedEvidenceWindow',
+        :'currency' => :'String',
+        :'currency_note' => :'String',
+        :'meta_reported' => :'ActionReadItemCountedEvidenceMetaReported',
+        :'counted' => :'ActionReadItemCountedEvidenceCounted',
+        :'coverage' => :'ActionReadItemCountedEvidenceCoverage'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'window',
+        :'currency',
+      ])
+    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::ActionReadItemCountedEvidence` 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::ActionReadItemCountedEvidence`. 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?(:'target')
+        self.target = attributes[:'target']
+      else
+        self.target = nil
+      end
+
+      if attributes.key?(:'captured_at')
+        self.captured_at = attributes[:'captured_at']
+      else
+        self.captured_at = nil
+      end
+
+      if attributes.key?(:'window')
+        self.window = attributes[:'window']
+      else
+        self.window = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'currency_note')
+        self.currency_note = attributes[:'currency_note']
+      else
+        self.currency_note = nil
+      end
+
+      if attributes.key?(:'meta_reported')
+        self.meta_reported = attributes[:'meta_reported']
+      else
+        self.meta_reported = nil
+      end
+
+      if attributes.key?(:'counted')
+        self.counted = attributes[:'counted']
+      else
+        self.counted = nil
+      end
+
+      if attributes.key?(:'coverage')
+        self.coverage = attributes[:'coverage']
+      else
+        self.coverage = 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 @target.nil?
+        invalid_properties.push('invalid value for "target", target cannot be nil.')
+      end
+
+      if @captured_at.nil?
+        invalid_properties.push('invalid value for "captured_at", captured_at cannot be nil.')
+      end
+
+      if @currency_note.nil?
+        invalid_properties.push('invalid value for "currency_note", currency_note cannot be nil.')
+      end
+
+      if @meta_reported.nil?
+        invalid_properties.push('invalid value for "meta_reported", meta_reported cannot be nil.')
+      end
+
+      if @counted.nil?
+        invalid_properties.push('invalid value for "counted", counted cannot be nil.')
+      end
+
+      if @coverage.nil?
+        invalid_properties.push('invalid value for "coverage", coverage 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 @target.nil?
+      return false if @captured_at.nil?
+      return false if @currency_note.nil?
+      return false if @meta_reported.nil?
+      return false if @counted.nil?
+      return false if @coverage.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target Value to be assigned
+    def target=(target)
+      if target.nil?
+        fail ArgumentError, 'target cannot be nil'
+      end
+
+      @target = target
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] captured_at Value to be assigned
+    def captured_at=(captured_at)
+      if captured_at.nil?
+        fail ArgumentError, 'captured_at cannot be nil'
+      end
+
+      @captured_at = captured_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency_note Value to be assigned
+    def currency_note=(currency_note)
+      if currency_note.nil?
+        fail ArgumentError, 'currency_note cannot be nil'
+      end
+
+      @currency_note = currency_note
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] meta_reported Value to be assigned
+    def meta_reported=(meta_reported)
+      if meta_reported.nil?
+        fail ArgumentError, 'meta_reported cannot be nil'
+      end
+
+      @meta_reported = meta_reported
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] counted Value to be assigned
+    def counted=(counted)
+      if counted.nil?
+        fail ArgumentError, 'counted cannot be nil'
+      end
+
+      @counted = counted
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] coverage Value to be assigned
+    def coverage=(coverage)
+      if coverage.nil?
+        fail ArgumentError, 'coverage cannot be nil'
+      end
+
+      @coverage = coverage
+    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 &&
+          target == o.target &&
+          captured_at == o.captured_at &&
+          window == o.window &&
+          currency == o.currency &&
+          currency_note == o.currency_note &&
+          meta_reported == o.meta_reported &&
+          counted == o.counted &&
+          coverage == o.coverage
+    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
+      [target, captured_at, window, currency, currency_note, meta_reported, counted, coverage].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_read_item_counted_evidence_counted.rb

@@ -0,0 +1,174 @@
+=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 ActionReadItemCountedEvidenceCounted < ApiModelBase
+    attr_accessor :arrivals
+
+    attr_accessor :purchase_count
+
+    attr_accessor :purchase_value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'arrivals' => :'arrivals',
+        :'purchase_count' => :'purchase_count',
+        :'purchase_value' => :'purchase_value'
+      }
+    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
+      {
+        :'arrivals' => :'Integer',
+        :'purchase_count' => :'Integer',
+        :'purchase_value' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'arrivals',
+        :'purchase_count',
+        :'purchase_value'
+      ])
+    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::ActionReadItemCountedEvidenceCounted` 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::ActionReadItemCountedEvidenceCounted`. 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?(:'arrivals')
+        self.arrivals = attributes[:'arrivals']
+      else
+        self.arrivals = nil
+      end
+
+      if attributes.key?(:'purchase_count')
+        self.purchase_count = attributes[:'purchase_count']
+      else
+        self.purchase_count = nil
+      end
+
+      if attributes.key?(:'purchase_value')
+        self.purchase_value = attributes[:'purchase_value']
+      else
+        self.purchase_value = 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
+      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'
+      true
+    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 &&
+          arrivals == o.arrivals &&
+          purchase_count == o.purchase_count &&
+          purchase_value == o.purchase_value
+    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
+      [arrivals, purchase_count, purchase_value].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_read_item_counted_evidence_coverage.rb

@@ -0,0 +1,162 @@
+=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 ActionReadItemCountedEvidenceCoverage < ApiModelBase
+    attr_accessor :arrivals
+
+    attr_accessor :purchases
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'arrivals' => :'arrivals',
+        :'purchases' => :'purchases'
+      }
+    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
+      {
+        :'arrivals' => :'ActionReadItemCountedEvidenceWindow',
+        :'purchases' => :'ActionReadItemCountedEvidenceWindow'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'arrivals',
+        :'purchases'
+      ])
+    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::ActionReadItemCountedEvidenceCoverage` 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::ActionReadItemCountedEvidenceCoverage`. 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?(:'arrivals')
+        self.arrivals = attributes[:'arrivals']
+      else
+        self.arrivals = nil
+      end
+
+      if attributes.key?(:'purchases')
+        self.purchases = attributes[:'purchases']
+      else
+        self.purchases = 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
+      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'
+      true
+    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 &&
+          arrivals == o.arrivals &&
+          purchases == o.purchases
+    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
+      [arrivals, purchases].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