class CyberSource::ReportingV3ReportsGet200ResponseReportSearchResults

Report Search Result Bean

Attributes

group_id[RW]

Id for selected group.

organization_id[RW]

CyberSource Merchant Id

queued_time[RW]

Specifies the time of the report in queued in ISO 8601 format

report_completed_time[RW]

Specifies the time of the report completed the generation in ISO 8601 format

report_definition_id[RW]

Unique Report Identifier of each report type

report_end_time[RW]

Specifies the report end time in ISO 8601 format

report_frequency[RW]

Frequency of the report to get generated Valid Values: - DAILY - WEEKLY - MONTHLY - ADHOC

report_generating_time[RW]

Specifies the time of the report started to generate in ISO 8601 format

report_id[RW]

Unique identifier generated for every reports

report_mime_type[RW]

Format of the report to get generated Valid Values: - application/xml - text/csv

report_name[RW]

Name of the report specified by merchant while creating the report

report_start_time[RW]

Specifies the report start time in ISO 8601 format

status[RW]

Status of the report Valid Values: - COMPLETED - PENDING - QUEUED - RUNNING - ERROR - NO_DATA

subscription_type[RW]

Specifies whether the subscription created is either Custom, Standard or Classic

timezone[RW]

Time Zone

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 66
def self.attribute_map
  {
    :'_link' => :'_link',
    :'report_definition_id' => :'reportDefinitionId',
    :'report_name' => :'reportName',
    :'report_mime_type' => :'reportMimeType',
    :'report_frequency' => :'reportFrequency',
    :'status' => :'status',
    :'report_start_time' => :'reportStartTime',
    :'report_end_time' => :'reportEndTime',
    :'timezone' => :'timezone',
    :'report_id' => :'reportId',
    :'organization_id' => :'organizationId',
    :'queued_time' => :'queuedTime',
    :'report_generating_time' => :'reportGeneratingTime',
    :'report_completed_time' => :'reportCompletedTime',
    :'subscription_type' => :'subscriptionType',
    :'group_id' => :'groupId'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 111
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'_link')
    self._link = attributes[:'_link']
  end

  if attributes.has_key?(:'reportDefinitionId')
    self.report_definition_id = attributes[:'reportDefinitionId']
  end

  if attributes.has_key?(:'reportName')
    self.report_name = attributes[:'reportName']
  end

  if attributes.has_key?(:'reportMimeType')
    self.report_mime_type = attributes[:'reportMimeType']
  end

  if attributes.has_key?(:'reportFrequency')
    self.report_frequency = attributes[:'reportFrequency']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'reportStartTime')
    self.report_start_time = attributes[:'reportStartTime']
  end

  if attributes.has_key?(:'reportEndTime')
    self.report_end_time = attributes[:'reportEndTime']
  end

  if attributes.has_key?(:'timezone')
    self.timezone = attributes[:'timezone']
  end

  if attributes.has_key?(:'reportId')
    self.report_id = attributes[:'reportId']
  end

  if attributes.has_key?(:'organizationId')
    self.organization_id = attributes[:'organizationId']
  end

  if attributes.has_key?(:'queuedTime')
    self.queued_time = attributes[:'queuedTime']
  end

  if attributes.has_key?(:'reportGeneratingTime')
    self.report_generating_time = attributes[:'reportGeneratingTime']
  end

  if attributes.has_key?(:'reportCompletedTime')
    self.report_completed_time = attributes[:'reportCompletedTime']
  end

  if attributes.has_key?(:'subscriptionType')
    self.subscription_type = attributes[:'subscriptionType']
  end

  if attributes.has_key?(:'groupId')
    self.group_id = attributes[:'groupId']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 88
def self.swagger_types
  {
    :'_link' => :'ReportingV3ReportsGet200ResponseLink',
    :'report_definition_id' => :'String',
    :'report_name' => :'String',
    :'report_mime_type' => :'String',
    :'report_frequency' => :'String',
    :'status' => :'String',
    :'report_start_time' => :'DateTime',
    :'report_end_time' => :'DateTime',
    :'timezone' => :'String',
    :'report_id' => :'String',
    :'organization_id' => :'String',
    :'queued_time' => :'DateTime',
    :'report_generating_time' => :'DateTime',
    :'report_completed_time' => :'DateTime',
    :'subscription_type' => :'String',
    :'group_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 197
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _link == o._link &&
      report_definition_id == o.report_definition_id &&
      report_name == o.report_name &&
      report_mime_type == o.report_mime_type &&
      report_frequency == o.report_frequency &&
      status == o.status &&
      report_start_time == o.report_start_time &&
      report_end_time == o.report_end_time &&
      timezone == o.timezone &&
      report_id == o.report_id &&
      organization_id == o.organization_id &&
      queued_time == o.queued_time &&
      report_generating_time == o.report_generating_time &&
      report_completed_time == o.report_completed_time &&
      subscription_type == o.subscription_type &&
      group_id == o.group_id
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 254
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 320
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 233
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 220
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 226
def hash
  [_link, report_definition_id, report_name, report_mime_type, report_frequency, status, report_start_time, report_end_time, timezone, report_id, organization_id, queued_time, report_generating_time, report_completed_time, subscription_type, group_id].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 184
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 300
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 306
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 294
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/reporting_v3_reports_get200_response_report_search_results.rb, line 191
def valid?
  true
end