plainrouter-sdk 0.1.1 → 0.5.0

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

@@ -0,0 +1,306 @@
+=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 ActionCurrentDisposition < ApiModelBase
+    attr_accessor :receipt_status
+
+    attr_accessor :outcome_payload
+
+    attr_accessor :outcome_status
+
+    attr_accessor :outcome_reason_code
+
+    attr_accessor :outcome_checked_at
+
+    attr_accessor :compensation_reason_code
+
+    attr_accessor :recovery_disposition
+
+    attr_accessor :late_restored
+
+    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
+      {
+        :'receipt_status' => :'receipt_status',
+        :'outcome_payload' => :'outcome_payload',
+        :'outcome_status' => :'outcome_status',
+        :'outcome_reason_code' => :'outcome_reason_code',
+        :'outcome_checked_at' => :'outcome_checked_at',
+        :'compensation_reason_code' => :'compensation_reason_code',
+        :'recovery_disposition' => :'recovery_disposition',
+        :'late_restored' => :'late_restored'
+      }
+    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
+      {
+        :'receipt_status' => :'String',
+        :'outcome_payload' => :'ActionCurrentDispositionOutcomePayload',
+        :'outcome_status' => :'String',
+        :'outcome_reason_code' => :'String',
+        :'outcome_checked_at' => :'Time',
+        :'compensation_reason_code' => :'String',
+        :'recovery_disposition' => :'String',
+        :'late_restored' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'receipt_status',
+        :'outcome_payload',
+        :'outcome_status',
+        :'outcome_reason_code',
+        :'outcome_checked_at',
+        :'compensation_reason_code',
+        :'recovery_disposition',
+      ])
+    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::ActionCurrentDisposition` 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::ActionCurrentDisposition`. 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?(:'receipt_status')
+        self.receipt_status = attributes[:'receipt_status']
+      else
+        self.receipt_status = nil
+      end
+
+      if attributes.key?(:'outcome_payload')
+        self.outcome_payload = attributes[:'outcome_payload']
+      else
+        self.outcome_payload = nil
+      end
+
+      if attributes.key?(:'outcome_status')
+        self.outcome_status = attributes[:'outcome_status']
+      else
+        self.outcome_status = nil
+      end
+
+      if attributes.key?(:'outcome_reason_code')
+        self.outcome_reason_code = attributes[:'outcome_reason_code']
+      else
+        self.outcome_reason_code = nil
+      end
+
+      if attributes.key?(:'outcome_checked_at')
+        self.outcome_checked_at = attributes[:'outcome_checked_at']
+      else
+        self.outcome_checked_at = nil
+      end
+
+      if attributes.key?(:'compensation_reason_code')
+        self.compensation_reason_code = attributes[:'compensation_reason_code']
+      else
+        self.compensation_reason_code = nil
+      end
+
+      if attributes.key?(:'recovery_disposition')
+        self.recovery_disposition = attributes[:'recovery_disposition']
+      else
+        self.recovery_disposition = nil
+      end
+
+      if attributes.key?(:'late_restored')
+        self.late_restored = attributes[:'late_restored']
+      else
+        self.late_restored = 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 @late_restored.nil?
+        invalid_properties.push('invalid value for "late_restored", late_restored 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'
+      receipt_status_validator = EnumAttributeValidator.new('String', ["pending", "attempting", "reconciliation_required", "committed", "executed_pending_verification", "measuring", "verified", "compensating", "compensated", "compensation_failed", "irreversible", "failed", "reconciliation_exhausted"])
+      return false unless receipt_status_validator.valid?(@receipt_status)
+      outcome_status_validator = EnumAttributeValidator.new('String', ["measurable", "not_measurable", "unavailable"])
+      return false unless outcome_status_validator.valid?(@outcome_status)
+      recovery_disposition_validator = EnumAttributeValidator.new('String', ["no_compensation", "restored", "unrestored", "contradictory", "irreversible", "uncertain"])
+      return false unless recovery_disposition_validator.valid?(@recovery_disposition)
+      return false if @late_restored.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] receipt_status Object to be assigned
+    def receipt_status=(receipt_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "attempting", "reconciliation_required", "committed", "executed_pending_verification", "measuring", "verified", "compensating", "compensated", "compensation_failed", "irreversible", "failed", "reconciliation_exhausted"])
+      unless validator.valid?(receipt_status)
+        fail ArgumentError, "invalid value for \"receipt_status\", must be one of #{validator.allowable_values}."
+      end
+      @receipt_status = receipt_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] outcome_status Object to be assigned
+    def outcome_status=(outcome_status)
+      validator = EnumAttributeValidator.new('String', ["measurable", "not_measurable", "unavailable"])
+      unless validator.valid?(outcome_status)
+        fail ArgumentError, "invalid value for \"outcome_status\", must be one of #{validator.allowable_values}."
+      end
+      @outcome_status = outcome_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] recovery_disposition Object to be assigned
+    def recovery_disposition=(recovery_disposition)
+      validator = EnumAttributeValidator.new('String', ["no_compensation", "restored", "unrestored", "contradictory", "irreversible", "uncertain"])
+      unless validator.valid?(recovery_disposition)
+        fail ArgumentError, "invalid value for \"recovery_disposition\", must be one of #{validator.allowable_values}."
+      end
+      @recovery_disposition = recovery_disposition
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] late_restored Value to be assigned
+    def late_restored=(late_restored)
+      if late_restored.nil?
+        fail ArgumentError, 'late_restored cannot be nil'
+      end
+
+      @late_restored = late_restored
+    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 &&
+          receipt_status == o.receipt_status &&
+          outcome_payload == o.outcome_payload &&
+          outcome_status == o.outcome_status &&
+          outcome_reason_code == o.outcome_reason_code &&
+          outcome_checked_at == o.outcome_checked_at &&
+          compensation_reason_code == o.compensation_reason_code &&
+          recovery_disposition == o.recovery_disposition &&
+          late_restored == o.late_restored
+    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
+      [receipt_status, outcome_payload, outcome_status, outcome_reason_code, outcome_checked_at, compensation_reason_code, recovery_disposition, late_restored].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_current_disposition_outcome_payload.rb

@@ -0,0 +1,238 @@
+=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
+  # Write-once outcome. Management comparisons use PlainRouter counted arrivals and Inventory spend. Resume compares the target after the change with the rest of the same account over those same days. Pause is not judged. Missing data never yields a verdict. Other action types retain their existing payloads.
+  class ActionCurrentDispositionOutcomePayload < ApiModelBase
+    attr_accessor :status
+
+    attr_accessor :observed_at
+
+    attr_accessor :reason_code
+
+    attr_accessor :reason
+
+    attr_accessor :baseline
+
+    attr_accessor :metrics
+
+    attr_accessor :inverse
+
+    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
+      {
+        :'status' => :'status',
+        :'observed_at' => :'observed_at',
+        :'reason_code' => :'reason_code',
+        :'reason' => :'reason',
+        :'baseline' => :'baseline',
+        :'metrics' => :'metrics',
+        :'inverse' => :'inverse'
+      }
+    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
+      {
+        :'status' => :'String',
+        :'observed_at' => :'Time',
+        :'reason_code' => :'String',
+        :'reason' => :'String',
+        :'baseline' => :'ActionCurrentDispositionOutcomePayloadBaseline',
+        :'metrics' => :'ActionCurrentDispositionOutcomePayloadMetrics',
+        :'inverse' => :'ActionCurrentDispositionOutcomePayloadInverse'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'reason_code',
+        :'reason',
+      ])
+    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::ActionCurrentDispositionOutcomePayload` 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::ActionCurrentDispositionOutcomePayload`. 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?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'observed_at')
+        self.observed_at = attributes[:'observed_at']
+      end
+
+      if attributes.key?(:'reason_code')
+        self.reason_code = attributes[:'reason_code']
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.key?(:'baseline')
+        self.baseline = attributes[:'baseline']
+      end
+
+      if attributes.key?(:'metrics')
+        self.metrics = attributes[:'metrics']
+      end
+
+      if attributes.key?(:'inverse')
+        self.inverse = attributes[:'inverse']
+      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'
+      status_validator = EnumAttributeValidator.new('String', ["measurable", "not_measurable", "unavailable"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["measurable", "not_measurable", "unavailable"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          status == o.status &&
+          observed_at == o.observed_at &&
+          reason_code == o.reason_code &&
+          reason == o.reason &&
+          baseline == o.baseline &&
+          metrics == o.metrics &&
+          inverse == o.inverse
+    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
+      [status, observed_at, reason_code, reason, baseline, metrics, inverse].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_current_disposition_outcome_payload_baseline.rb

@@ -0,0 +1,103 @@
+=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 ActionCurrentDispositionOutcomePayloadBaseline
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'ActionCurrentDispositionOutcomePayloadBaselineAnyOf',
+          :'Array<String>'
+        ]
+      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