class Plaid::CraCheckReportReadyWebhook
Fired when the Check Report are ready to be retrieved. Once this webhook has fired, the report will be available to retrieve for 24 hours.
Attributes
Specifies a list of products that have failed to generate for the report. Additional detail on what caused the failure can be found by calling the product /get endpoint.
A list of ‘item_ids` that is included in the Check Report.
Specifies a list of products that have successfully been generated for the report.
The ‘user_id` corresponding to the user the webhook has fired for.
‘CHECK_REPORT_READY`
‘CHECK_REPORT`
Public Class Methods
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 75 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 62 def self.attribute_map { :'webhook_type' => :'webhook_type', :'webhook_code' => :'webhook_code', :'user_id' => :'user_id', :'successful_products' => :'successful_products', :'failed_products' => :'failed_products', :'item_ids' => :'item_ids', :'environment' => :'environment' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 213 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
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 103 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::CraCheckReportReadyWebhook` 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 `Plaid::CraCheckReportReadyWebhook`. 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?(:'webhook_type') self.webhook_type = attributes[:'webhook_type'] end if attributes.key?(:'webhook_code') self.webhook_code = attributes[:'webhook_code'] end if attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] end if attributes.key?(:'successful_products') if (value = attributes[:'successful_products']).is_a?(Array) self.successful_products = value end end if attributes.key?(:'failed_products') if (value = attributes[:'failed_products']).is_a?(Array) self.failed_products = value end end if attributes.key?(:'item_ids') if (value = attributes[:'item_ids']).is_a?(Array) self.item_ids = value end end if attributes.key?(:'environment') self.environment = attributes[:'environment'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 93 def self.openapi_nullable Set.new([ :'successful_products', :'failed_products', :'item_ids', ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 80 def self.openapi_types { :'webhook_type' => :'String', :'webhook_code' => :'String', :'user_id' => :'String', :'successful_products' => :'Array<Products>', :'failed_products' => :'Array<Products>', :'item_ids' => :'Array<String>', :'environment' => :'WebhookEnvironmentValues' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 186 def ==(o) return true if self.equal?(o) self.class == o.class && webhook_type == o.webhook_type && webhook_code == o.webhook_code && user_id == o.user_id && successful_products == o.successful_products && failed_products == o.failed_products && item_ids == o.item_ids && environment == o.environment end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 244 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 = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 315 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
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
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 220 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 200 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 206 def hash [webhook_type, webhook_code, user_id, successful_products, failed_products, item_ids, environment].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 153 def list_invalid_properties invalid_properties = Array.new if @webhook_type.nil? invalid_properties.push('invalid value for "webhook_type", webhook_type cannot be nil.') end if @webhook_code.nil? invalid_properties.push('invalid value for "webhook_code", webhook_code cannot be nil.') end if @user_id.nil? invalid_properties.push('invalid value for "user_id", user_id cannot be nil.') end if @environment.nil? invalid_properties.push('invalid value for "environment", environment cannot be nil.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 297 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 285 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/cra_check_report_ready_webhook.rb, line 176 def valid? return false if @webhook_type.nil? return false if @webhook_code.nil? return false if @user_id.nil? return false if @environment.nil? true end
Check to see if the all the properties in the model are valid @return true if the model is valid