Class: AmznSpApi::ReportsApiModel::ReportDocument

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

Overview

Information required for the report document.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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

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

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

  return unless attributes.key?(:compression_algorithm)

  self.compression_algorithm = attributes[:compression_algorithm]
end

Instance Attribute Details

#compression_algorithm ⇒ Object

If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to [Step 2. Download the report](doc:reports-api-v2021-06-30-retrieve-a-report#step-2-download-the-report) in the use case guide, where sample code is provided.



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

def compression_algorithm
  @compression_algorithm
end

#report_document_id ⇒ Object

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



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

def report_document_id
  @report_document_id
end

#url ⇒ Object

A presigned URL for the report document. If ‘compressionAlgorithm` is not returned, you can download the report directly from this URL. This URL expires after 5 minutes.



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

def url
  @url
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
 
# File 'lib/reports_api_model/models/report_document.rb', line 46

def self.attribute_map
  {
    'report_document_id': :reportDocumentId,
    'url': :url,
    'compression_algorithm': :compressionAlgorithm
  }
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



147
148
149
 
# File 'lib/reports_api_model/models/report_document.rb', line 147

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
 
# File 'lib/reports_api_model/models/report_document.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
 
# File 'lib/reports_api_model/models/report_document.rb', line 55

def self.openapi_types
  {
    'report_document_id': :Object,
    'url': :Object,
    'compression_algorithm': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



123
124
125
126
127
128
129
130
 
# File 'lib/reports_api_model/models/report_document.rb', line 123

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

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



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
207
208
209
210
211
 
# File 'lib/reports_api_model/models/report_document.rb', line 176

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



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

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/reports_api_model/models/report_document.rb', line 154

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


134
135
136
 
# File 'lib/reports_api_model/models/report_document.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



140
141
142
 
# File 'lib/reports_api_model/models/report_document.rb', line 140

def hash
  [report_document_id, url, compression_algorithm].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



91
92
93
94
95
96
97
98
 
# File 'lib/reports_api_model/models/report_document.rb', line 91

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

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



221
222
223
 
# File 'lib/reports_api_model/models/report_document.rb', line 221

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



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

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



215
216
217
 
# File 'lib/reports_api_model/models/report_document.rb', line 215

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



102
103
104
105
106
107
108
109
110
 
# File 'lib/reports_api_model/models/report_document.rb', line 102

def valid?
  return false if @report_document_id.nil?
  return false if @url.nil?

  compression_algorithm_validator = EnumAttributeValidator.new('Object', ['GZIP'])
  return false unless compression_algorithm_validator.valid?(@compression_algorithm)

  true
end