diff --git a/lib/onfido.rb b/lib/onfido.rb index 0cbd0cb..1cc8e86 100644 --- a/lib/onfido.rb +++ b/lib/onfido.rb @@ -37,7 +37,7 @@ require 'onfido/models/check_shared' require 'onfido/models/checks_list' require 'onfido/models/complete_task_builder' -require 'onfido/models/complete_task_builder_data' +require 'onfido/models/complete_task_data_builder' require 'onfido/models/consent_item' require 'onfido/models/consents_builder' require 'onfido/models/country_codes' @@ -231,6 +231,7 @@ require 'onfido/models/sdk_token_request' require 'onfido/models/sdk_token_response' require 'onfido/models/task' +require 'onfido/models/task_item' require 'onfido/models/us_driving_licence_breakdown' require 'onfido/models/us_driving_licence_breakdown_address' require 'onfido/models/us_driving_licence_breakdown_address_breakdown' diff --git a/lib/onfido/api/default_api.rb b/lib/onfido/api/default_api.rb index 362e9b6..ff20103 100644 --- a/lib/onfido/api/default_api.rb +++ b/lib/onfido/api/default_api.rb @@ -2927,7 +2927,7 @@ def list_reports_with_http_info(check_id, opts = {}) # The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. # @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Tasks belong. # @param [Hash] opts the optional parameters - # @return [Array] + # @return [Array] def list_tasks(workflow_run_id, opts = {}) data, _status_code, _headers = list_tasks_with_http_info(workflow_run_id, opts) data @@ -2937,7 +2937,7 @@ def list_tasks(workflow_run_id, opts = {}) # The tasks of a Workflow can be retrieved by calling this endpoint with the unique identifier of the Workflow Run. # @param workflow_run_id [String] The unique identifier of the Workflow Run to which the Tasks belong. # @param [Hash] opts the optional parameters - # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers def list_tasks_with_http_info(workflow_run_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DefaultApi.list_tasks ...' @@ -2964,7 +2964,7 @@ def list_tasks_with_http_info(workflow_run_id, opts = {}) post_body = opts[:debug_body] # return_type - return_type = opts[:debug_return_type] || 'Array' + return_type = opts[:debug_return_type] || 'Array' # auth_names auth_names = opts[:debug_auth_names] || ['Token'] diff --git a/lib/onfido/models/complete_task_builder.rb b/lib/onfido/models/complete_task_builder.rb index 76f155e..71e8e94 100644 --- a/lib/onfido/models/complete_task_builder.rb +++ b/lib/onfido/models/complete_task_builder.rb @@ -32,7 +32,7 @@ def self.acceptable_attributes # Attribute type mapping. def self.openapi_types { - :'data' => :'CompleteTaskBuilderData' + :'data' => :'CompleteTaskDataBuilder' } end diff --git a/lib/onfido/models/complete_task_builder_data.rb b/lib/onfido/models/complete_task_data_builder.rb similarity index 99% rename from lib/onfido/models/complete_task_builder_data.rb rename to lib/onfido/models/complete_task_data_builder.rb index c52208b..b6beaa9 100644 --- a/lib/onfido/models/complete_task_builder_data.rb +++ b/lib/onfido/models/complete_task_data_builder.rb @@ -15,7 +15,7 @@ module Onfido # The Task completion payload. - module CompleteTaskBuilderData + module CompleteTaskDataBuilder class << self # List of class defined in oneOf (OpenAPI v3) def openapi_one_of diff --git a/lib/onfido/models/task.rb b/lib/onfido/models/task.rb index 74d810f..bb5e256 100644 --- a/lib/onfido/models/task.rb +++ b/lib/onfido/models/task.rb @@ -18,9 +18,21 @@ class Task # The identifier for the Task. attr_accessor :id + # The workflow run id the task belongs to. + attr_accessor :workflow_run_id + # The identifier for the Task Definition. attr_accessor :task_def_id + # The task definition version. + attr_accessor :task_def_version + + # Input object with the fields used by the Task to execute. + attr_accessor :input + + # Output object with the fields produced by the Task execution. + attr_accessor :output + # The date and time when the Task was created. attr_accessor :created_at @@ -31,7 +43,11 @@ class Task def self.attribute_map { :'id' => :'id', + :'workflow_run_id' => :'workflow_run_id', :'task_def_id' => :'task_def_id', + :'task_def_version' => :'task_def_version', + :'input' => :'input', + :'output' => :'output', :'created_at' => :'created_at', :'updated_at' => :'updated_at' } @@ -46,7 +62,11 @@ def self.acceptable_attributes def self.openapi_types { :'id' => :'String', + :'workflow_run_id' => :'String', :'task_def_id' => :'String', + :'task_def_version' => :'String', + :'input' => :'Object', + :'output' => :'Object', :'created_at' => :'Time', :'updated_at' => :'Time' } @@ -55,6 +75,8 @@ def self.openapi_types # List of attributes with nullable: true def self.openapi_nullable Set.new([ + :'task_def_version', + :'output', ]) end @@ -77,10 +99,26 @@ def initialize(attributes = {}) self.id = attributes[:'id'] end + if attributes.key?(:'workflow_run_id') + self.workflow_run_id = attributes[:'workflow_run_id'] + end + if attributes.key?(:'task_def_id') self.task_def_id = attributes[:'task_def_id'] end + if attributes.key?(:'task_def_version') + self.task_def_version = attributes[:'task_def_version'] + end + + if attributes.key?(:'input') + self.input = attributes[:'input'] + end + + if attributes.key?(:'output') + self.output = attributes[:'output'] + end + if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end @@ -153,7 +191,11 @@ def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && + workflow_run_id == o.workflow_run_id && task_def_id == o.task_def_id && + task_def_version == o.task_def_version && + input == o.input && + output == o.output && created_at == o.created_at && updated_at == o.updated_at end @@ -167,7 +209,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, task_def_id, created_at, updated_at].hash + [id, workflow_run_id, task_def_id, task_def_version, input, output, created_at, updated_at].hash end # Builds the object from hash diff --git a/lib/onfido/models/task_item.rb b/lib/onfido/models/task_item.rb new file mode 100644 index 0000000..271d077 --- /dev/null +++ b/lib/onfido/models/task_item.rb @@ -0,0 +1,287 @@ +=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 TaskItem + # The identifier for the Task. + attr_accessor :id + + # The identifier for the Task Definition. + attr_accessor :task_def_id + + # The date and time when the Task was created. + attr_accessor :created_at + + # The date and time when the Task was last updated. + attr_accessor :updated_at + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'task_def_id' => :'task_def_id', + :'created_at' => :'created_at', + :'updated_at' => :'updated_at' + } + 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 + { + :'id' => :'String', + :'task_def_id' => :'String', + :'created_at' => :'Time', + :'updated_at' => :'Time' + } + 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::TaskItem` 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::TaskItem`. 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?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'task_def_id') + self.task_def_id = attributes[:'task_def_id'] + end + + if attributes.key?(:'created_at') + self.created_at = attributes[:'created_at'] + end + + if attributes.key?(:'updated_at') + self.updated_at = attributes[:'updated_at'] + 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 + pattern = Regexp.new(/^[0-9a-z-_]+$/) + if !@id.nil? && @id !~ pattern + invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.") + end + + pattern = Regexp.new(/^[0-9a-z-_]+$/) + if !@task_def_id.nil? && @task_def_id !~ pattern + invalid_properties.push("invalid value for \"task_def_id\", must conform to the pattern #{pattern}.") + 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 !@id.nil? && @id !~ Regexp.new(/^[0-9a-z-_]+$/) + return false if !@task_def_id.nil? && @task_def_id !~ Regexp.new(/^[0-9a-z-_]+$/) + true + end + + # Custom attribute writer method with validation + # @param [Object] id Value to be assigned + def id=(id) + if id.nil? + fail ArgumentError, 'id cannot be nil' + end + + pattern = Regexp.new(/^[0-9a-z-_]+$/) + if id !~ pattern + fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}." + end + + @id = id + end + + # Custom attribute writer method with validation + # @param [Object] task_def_id Value to be assigned + def task_def_id=(task_def_id) + if task_def_id.nil? + fail ArgumentError, 'task_def_id cannot be nil' + end + + pattern = Regexp.new(/^[0-9a-z-_]+$/) + if task_def_id !~ pattern + fail ArgumentError, "invalid value for \"task_def_id\", must conform to the pattern #{pattern}." + end + + @task_def_id = task_def_id + 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 && + id == o.id && + task_def_id == o.task_def_id && + created_at == o.created_at && + updated_at == o.updated_at + 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 + [id, task_def_id, created_at, updated_at].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<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\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