ultracart_api 4.1.201 → 4.1.203

data/lib/ultracart_api/models/sfvb_secret_request.rb

@@ -0,0 +1,440 @@
+=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 SfvbSecretRequest
+    # When the request was made, ISO 8601 UTC.
+    attr_accessor :created_at
+
+    # True when the requester handed it to a colleague to fill in.
+    attr_accessor :delegated
+
+    # The sentence the person reads.  Written by the server, not the agent.
+    attr_accessor :description
+
+    # When a pending request lapses, ISO 8601 UTC.
+    attr_accessor :expires_at
+
+    # Seconds until expires_at.  Zero once passed.
+    attr_accessor :expires_in_seconds
+
+    # When the values were entered, ISO 8601 UTC.
+    attr_accessor :fulfilled_at
+
+    # How many handles the request made.
+    attr_accessor :handle_count
+
+    # Every handle with its status.  Left out of the list endpoint; read one request for them.
+    attr_accessor :handles
+
+    # Poll no more often than this.
+    attr_accessor :interval_seconds
+
+    # The bulk keys, or empty.
+    attr_accessor :keys
+
+    # The label the agent sent, as stored and shown.
+    attr_accessor :label
+
+    # The reason the agent sent, as stored and shown.
+    attr_accessor :reason
+
+    # The request id.
+    attr_accessor :request_id
+
+    # The page where the person enters the values.  Show it to them.  Never open or fill it in yourself.
+    attr_accessor :request_url
+
+    # True when the person must enter a code from their authenticator app.
+    attr_accessor :requires_totp
+
+    # The secret fields being collected.
+    attr_accessor :sinks
+
+    # pending, fulfilled, cancelled or expired.
+    attr_accessor :status
+
+    # The object the values are for, or empty for a bulk request or an open one.
+    attr_accessor :target_id
+
+    # Short matching code.  Print it next to request_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
+      {
+        :'created_at' => :'created_at',
+        :'delegated' => :'delegated',
+        :'description' => :'description',
+        :'expires_at' => :'expires_at',
+        :'expires_in_seconds' => :'expires_in_seconds',
+        :'fulfilled_at' => :'fulfilled_at',
+        :'handle_count' => :'handle_count',
+        :'handles' => :'handles',
+        :'interval_seconds' => :'interval_seconds',
+        :'keys' => :'keys',
+        :'label' => :'label',
+        :'reason' => :'reason',
+        :'request_id' => :'request_id',
+        :'request_url' => :'request_url',
+        :'requires_totp' => :'requires_totp',
+        :'sinks' => :'sinks',
+        :'status' => :'status',
+        :'target_id' => :'target_id',
+        :'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
+      {
+        :'created_at' => :'String',
+        :'delegated' => :'Boolean',
+        :'description' => :'String',
+        :'expires_at' => :'String',
+        :'expires_in_seconds' => :'Integer',
+        :'fulfilled_at' => :'String',
+        :'handle_count' => :'Integer',
+        :'handles' => :'Array<SfvbSecretHandle>',
+        :'interval_seconds' => :'Integer',
+        :'keys' => :'Array<String>',
+        :'label' => :'String',
+        :'reason' => :'String',
+        :'request_id' => :'String',
+        :'request_url' => :'String',
+        :'requires_totp' => :'Boolean',
+        :'sinks' => :'Array<String>',
+        :'status' => :'String',
+        :'target_id' => :'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::SfvbSecretRequest` 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::SfvbSecretRequest`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'delegated')
+        self.delegated = attributes[:'delegated']
+      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?(:'fulfilled_at')
+        self.fulfilled_at = attributes[:'fulfilled_at']
+      end
+
+      if attributes.key?(:'handle_count')
+        self.handle_count = attributes[:'handle_count']
+      end
+
+      if attributes.key?(:'handles')
+        if (value = attributes[:'handles']).is_a?(Array)
+          self.handles = value
+        end
+      end
+
+      if attributes.key?(:'interval_seconds')
+        self.interval_seconds = attributes[:'interval_seconds']
+      end
+
+      if attributes.key?(:'keys')
+        if (value = attributes[:'keys']).is_a?(Array)
+          self.keys = value
+        end
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.key?(:'request_id')
+        self.request_id = attributes[:'request_id']
+      end
+
+      if attributes.key?(:'request_url')
+        self.request_url = attributes[:'request_url']
+      end
+
+      if attributes.key?(:'requires_totp')
+        self.requires_totp = attributes[:'requires_totp']
+      end
+
+      if attributes.key?(:'sinks')
+        if (value = attributes[:'sinks']).is_a?(Array)
+          self.sinks = value
+        end
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'target_id')
+        self.target_id = attributes[:'target_id']
+      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?
+      status_validator = EnumAttributeValidator.new('String', ["pending", "fulfilled", "cancelled", "expired"])
+      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', ["pending", "fulfilled", "cancelled", "expired"])
+      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 &&
+          created_at == o.created_at &&
+          delegated == o.delegated &&
+          description == o.description &&
+          expires_at == o.expires_at &&
+          expires_in_seconds == o.expires_in_seconds &&
+          fulfilled_at == o.fulfilled_at &&
+          handle_count == o.handle_count &&
+          handles == o.handles &&
+          interval_seconds == o.interval_seconds &&
+          keys == o.keys &&
+          label == o.label &&
+          reason == o.reason &&
+          request_id == o.request_id &&
+          request_url == o.request_url &&
+          requires_totp == o.requires_totp &&
+          sinks == o.sinks &&
+          status == o.status &&
+          target_id == o.target_id &&
+          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
+      [created_at, delegated, description, expires_at, expires_in_seconds, fulfilled_at, handle_count, handles, interval_seconds, keys, label, reason, request_id, request_url, requires_totp, sinks, status, target_id, 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