Skip to content

Commit

Permalink
Upgrade after onfido-openapi-spec change 3a077c7
Browse files Browse the repository at this point in the history
  • Loading branch information
dvacca-onfido authored and github-actions[bot] committed May 27, 2024
1 parent 1ef520f commit 8494908
Show file tree
Hide file tree
Showing 3 changed files with 372 additions and 0 deletions.
1 change: 1 addition & 0 deletions lib/onfido.rb
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,7 @@
require 'onfido/models/sdk_token_response'
require 'onfido/models/task'
require 'onfido/models/task_item'
require 'onfido/models/timeline_file_reference'
require 'onfido/models/us_driving_licence_breakdown'
require 'onfido/models/us_driving_licence_breakdown_address'
require 'onfido/models/us_driving_licence_breakdown_address_breakdown'
Expand Down
132 changes: 132 additions & 0 deletions lib/onfido/api/default_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,69 @@ def create_check_with_http_info(check_builder, opts = {})
return data, status_code, headers
end

# Create Timeline File for Workflow Run
# Triggers the generation of the Timeline File for the designated Workflow Run.
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
# @param [Hash] opts the optional parameters
# @return [TimelineFileReference]
def create_timeline_file(workflow_run_id, opts = {})
data, _status_code, _headers = create_timeline_file_with_http_info(workflow_run_id, opts)
data
end

# Create Timeline File for Workflow Run
# Triggers the generation of the Timeline File for the designated Workflow Run.
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
# @param [Hash] opts the optional parameters
# @return [Array<(TimelineFileReference, Integer, Hash)>] TimelineFileReference data, response status code and response headers
def create_timeline_file_with_http_info(workflow_run_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: DefaultApi.create_timeline_file ...'
end
# verify the required parameter 'workflow_run_id' is set
if @api_client.config.client_side_validation && workflow_run_id.nil?
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.create_timeline_file"
end
# resource path
local_var_path = '/workflow_runs/{workflow_run_id}/timeline_file'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s))

# query parameters
query_params = opts[:query_params] || {}

# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])

# form parameters
form_params = opts[:form_params] || {}

# http body (model)
post_body = opts[:debug_body]

# return_type
return_type = opts[:debug_return_type] || 'TimelineFileReference'

# auth_names
auth_names = opts[:debug_auth_names] || ['Token']

new_options = opts.merge(
:operation => :"DefaultApi.create_timeline_file",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)

data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: DefaultApi#create_timeline_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end

# Create monitor
# Creates a new monitor for the applicant
# @param watchlist_monitor_builder [WatchlistMonitorBuilder]
Expand Down Expand Up @@ -2026,6 +2089,75 @@ def find_task_with_http_info(workflow_run_id, task_id, opts = {})
return data, status_code, headers
end

# Retrieve Timeline File for Workflow Run
# Retrieves the Timeline File for the designated Workflow Run.
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
# @param timeline_file_id [String] The unique identifier for the Timefile File.
# @param [Hash] opts the optional parameters
# @return [Error]
def find_timeline_file(workflow_run_id, timeline_file_id, opts = {})
data, _status_code, _headers = find_timeline_file_with_http_info(workflow_run_id, timeline_file_id, opts)
data
end

# Retrieve Timeline File for Workflow Run
# Retrieves the Timeline File for the designated Workflow Run.
# @param workflow_run_id [String] The unique identifier of the Workflow Run.
# @param timeline_file_id [String] The unique identifier for the Timefile File.
# @param [Hash] opts the optional parameters
# @return [Array<(Error, Integer, Hash)>] Error data, response status code and response headers
def find_timeline_file_with_http_info(workflow_run_id, timeline_file_id, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: DefaultApi.find_timeline_file ...'
end
# verify the required parameter 'workflow_run_id' is set
if @api_client.config.client_side_validation && workflow_run_id.nil?
fail ArgumentError, "Missing the required parameter 'workflow_run_id' when calling DefaultApi.find_timeline_file"
end
# verify the required parameter 'timeline_file_id' is set
if @api_client.config.client_side_validation && timeline_file_id.nil?
fail ArgumentError, "Missing the required parameter 'timeline_file_id' when calling DefaultApi.find_timeline_file"
end
# resource path
local_var_path = '/workflow_runs/{workflow_run_id}/timeline_file/{timeline_file_id}'.sub('{' + 'workflow_run_id' + '}', CGI.escape(workflow_run_id.to_s)).sub('{' + 'timeline_file_id' + '}', CGI.escape(timeline_file_id.to_s))

# query parameters
query_params = opts[:query_params] || {}

# header parameters
header_params = opts[:header_params] || {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])

# form parameters
form_params = opts[:form_params] || {}

# http body (model)
post_body = opts[:debug_body]

# return_type
return_type = opts[:debug_return_type] || 'Error'

# auth_names
auth_names = opts[:debug_auth_names] || ['Token']

new_options = opts.merge(
:operation => :"DefaultApi.find_timeline_file",
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => return_type
)

data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
if @api_client.config.debugging
@api_client.config.logger.debug "API called: DefaultApi#find_timeline_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end

# Retrieve monitor
# Retrieves a single monitor
# @param monitor_id [String] The watchlist monitor&#39;s unique identifier.
Expand Down
239 changes: 239 additions & 0 deletions lib/onfido/models/timeline_file_reference.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,239 @@
=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.5.0
=end

require 'date'
require 'time'

module Onfido
class TimelineFileReference
# The unique identifier for the Timefile File that will be created.
attr_accessor :workflow_timeline_file_id

# Link to access the Timefile File that will be created.
attr_accessor :href

# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'workflow_timeline_file_id' => :'workflow_timeline_file_id',
:'href' => :'href'
}
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
{
:'workflow_timeline_file_id' => :'String',
:'href' => :'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 `Onfido::TimelineFileReference` 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::TimelineFileReference`. 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?(:'workflow_timeline_file_id')
self.workflow_timeline_file_id = attributes[:'workflow_timeline_file_id']
else
self.workflow_timeline_file_id = nil
end

if attributes.key?(:'href')
self.href = attributes[:'href']
else
self.href = 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 @workflow_timeline_file_id.nil?
invalid_properties.push('invalid value for "workflow_timeline_file_id", workflow_timeline_file_id cannot be nil.')
end

if @href.nil?
invalid_properties.push('invalid value for "href", href 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 @workflow_timeline_file_id.nil?
return false if @href.nil?
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 &&
workflow_timeline_file_id == o.workflow_timeline_file_id &&
href == o.href
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
[workflow_timeline_file_id, href].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

0 comments on commit 8494908

Please sign in to comment.