Class: AmznSpApi::ReportsApiModel::CreateReportSpecification

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

Overview

Information required to create the report.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateReportSpecification

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 58

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ReportsApiModel::CreateReportSpecification` 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::CreateReportSpecification`. 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

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

  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)

  return unless attributes.key?(:marketplace_ids)
  return unless (value = attributes[:marketplace_ids]).is_a?(Array)

  self.marketplace_ids = value
end

Instance Attribute Details

#data_end_time ⇒ Object

The end of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.



24
25
26
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 24

def data_end_time
  @data_end_time
end

#data_start_time ⇒ Object

The start of a date and time range, in ISO 8601 date time format, used for selecting the data to report. The default is now. The value must be prior to or equal to the current date and time. Not all report types make use of this.



21
22
23
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 21

def data_start_time
  @data_start_time
end

#marketplace_ids ⇒ Object

A list of marketplace identifiers. The report document’s contents will contain data for all of the specified marketplaces, unless the report type indicates otherwise.



27
28
29
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 27

def marketplace_ids
  @marketplace_ids
end

#report_options ⇒ Object

Returns the value of attribute report_options.



15
16
17
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 15

def report_options
  @report_options
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.



18
19
20
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 18

def report_type
  @report_type
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 30

def self.attribute_map
  {
    'report_options': :reportOptions,
    'report_type': :reportType,
    'data_start_time': :dataStartTime,
    'data_end_time': :dataEndTime,
    'marketplace_ids': :marketplaceIds
  }
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



130
131
132
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 130

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



52
53
54
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 52

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

.openapi_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 41

def self.openapi_types
  {
    'report_options': :Object,
    'report_type': :Object,
    'data_start_time': :Object,
    'data_end_time': :Object,
    'marketplace_ids': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 104

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

  self.class == other.class &&
    report_options == other.report_options &&
    report_type == other.report_type &&
    data_start_time == other.data_start_time &&
    data_end_time == other.data_end_time &&
    marketplace_ids == other.marketplace_ids
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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 159

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



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

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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 137

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


117
118
119
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



123
124
125
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 123

def hash
  [report_options, report_type, data_start_time, data_end_time, marketplace_ids].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



84
85
86
87
88
89
90
91
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 84

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

  invalid_properties.push('invalid value for "marketplace_ids", marketplace_ids cannot be nil.') if @marketplace_ids.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



204
205
206
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 204

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



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 210

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



198
199
200
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 198

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



95
96
97
98
99
100
 
# File 'lib/reports_api_model/models/create_report_specification.rb', line 95

def valid?
  return false if @report_type.nil?
  return false if @marketplace_ids.nil?

  true
end