trinsic_api 2.2.0 → 2.3.0.pre.alpha2

data/lib/trinsic_api/models/spid_billing_information.rb

@@ -0,0 +1,293 @@
+=begin
+#Trinsic API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrinsicApi
+  # Billing information for a SPID Verification.
+  class SpidBillingInformation
+    # Whether this SPID verification has resulted in a billable event.
+    attr_accessor :is_billable
+
+    # The billable verification type for this SPID verification.              Possible values: \"Authentication\" | \"Registration\"
+    attr_accessor :verification_type
+
+    # The billable verification level for this SPID verification.              Possible values: 1 | 2 | 3
+    attr_accessor :verification_level
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'is_billable' => :'isBillable',
+        :'verification_type' => :'verificationType',
+        :'verification_level' => :'verificationLevel'
+      }
+    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
+      {
+        :'is_billable' => :'Boolean',
+        :'verification_type' => :'String',
+        :'verification_level' => :'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 `TrinsicApi::SpidBillingInformation` 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 `TrinsicApi::SpidBillingInformation`. 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?(:'is_billable')
+        self.is_billable = attributes[:'is_billable']
+      else
+        self.is_billable = nil
+      end
+
+      if attributes.key?(:'verification_type')
+        self.verification_type = attributes[:'verification_type']
+      else
+        self.verification_type = nil
+      end
+
+      if attributes.key?(:'verification_level')
+        self.verification_level = attributes[:'verification_level']
+      else
+        self.verification_level = 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 @is_billable.nil?
+        invalid_properties.push('invalid value for "is_billable", is_billable cannot be nil.')
+      end
+
+      if @verification_type.nil?
+        invalid_properties.push('invalid value for "verification_type", verification_type cannot be nil.')
+      end
+
+      if @verification_level.nil?
+        invalid_properties.push('invalid value for "verification_level", verification_level 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 @is_billable.nil?
+      return false if @verification_type.nil?
+      return false if @verification_level.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_billable Value to be assigned
+    def is_billable=(is_billable)
+      if is_billable.nil?
+        fail ArgumentError, 'is_billable cannot be nil'
+      end
+
+      @is_billable = is_billable
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] verification_type Value to be assigned
+    def verification_type=(verification_type)
+      if verification_type.nil?
+        fail ArgumentError, 'verification_type cannot be nil'
+      end
+
+      @verification_type = verification_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] verification_level Value to be assigned
+    def verification_level=(verification_level)
+      if verification_level.nil?
+        fail ArgumentError, 'verification_level cannot be nil'
+      end
+
+      @verification_level = verification_level
+    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 &&
+          is_billable == o.is_billable &&
+          verification_type == o.verification_type &&
+          verification_level == o.verification_level
+    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
+      [is_billable, verification_type, verification_level].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = TrinsicApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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

data/lib/trinsic_api/models/spid_input.rb

@@ -18,10 +18,14 @@ module TrinsicApi
     # The ID of the specific IDP to invoke within SPID.              If not specified, the user will be prompted to select an IDP.
     attr_accessor :sub_provider_id
 
+    # Only applicable if period-based billing is enabled for your Verification Profile. Contact Trinsic to enable this.              A secret UTF-8 string between 32 and 64 characters in length, used to enable privacy-preserving tracking of unique user verifications during a billing period.              WARNING: This value must NOT change during the course of a billing period for a given Verification Profile, or double-billing may occur. If multiple Verification Profiles are configured to use the same Trinsic-managed SPID Service Provider, the same Billing Tracking Secret must be provided across all such Verification Profiles.
+    attr_accessor :billing_tracking_secret
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'sub_provider_id' => :'subProviderId'
+        :'sub_provider_id' => :'subProviderId',
+        :'billing_tracking_secret' => :'billingTrackingSecret'
       }
     end
 
@@ -38,14 +42,16 @@ module TrinsicApi
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'sub_provider_id' => :'String'
+        :'sub_provider_id' => :'String',
+        :'billing_tracking_secret' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'sub_provider_id'
+        :'sub_provider_id',
+        :'billing_tracking_secret'
       ])
     end
 
@@ -68,6 +74,10 @@ module TrinsicApi
       if attributes.key?(:'sub_provider_id')
         self.sub_provider_id = attributes[:'sub_provider_id']
       end
+
+      if attributes.key?(:'billing_tracking_secret')
+        self.billing_tracking_secret = attributes[:'billing_tracking_secret']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -90,7 +100,8 @@ module TrinsicApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          sub_provider_id == o.sub_provider_id
+          sub_provider_id == o.sub_provider_id &&
+          billing_tracking_secret == o.billing_tracking_secret
     end
 
     # @see the `==` method
@@ -102,7 +113,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sub_provider_id].hash
+      [sub_provider_id, billing_tracking_secret].hash
     end
 
     # Builds the object from hash