Class: AmznSpApi::ReportsApiModel::CreateReportScheduleSpecification

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateReportScheduleSpecification

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 78

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



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

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.



26
27
28
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 26

def next_report_creation_time
  @next_report_creation_time
end

#period ⇒ Object

One of a set of predefined ISO 8601 periods that specifies how often a report should be created.



23
24
25
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 23

def period
  @period
end

#report_options ⇒ Object

Returns the value of attribute report_options.



20
21
22
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 20

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.



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

def report_type
  @report_type
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 50

def self.attribute_map
  {
    '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



166
167
168
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 166

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 61

def self.openapi_types
  {
    '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



140
141
142
143
144
145
146
147
148
149
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 140

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

  self.class == other.class &&
    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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 195

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



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 264

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 173

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


153
154
155
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 153

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



159
160
161
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 159

def hash
  [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



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

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



240
241
242
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 240

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 246

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



234
235
236
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 234

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



118
119
120
121
122
123
124
125
126
127
 
# File 'lib/reports_api_model/models/create_report_schedule_specification.rb', line 118

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

  period_validator = EnumAttributeValidator.new('Object', %w[PT5M PT15M PT30M PT1H PT2H PT4H PT8H PT12H P1D P2D P3D PT84H P7D P14D P15D P18D P30D P1M])
  return false unless period_validator.valid?(@period)

  true
end