Class: Pipedrive::ProductField

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/models/product_field.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductField

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 157

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_flag ⇒ Object

Whether or not the Product Field is currently active



45
46
47
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 45

def active_flag
  @active_flag
end

#add_time ⇒ Object

The Product Field creation time. Format: YYYY-MM-DD HH:MM:SS



36
37
38
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 36

def add_time
  @add_time
end

#add_visible_flag ⇒ Object

Whether or not the Product Field is visible in the Add Product Modal



51
52
53
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 51

def add_visible_flag
  @add_visible_flag
end

#bulk_edit_allowed ⇒ Object

Whether or not the Product Field data can be edited



57
58
59
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 57

def bulk_edit_allowed
  @bulk_edit_allowed
end

#edit_flag ⇒ Object

Whether or not the Product Field Name and metadata is editable



48
49
50
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 48

def edit_flag
  @edit_flag
end

#field_type ⇒ Object

Type of the field.<dl class="fields-list"><dt>varchar</dt><dd>Text (up to 255 characters)</dd><dt>varchar_auto</dt><dd>Autocomplete text (up to 255 characters)</dd><dt>text</dt><dd>Long text (up to 65k characters)</dd><dt>double</dt><dd>Numeric value</dd><dt>monetary</dt><dd>Monetary field (has a numeric value and a currency value)</dd><dt>date</dt><dd>Date (format YYYY-MM-DD)</dd><dt>set</dt><dd>Options field with a possibility of having multiple chosen options</dd><dt>enum</dt><dd>Options field with a single possible chosen option</dd><dt>user</dt><dd>User field (contains a user ID of another Pipedrive user)</dd><dt>org</dt><dd>Organization field (contains an organization ID which is stored on the same account)</dd><dt>people</dt><dd>Person field (contains a product ID which is stored on the same account)</dd><dt>phone</dt><dd>Phone field (up to 255 numbers and/or characters)</dd><dt>time</dt><dd>Time field (format HH:MM:SS)</dd><dt>timerange</dt><dd>Time-range field (has a start time and end time value, both HH:MM:SS)</dd><dt>daterange</dt><dd>Date-range field (has a start date and end date value, both YYYY-MM-DD)</dd><dt>address</dt><dd>Address field (autocompleted by Google Maps)</dd></dl>



24
25
26
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 24

def field_type
  @field_type
end

#filtering_allowed ⇒ Object

Whether or not the Product Field value can be used when filtering searches



63
64
65
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 63

def filtering_allowed
  @filtering_allowed
end

#id ⇒ Object

The ID of the Product Field



27
28
29
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 27

def id
  @id
end

#important_flag ⇒ Object

Whether or not the Product Field is marked as important



54
55
56
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 54

def important_flag
  @important_flag
end

#key ⇒ Object

The key of the Product Field



30
31
32
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 30

def key
  @key
end

#last_updated_by_user_id ⇒ Object

The ID of the last user to update the Product Field



42
43
44
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 42

def last_updated_by_user_id
  @last_updated_by_user_id
end

#mandatory_flag ⇒ Object

Whether or not the Product Field is mandatory when creating products



69
70
71
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 69

def mandatory_flag
  @mandatory_flag
end

#name ⇒ Object

Name of the field



18
19
20
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 18

def name
  @name
end

#options ⇒ Object

When field_type is either set or enum, possible options must be supplied as a JSON-encoded sequential array, for example: ["red","blue","lilac"]



21
22
23
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 21

def options
  @options
end

#order_nr ⇒ Object

Position (index) of the Product Field in the detail view



33
34
35
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 33

def order_nr
  @order_nr
end

#searchable_flag ⇒ Object

Whether or not the Product Field is searchable



60
61
62
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 60

def searchable_flag
  @searchable_flag
end

#sortable_flag ⇒ Object

Whether or not the Product Field is sortable



66
67
68
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 66

def sortable_flag
  @sortable_flag
end

#update_time ⇒ Object

The Product Field last update time. Format: YYYY-MM-DD HH:MM:SS



39
40
41
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 39

def update_time
  @update_time
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 94

def self.attribute_map
  {
    :'name' => :'name',
    :'options' => :'options',
    :'field_type' => :'field_type',
    :'id' => :'id',
    :'key' => :'key',
    :'order_nr' => :'order_nr',
    :'add_time' => :'add_time',
    :'update_time' => :'update_time',
    :'last_updated_by_user_id' => :'last_updated_by_user_id',
    :'active_flag' => :'active_flag',
    :'edit_flag' => :'edit_flag',
    :'add_visible_flag' => :'add_visible_flag',
    :'important_flag' => :'important_flag',
    :'bulk_edit_allowed' => :'bulk_edit_allowed',
    :'searchable_flag' => :'searchable_flag',
    :'filtering_allowed' => :'filtering_allowed',
    :'sortable_flag' => :'sortable_flag',
    :'mandatory_flag' => :'mandatory_flag'
  }
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



320
321
322
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 320

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



148
149
150
151
152
153
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 148

def self.openapi_all_of
  [
  :'NewProductField',
  :'ProductFieldAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



142
143
144
145
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 142

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

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 118

def self.openapi_types
  {
    :'name' => :'String',
    :'options' => :'Array<Object>',
    :'field_type' => :'String',
    :'id' => :'Integer',
    :'key' => :'String',
    :'order_nr' => :'Integer',
    :'add_time' => :'String',
    :'update_time' => :'String',
    :'last_updated_by_user_id' => :'Integer',
    :'active_flag' => :'Boolean',
    :'edit_flag' => :'Boolean',
    :'add_visible_flag' => :'Boolean',
    :'important_flag' => :'Boolean',
    :'bulk_edit_allowed' => :'Boolean',
    :'searchable_flag' => :'Boolean',
    :'filtering_allowed' => :'Boolean',
    :'sortable_flag' => :'Boolean',
    :'mandatory_flag' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 282

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      options == o.options &&
      field_type == o.field_type &&
      id == o.id &&
      key == o.key &&
      order_nr == o.order_nr &&
      add_time == o.add_time &&
      update_time == o.update_time &&
      last_updated_by_user_id == o.last_updated_by_user_id &&
      active_flag == o.active_flag &&
      edit_flag == o.edit_flag &&
      add_visible_flag == o.add_visible_flag &&
      important_flag == o.important_flag &&
      bulk_edit_allowed == o.bulk_edit_allowed &&
      searchable_flag == o.searchable_flag &&
      filtering_allowed == o.filtering_allowed &&
      sortable_flag == o.sortable_flag &&
      mandatory_flag == o.mandatory_flag
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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 348

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 417

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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 327

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


307
308
309
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 307

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



313
314
315
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 313

def hash
  [name, options, field_type, id, key, order_nr, add_time, update_time, last_updated_by_user_id, active_flag, edit_flag, add_visible_flag, important_flag, bulk_edit_allowed, searchable_flag, filtering_allowed, sortable_flag, mandatory_flag].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



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 247

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @field_type.nil?
    invalid_properties.push('invalid value for "field_type", field_type cannot be nil.')
  end

  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



393
394
395
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 393

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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 399

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



387
388
389
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 387

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



262
263
264
265
266
267
268
 
# File 'lib/pipedrive-openapi-client/models/product_field.rb', line 262

def valid?
  return false if @name.nil?
  return false if @field_type.nil?
  field_type_validator = EnumAttributeValidator.new('String', ["varchar", "varchar_auto", "text", "double", "monetary", "date", "set", "enum", "user", "org", "people", "phone", "time", "timerange", "daterange", "address"])
  return false unless field_type_validator.valid?(@field_type)
  true
end