Class: PinterestSdkClient::CustomerList

Inherits:
ApiModelBase show all
Defined in:
lib/pinterest_sdk/models/customer_list.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 = {}) ⇒ CustomerList

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 125

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PinterestSdkClient::CustomerList` 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::CustomerList`. 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?(:'ad_account_id')
    self. = attributes[:'ad_account_id']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ad_account_id ⇒ Object

Associated ad account ID.



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

def 
  
end

#created_time ⇒ Object

Creation time. Unix timestamp in seconds.



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

def created_time
  @created_time
end

#exceptions ⇒ Object

Customer list errors



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

def exceptions
  @exceptions
end

#id ⇒ Object

Customer list ID.



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

def id
  @id
end

#name ⇒ Object

Customer list name.



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

def name
  @name
end

#num_batches ⇒ Object

Total number of list updates. List creation counts as one batch. Each <a href="/docs/redoc/#operation/ads_v3_customer_list_add_handler_PUT">Append</a> or <a href="/docs/redoc/#operation/ads_v3_customer_list_remove_handler_PUT">Remove API</a> call counts as another. List creation via the Ads Manager UI could result in more than one batch since the UI breaks up large lists.



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

def num_batches
  @num_batches
end

#num_removed_user_records ⇒ Object

Number of removed user records. In a <a href="/docs/redoc/#operation/ads_v3_customer_list_remove_handler_PUT">Remove API</a> call, this counter increases even if the user is not found in the list.



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

def num_removed_user_records
  @num_removed_user_records
end

#num_uploaded_user_records ⇒ Object

Number of uploaded user records. In an <a href="/docs/redoc/#operation/ads_v3_customer_list_add_handler_PUT">Append API</a> call, this counter increases even if the uploaded user is already in the list.



40
41
42
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 40

def num_uploaded_user_records
  @num_uploaded_user_records
end

#status ⇒ Object

Customer list status. TOO_SMALL - the list has less than 100 Pinterest users.



43
44
45
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 43

def status
  @status
end

#type ⇒ Object

Always "customerlist".



46
47
48
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 46

def type
  @type
end

#updated_time ⇒ Object

Last update time. Unix timestamp in seconds.



49
50
51
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 49

def updated_time
  @updated_time
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



91
92
93
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 91

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 96

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 74

def self.attribute_map
  {
    :'ad_account_id' => :'ad_account_id',
    :'created_time' => :'created_time',
    :'exceptions' => :'exceptions',
    :'id' => :'id',
    :'name' => :'name',
    :'num_batches' => :'num_batches',
    :'num_removed_user_records' => :'num_removed_user_records',
    :'num_uploaded_user_records' => :'num_uploaded_user_records',
    :'status' => :'status',
    :'type' => :'type',
    :'updated_time' => :'updated_time'
  }
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 244

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



118
119
120
121
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 101

def self.openapi_types
  {
    :'ad_account_id' => :'String',
    :'created_time' => :'Float',
    :'exceptions' => :'Object',
    :'id' => :'String',
    :'name' => :'String',
    :'num_batches' => :'Float',
    :'num_removed_user_records' => :'Float',
    :'num_uploaded_user_records' => :'Float',
    :'status' => :'String',
    :'type' => :'String',
    :'updated_time' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      created_time == o.created_time &&
      exceptions == o.exceptions &&
      id == o.id &&
      name == o.name &&
      num_batches == o.num_batches &&
      num_removed_user_records == o.num_removed_user_records &&
      num_uploaded_user_records == o.num_uploaded_user_records &&
      status == o.status &&
      type == o.type &&
      updated_time == o.updated_time
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


231
232
233
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



237
238
239
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 237

def hash
  [, created_time, exceptions, id, name, num_batches, num_removed_user_records, num_uploaded_user_records, status, type, updated_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



186
187
188
189
190
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 186

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 266

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



194
195
196
197
198
199
 
# File 'lib/pinterest_sdk/models/customer_list.rb', line 194

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["PROCESSING", "READY", "TOO_SMALL", "UPLOADING"])
  return false unless status_validator.valid?(@status)
  true
end