class AmzSpApi::ReportsApiModel::Report

Attributes

created_time[RW]

The date and time when the report was created.

data_end_time[RW]

The end of a date and time range used for selecting the data to report.

data_start_time[RW]

The start of a date and time range used for selecting the data to report.

marketplace_ids[RW]

A list of marketplace identifiers for the report.

processing_end_time[RW]

The date and time when the report processing completed, in ISO 8601 date time format.

processing_start_time[RW]

The date and time when the report processing started, in ISO 8601 date time format.

processing_status[RW]

The processing status of the report.

report_document_id[RW]

The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve and decrypt the report document's contents.

report_id[RW]

The identifier for the report. This identifier is unique only in combination with a seller ID.

report_schedule_id[RW]

The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID.

report_type[RW]

The report type.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/reports-api-model/models/report.rb, line 72
def self.attribute_map
  {
    :'marketplace_ids' => :'marketplaceIds',
    :'report_id' => :'reportId',
    :'report_type' => :'reportType',
    :'data_start_time' => :'dataStartTime',
    :'data_end_time' => :'dataEndTime',
    :'report_schedule_id' => :'reportScheduleId',
    :'created_time' => :'createdTime',
    :'processing_status' => :'processingStatus',
    :'processing_start_time' => :'processingStartTime',
    :'processing_end_time' => :'processingEndTime',
    :'report_document_id' => :'reportDocumentId'
  }
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/reports-api-model/models/report.rb, line 251
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/reports-api-model/models/report.rb, line 113
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::ReportsApiModel::Report` 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 `AmzSpApi::ReportsApiModel::Report`. 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?(:'marketplace_ids')
    if (value = attributes[:'marketplace_ids']).is_a?(Array)
      self.marketplace_ids = value
    end
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'report_document_id')
    self.report_document_id = attributes[:'report_document_id']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/reports-api-model/models/report.rb, line 106
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/reports-api-model/models/report.rb, line 89
def self.openapi_types
  {
    :'marketplace_ids' => :'Object',
    :'report_id' => :'Object',
    :'report_type' => :'Object',
    :'data_start_time' => :'Object',
    :'data_end_time' => :'Object',
    :'report_schedule_id' => :'Object',
    :'created_time' => :'Object',
    :'processing_status' => :'Object',
    :'processing_start_time' => :'Object',
    :'processing_end_time' => :'Object',
    :'report_document_id' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/reports-api-model/models/report.rb, line 220
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      marketplace_ids == o.marketplace_ids &&
      report_id == o.report_id &&
      report_type == o.report_type &&
      data_start_time == o.data_start_time &&
      data_end_time == o.data_end_time &&
      report_schedule_id == o.report_schedule_id &&
      created_time == o.created_time &&
      processing_status == o.processing_status &&
      processing_start_time == o.processing_start_time &&
      processing_end_time == o.processing_end_time &&
      report_document_id == o.report_document_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/reports-api-model/models/report.rb, line 281
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
    AmzSpApi::ReportsApiModel.const_get(type).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/reports-api-model/models/report.rb, line 350
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/reports-api-model/models/report.rb, line 258
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end
eql?(o) click to toggle source

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

# File lib/reports-api-model/models/report.rb, line 238
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/reports-api-model/models/report.rb, line 244
def hash
  [marketplace_ids, report_id, report_type, data_start_time, data_end_time, report_schedule_id, created_time, processing_status, processing_start_time, processing_end_time, report_document_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/reports-api-model/models/report.rb, line 175
def list_invalid_properties
  invalid_properties = Array.new
  if @report_id.nil?
    invalid_properties.push('invalid value for "report_id", report_id cannot be nil.')
  end

  if @report_type.nil?
    invalid_properties.push('invalid value for "report_type", report_type cannot be nil.')
  end

  if @created_time.nil?
    invalid_properties.push('invalid value for "created_time", created_time cannot be nil.')
  end

  if @processing_status.nil?
    invalid_properties.push('invalid value for "processing_status", processing_status cannot be nil.')
  end

  invalid_properties
end
processing_status=(processing_status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] processing_status Object to be assigned

# File lib/reports-api-model/models/report.rb, line 210
def processing_status=(processing_status)
  validator = EnumAttributeValidator.new('Object', ['CANCELLED', 'DONE', 'FATAL', 'IN_PROGRESS', 'IN_QUEUE'])
  unless validator.valid?(processing_status)
    fail ArgumentError, "invalid value for \"processing_status\", must be one of #{validator.allowable_values}."
  end
  @processing_status = processing_status
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/reports-api-model/models/report.rb, line 326
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/reports-api-model/models/report.rb, line 332
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
to_s() click to toggle source

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

# File lib/reports-api-model/models/report.rb, line 320
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/reports-api-model/models/report.rb, line 198
def valid?
  return false if @report_id.nil?
  return false if @report_type.nil?
  return false if @created_time.nil?
  return false if @processing_status.nil?
  processing_status_validator = EnumAttributeValidator.new('Object', ['CANCELLED', 'DONE', 'FATAL', 'IN_PROGRESS', 'IN_QUEUE'])
  return false unless processing_status_validator.valid?(@processing_status)
  true
end