Skip to content

Commit

Permalink
Upgrade after onfido-openapi-spec change 47c86fa
Browse files Browse the repository at this point in the history
  • Loading branch information
dvacca-onfido authored and github-actions[bot] committed Jun 13, 2024
1 parent be4ca36 commit 0538246
Show file tree
Hide file tree
Showing 12 changed files with 946 additions and 20 deletions.
9 changes: 9 additions & 0 deletions .release.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"source": {
"repo_url": "https://github.com/onfido/onfido-openapi-spec",
"short_sha": "47c86fa",
"long_sha": "47c86fa6e15fe0a5d60afd54988a59fdcb5e2135",
"version": ""
},
"release": "v3.0.0-pre"
}
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Webhook events payload needs to be verified before it can be accessed. Library a

## Contributing

This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) - version: 7.6.0; therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.
This library is automatically generated using [OpenAPI Generator](https://openapi-generator.tech) (version: 7.6.0); therefore all the contributions, except tests files, should target [Onfido OpenAPI specification repository](https://github.com/onfido/onfido-openapi-spec/tree/master) instead of this repository.

For contributions to the tests instead, please follow the steps below:

Expand All @@ -97,11 +97,28 @@ For contributions to the tests instead, please follow the steps below:
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request

## Versioning policy

[Semantic Versioning](https://semver.org) policy is used for library versioning, following guidelines and limitations below:

- MAJOR versions (x.0.0) might:
- target a new API version
- include non-backward compatible change
- MINOR versions (0.x.0) might:
- add a new functionality, non-mandatory parameter or property
- deprecate an old functionality
- include non-backward compatible change to a functionality which is:
- labelled as alpha or beta
- completely broken and not usable
- PATCH version (0.0.x) might:
- fix a bug
- include backward compatible changes only

## More documentation

More documentation and code examples can be found at <https://documentation.onfido.com>.

## Support

Should you encounter any technical issues during integration, please contact Onfido's Customer Support team
via the [Customer Experience Portal](https://public.support.onfido.com/) which also includes support documentation.
Should you encounter any technical issues during integration, please contact Onfido's Customer Support team via the [Customer Experience Portal](https://public.support.onfido.com/) which also includes support documentation.

4 changes: 4 additions & 0 deletions lib/onfido.rb
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
require 'onfido/models/facial_similarity_motion_breakdown_visual_authenticity'
require 'onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown'
require 'onfido/models/facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection'
require 'onfido/models/facial_similarity_motion_properties'
require 'onfido/models/facial_similarity_motion_report'
require 'onfido/models/facial_similarity_photo_breakdown'
require 'onfido/models/facial_similarity_photo_breakdown_face_comparison'
Expand All @@ -145,7 +146,9 @@
require 'onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity'
require 'onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown'
require 'onfido/models/facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity'
require 'onfido/models/facial_similarity_photo_fully_auto_properties'
require 'onfido/models/facial_similarity_photo_fully_auto_report'
require 'onfido/models/facial_similarity_photo_properties'
require 'onfido/models/facial_similarity_photo_report'
require 'onfido/models/facial_similarity_video_breakdown'
require 'onfido/models/facial_similarity_video_breakdown_face_comparison'
Expand All @@ -157,6 +160,7 @@
require 'onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown'
require 'onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected'
require 'onfido/models/facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection'
require 'onfido/models/facial_similarity_video_properties'
require 'onfido/models/facial_similarity_video_report'
require 'onfido/models/id_number'
require 'onfido/models/id_photo'
Expand Down
2 changes: 1 addition & 1 deletion lib/onfido/api_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class ApiClient
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
def initialize(config = Configuration.default)
@config = config
@user_agent = "onfido-ruby/3.0.0"
@user_agent = "onfido-ruby/3.0.0-pre"
@default_headers = {
'Content-Type' => 'application/json',
'User-Agent' => @user_agent
Expand Down
215 changes: 215 additions & 0 deletions lib/onfido/models/facial_similarity_motion_properties.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,215 @@
=begin
#Onfido API v3.6
#The Onfido API (v3.6)
The version of the OpenAPI document: v3.6
Generated by: https://openapi-generator.tech
Generator version: 7.6.0
=end

require 'date'
require 'time'

module Onfido
class FacialSimilarityMotionProperties
# A floating point number between 0 and 1. The closer the score is to 0, the more likely it is to be a spoof (i.e. videos of digital screens, masks or print-outs). Conversely, the closer it is to 1, the less likely it is to be a spoof.
attr_accessor :score

# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'score' => :'score'
}
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
{
:'score' => :'Float'
}
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 `Onfido::FacialSimilarityMotionProperties` 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 `Onfido::FacialSimilarityMotionProperties`. 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?(:'score')
self.score = attributes[:'score']
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 &&
score == o.score
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
[score].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 = Onfido.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
17 changes: 13 additions & 4 deletions lib/onfido/models/facial_similarity_motion_report.rb
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ class FacialSimilarityMotionReport

attr_accessor :breakdown

attr_accessor :properties

class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
Expand Down Expand Up @@ -74,7 +76,8 @@ def self.attribute_map
:'check_id' => :'check_id',
:'documents' => :'documents',
:'name' => :'name',
:'breakdown' => :'breakdown'
:'breakdown' => :'breakdown',
:'properties' => :'properties'
}
end

Expand All @@ -95,7 +98,8 @@ def self.openapi_types
:'check_id' => :'String',
:'documents' => :'Array<ReportDocument>',
:'name' => :'ReportName',
:'breakdown' => :'FacialSimilarityMotionBreakdown'
:'breakdown' => :'FacialSimilarityMotionBreakdown',
:'properties' => :'FacialSimilarityMotionProperties'
}
end

Expand Down Expand Up @@ -172,6 +176,10 @@ def initialize(attributes = {})
if attributes.key?(:'breakdown')
self.breakdown = attributes[:'breakdown']
end

if attributes.key?(:'properties')
self.properties = attributes[:'properties']
end
end

# Show invalid properties with the reasons. Usually used together with valid?
Expand Down Expand Up @@ -213,7 +221,8 @@ def ==(o)
check_id == o.check_id &&
documents == o.documents &&
name == o.name &&
breakdown == o.breakdown
breakdown == o.breakdown &&
properties == o.properties
end

# @see the `==` method
Expand All @@ -225,7 +234,7 @@ def eql?(o)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[id, created_at, href, status, result, sub_result, check_id, documents, name, breakdown].hash
[id, created_at, href, status, result, sub_result, check_id, documents, name, breakdown, properties].hash
end

# Builds the object from hash
Expand Down
Loading

0 comments on commit 0538246

Please sign in to comment.