ultracart_api 4.1.195 → 4.1.197

data/lib/ultracart_api/models/sfvb_approval.rb

@@ -0,0 +1,445 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbApproval
+    # The gated action.
+    attr_accessor :action
+
+    # Send this as the Approval-Id header on the gated call once status is approved.
+    attr_accessor :approval_id
+
+    # The page where the person approves or denies.  Show it to them.  Never open or fill it in yourself.
+    attr_accessor :approval_url
+
+    # When the request was made, ISO 8601 UTC.
+    attr_accessor :created_at
+
+    # The sentence the person reads before approving.  Written by the server, not the agent.
+    attr_accessor :description
+
+    # When this approval stops being usable, ISO 8601 UTC.  For a pending request, when it lapses undecided.  For an approved one, when it must have been used by.
+    attr_accessor :expires_at
+
+    # Seconds until expires_at.  Zero once passed.
+    attr_accessor :expires_in_seconds
+
+    # True when the person must enter a new 2FA code for this request even inside an approval session.
+    attr_accessor :fresh_code_required
+
+    # Poll no more often than this.
+    attr_accessor :interval_seconds
+
+    # Once used, succeeded or failed.  Used with no outcome means the result is unknown.  Check the target and never send the call again with this approval.
+    attr_accessor :outcome
+
+    # The error code the gated call failed with.
+    attr_accessor :outcome_code
+
+    # The HTTP status the gated call answered with.
+    attr_accessor :outcome_http_status
+
+    attr_accessor :params
+
+    # The reason the agent sent, as stored and shown (cleaned and capped).
+    attr_accessor :reason
+
+    # Where the action applies.  The storefront host name, or account for account-wide actions.
+    attr_accessor :scope
+
+    # pending, approved, denied, cancelled, expired or used.  Only approved may be sent with the gated call.
+    attr_accessor :status
+
+    # The storefront the action runs on.  Absent for account-wide actions.
+    attr_accessor :storefront_oid
+
+    # When the gated call used this approval, ISO 8601 UTC.
+    attr_accessor :used_at
+
+    # Short matching code.  Print it next to approval_url so the person can check the page shows the same code.
+    attr_accessor :user_code
+
+    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
+      {
+        :'action' => :'action',
+        :'approval_id' => :'approval_id',
+        :'approval_url' => :'approval_url',
+        :'created_at' => :'created_at',
+        :'description' => :'description',
+        :'expires_at' => :'expires_at',
+        :'expires_in_seconds' => :'expires_in_seconds',
+        :'fresh_code_required' => :'fresh_code_required',
+        :'interval_seconds' => :'interval_seconds',
+        :'outcome' => :'outcome',
+        :'outcome_code' => :'outcome_code',
+        :'outcome_http_status' => :'outcome_http_status',
+        :'params' => :'params',
+        :'reason' => :'reason',
+        :'scope' => :'scope',
+        :'status' => :'status',
+        :'storefront_oid' => :'storefront_oid',
+        :'used_at' => :'used_at',
+        :'user_code' => :'user_code'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'action' => :'String',
+        :'approval_id' => :'String',
+        :'approval_url' => :'String',
+        :'created_at' => :'String',
+        :'description' => :'String',
+        :'expires_at' => :'String',
+        :'expires_in_seconds' => :'Integer',
+        :'fresh_code_required' => :'Boolean',
+        :'interval_seconds' => :'Integer',
+        :'outcome' => :'String',
+        :'outcome_code' => :'String',
+        :'outcome_http_status' => :'Integer',
+        :'params' => :'SfvbApprovalParams',
+        :'reason' => :'String',
+        :'scope' => :'String',
+        :'status' => :'String',
+        :'storefront_oid' => :'Integer',
+        :'used_at' => :'String',
+        :'user_code' => :'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 `UltracartClient::SfvbApproval` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbApproval`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.key?(:'approval_id')
+        self.approval_id = attributes[:'approval_id']
+      end
+
+      if attributes.key?(:'approval_url')
+        self.approval_url = attributes[:'approval_url']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'expires_in_seconds')
+        self.expires_in_seconds = attributes[:'expires_in_seconds']
+      end
+
+      if attributes.key?(:'fresh_code_required')
+        self.fresh_code_required = attributes[:'fresh_code_required']
+      end
+
+      if attributes.key?(:'interval_seconds')
+        self.interval_seconds = attributes[:'interval_seconds']
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      end
+
+      if attributes.key?(:'outcome_code')
+        self.outcome_code = attributes[:'outcome_code']
+      end
+
+      if attributes.key?(:'outcome_http_status')
+        self.outcome_http_status = attributes[:'outcome_http_status']
+      end
+
+      if attributes.key?(:'params')
+        self.params = attributes[:'params']
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'storefront_oid')
+        self.storefront_oid = attributes[:'storefront_oid']
+      end
+
+      if attributes.key?(:'used_at')
+        self.used_at = attributes[:'used_at']
+      end
+
+      if attributes.key?(:'user_code')
+        self.user_code = attributes[:'user_code']
+      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
+      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?
+      outcome_validator = EnumAttributeValidator.new('String', ["succeeded", "failed"])
+      return false unless outcome_validator.valid?(@outcome)
+      status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "denied", "cancelled", "expired", "used"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] outcome Object to be assigned
+    def outcome=(outcome)
+      validator = EnumAttributeValidator.new('String', ["succeeded", "failed"])
+      unless validator.valid?(outcome)
+        fail ArgumentError, "invalid value for \"outcome\", must be one of #{validator.allowable_values}."
+      end
+      @outcome = outcome
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["pending", "approved", "denied", "cancelled", "expired", "used"])
+      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 &&
+          action == o.action &&
+          approval_id == o.approval_id &&
+          approval_url == o.approval_url &&
+          created_at == o.created_at &&
+          description == o.description &&
+          expires_at == o.expires_at &&
+          expires_in_seconds == o.expires_in_seconds &&
+          fresh_code_required == o.fresh_code_required &&
+          interval_seconds == o.interval_seconds &&
+          outcome == o.outcome &&
+          outcome_code == o.outcome_code &&
+          outcome_http_status == o.outcome_http_status &&
+          params == o.params &&
+          reason == o.reason &&
+          scope == o.scope &&
+          status == o.status &&
+          storefront_oid == o.storefront_oid &&
+          used_at == o.used_at &&
+          user_code == o.user_code
+    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
+      [action, approval_id, approval_url, created_at, description, expires_at, expires_in_seconds, fresh_code_required, interval_seconds, outcome, outcome_code, outcome_http_status, params, reason, scope, status, storefront_oid, used_at, user_code].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end