Class: PinterestSdkClient::CatalogsReportDistributionStats

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CatalogsReportDistributionStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
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
146
147
148
149
150
151
152
153
154
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::CatalogsReportDistributionStats` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PinterestSdkClient::CatalogsReportDistributionStats`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'catalog_id')
    self.catalog_id = attributes[:'catalog_id']
  end

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  end

  if attributes.key?(:'code_label')
    self.code_label = attributes[:'code_label']
  end

  if attributes.key?(:'ineligible_for_ads')
    self.ineligible_for_ads = attributes[:'ineligible_for_ads']
  end

  if attributes.key?(:'ineligible_for_organic')
    self.ineligible_for_organic = attributes[:'ineligible_for_organic']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'occurrences')
    self.occurrences = attributes[:'occurrences']
  end

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

Instance Attribute Details

#catalog_id ⇒ Object

ID of the catalog entity.



19
20
21
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 19

def catalog_id
  @catalog_id
end

#code ⇒ Object

The event code that a diagnostics aggregated number references



22
23
24
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 22

def code
  @code
end

#code_label ⇒ Object

A human-friendly label for the event code (e.g, ‘SPAM’)



25
26
27
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 25

def code_label
  @code_label
end

#ineligible_for_ads ⇒ Object

Indicates if issue makes items ineligible for ads distribution



28
29
30
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 28

def ineligible_for_ads
  @ineligible_for_ads
end

#ineligible_for_organic ⇒ Object

Indicates if issue makes items ineligible for organic distribution



31
32
33
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 31

def ineligible_for_organic
  @ineligible_for_organic
end

#message ⇒ Object

Title message describing the diagnostic issue



34
35
36
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 34

def message
  @message
end

#occurrences ⇒ Object

Number of occurrences of the issue



37
38
39
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 37

def occurrences
  @occurrences
end

#report_type ⇒ Object

Returns the value of attribute report_type.



39
40
41
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 39

def report_type
  @report_type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 64

def self.attribute_map
  {
    :'catalog_id' => :'catalog_id',
    :'code' => :'code',
    :'code_label' => :'code_label',
    :'ineligible_for_ads' => :'ineligible_for_ads',
    :'ineligible_for_organic' => :'ineligible_for_organic',
    :'message' => :'message',
    :'occurrences' => :'occurrences',
    :'report_type' => :'report_type'
  }
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 234

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 88

def self.openapi_types
  {
    :'catalog_id' => :'String',
    :'code' => :'Integer',
    :'code_label' => :'String',
    :'ineligible_for_ads' => :'Boolean',
    :'ineligible_for_organic' => :'Boolean',
    :'message' => :'String',
    :'occurrences' => :'Integer',
    :'report_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      catalog_id == o.catalog_id &&
      code == o.code &&
      code_label == o.code_label &&
      ineligible_for_ads == o.ineligible_for_ads &&
      ineligible_for_organic == o.ineligible_for_organic &&
      message == o.message &&
      occurrences == o.occurrences &&
      report_type == o.report_type
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


221
222
223
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 227

def hash
  [catalog_id, code, code_label, ineligible_for_ads, ineligible_for_organic, message, occurrences, report_type].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



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 158

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d+$/)
  if !@catalog_id.nil? && @catalog_id !~ pattern
    invalid_properties.push("invalid value for \"catalog_id\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 256

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



171
172
173
174
175
176
177
 
# File 'lib/pinterest_sdk/models/catalogs_report_distribution_stats.rb', line 171

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@catalog_id.nil? && @catalog_id !~ Regexp.new(/^\d+$/)
  report_type_validator = EnumAttributeValidator.new('String', ["DISTRIBUTION_ISSUES"])
  return false unless report_type_validator.valid?(@report_type)
  true
end