Class: AmznSpApi::ReportsApiModel::Report

Inherits:
Object
  • Object
show all
Defined in:
lib/reports_api_model/models/report.rb

Overview

Detailed information about the report.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Report

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/reports_api_model/models/report.rb', line 110

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ReportsApiModel::Report` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::ReportsApiModel::Report`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  if attributes.key?(:marketplace_ids) && (value = attributes[:marketplace_ids]).is_a?(Array)
    self.marketplace_ids = value
  end

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:report_document_id)

  self.report_document_id = attributes[:report_document_id]
end

Instance Attribute Details

#created_time ⇒ Object

The date and time when the report was created.



34
35
36
 
# File 'lib/reports_api_model/models/report.rb', line 34

def created_time
  @created_time
end

#data_end_time ⇒ Object

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



28
29
30
 
# File 'lib/reports_api_model/models/report.rb', line 28

def data_end_time
  @data_end_time
end

#data_start_time ⇒ Object

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



25
26
27
 
# File 'lib/reports_api_model/models/report.rb', line 25

def data_start_time
  @data_start_time
end

#marketplace_ids ⇒ Object

A list of marketplace identifiers for the report.



16
17
18
 
# File 'lib/reports_api_model/models/report.rb', line 16

def marketplace_ids
  @marketplace_ids
end

#processing_end_time ⇒ Object

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



43
44
45
 
# File 'lib/reports_api_model/models/report.rb', line 43

def processing_end_time
  @processing_end_time
end

#processing_start_time ⇒ Object

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



40
41
42
 
# File 'lib/reports_api_model/models/report.rb', line 40

def processing_start_time
  @processing_start_time
end

#processing_status ⇒ Object

The processing status of the report.



37
38
39
 
# File 'lib/reports_api_model/models/report.rb', line 37

def processing_status
  @processing_status
end

#report_document_id ⇒ Object

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



46
47
48
 
# File 'lib/reports_api_model/models/report.rb', line 46

def report_document_id
  @report_document_id
end

#report_id ⇒ Object

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



19
20
21
 
# File 'lib/reports_api_model/models/report.rb', line 19

def report_id
  @report_id
end

#report_schedule_id ⇒ Object

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



31
32
33
 
# File 'lib/reports_api_model/models/report.rb', line 31

def report_schedule_id
  @report_schedule_id
end

#report_type ⇒ Object

The report type. Refer to [Report Type Values](developer-docs.amazon.com/sp-api/docs/report-type-values) for more information.



22
23
24
 
# File 'lib/reports_api_model/models/report.rb', line 22

def report_type
  @report_type
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/reports_api_model/models/report.rb', line 70

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



219
220
221
 
# File 'lib/reports_api_model/models/report.rb', line 219

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
 
# File 'lib/reports_api_model/models/report.rb', line 104

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/reports_api_model/models/report.rb', line 87

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/reports_api_model/models/report.rb', line 187

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    marketplace_ids == other.marketplace_ids &&
    report_id == other.report_id &&
    report_type == other.report_type &&
    data_start_time == other.data_start_time &&
    data_end_time == other.data_end_time &&
    report_schedule_id == other.report_schedule_id &&
    created_time == other.created_time &&
    processing_status == other.processing_status &&
    processing_start_time == other.processing_start_time &&
    processing_end_time == other.processing_end_time &&
    report_document_id == other.report_document_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/reports_api_model/models/report.rb', line 248

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
    AmznSpApi::ReportsApiModel.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/reports_api_model/models/report.rb', line 317

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/reports_api_model/models/report.rb', line 226

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/reports_api_model/models/report.rb', line 206

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/reports_api_model/models/report.rb', line 212

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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/reports_api_model/models/report.rb', line 149

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "report_id", report_id cannot be nil.') if @report_id.nil?

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



293
294
295
 
# File 'lib/reports_api_model/models/report.rb', line 293

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/reports_api_model/models/report.rb', line 299

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



287
288
289
 
# File 'lib/reports_api_model/models/report.rb', line 287

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/reports_api_model/models/report.rb', line 164

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', %w[CANCELLED DONE FATAL IN_PROGRESS IN_QUEUE])
  return false unless processing_status_validator.valid?(@processing_status)

  true
end