Class: AmznSpApi::ReportsApiModel::ReportSchedule

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

Overview

Detailed information about a report schedule.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportSchedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 63

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::ReportsApiModel::ReportSchedule` 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::ReportSchedule`. 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_schedule_id = attributes[:report_schedule_id] if attributes.key?(:report_schedule_id)

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

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

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

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

  return unless attributes.key?(:next_report_creation_time)

  self.next_report_creation_time = attributes[:next_report_creation_time]
end

Instance Attribute Details

#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.



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

def marketplace_ids
  @marketplace_ids
end

#next_report_creation_time ⇒ Object

The date and time when the schedule will create its next report, in ISO 8601 date time format.



30
31
32
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 30

def next_report_creation_time
  @next_report_creation_time
end

#period ⇒ Object

An ISO 8601 period value that indicates how often a report should be created.



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

def period
  @period
end

#report_options ⇒ Object

Returns the value of attribute report_options.



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

def report_options
  @report_options
end

#report_schedule_id ⇒ Object

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



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

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.



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

def report_type
  @report_type
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 33

def self.attribute_map
  {
    'report_schedule_id': :reportScheduleId,
    'report_type': :reportType,
    'marketplace_ids': :marketplaceIds,
    'report_options': :reportOptions,
    'period': :period,
    'next_report_creation_time': :nextReportCreationTime
  }
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



142
143
144
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 142

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



57
58
59
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 45

def self.openapi_types
  {
    'report_schedule_id': :Object,
    'report_type': :Object,
    'marketplace_ids': :Object,
    'report_options': :Object,
    'period': :Object,
    'next_report_creation_time': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 115

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

  self.class == other.class &&
    report_schedule_id == other.report_schedule_id &&
    report_type == other.report_type &&
    marketplace_ids == other.marketplace_ids &&
    report_options == other.report_options &&
    period == other.period &&
    next_report_creation_time == other.next_report_creation_time
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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 171

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



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 240

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 149

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


129
130
131
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 129

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



135
136
137
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 135

def hash
  [report_schedule_id, report_type, marketplace_ids, report_options, period, next_report_creation_time].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



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 92

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "report_schedule_id", report_schedule_id cannot be nil.') if @report_schedule_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 "period", period cannot be nil.') if @period.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



216
217
218
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 216

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



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 222

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



210
211
212
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 210

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



105
106
107
108
109
110
111
 
# File 'lib/reports_api_model/models/report_schedule.rb', line 105

def valid?
  return false if @report_schedule_id.nil?
  return false if @report_type.nil?
  return false if @period.nil?

  true
end