Class: Pipedrive::NewDealProduct

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewDealProduct

Initializes the object

Parameters:

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

    Model attributes in the form of hash



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 85

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

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

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

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

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

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

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

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

Instance Attribute Details

#comments ⇒ Object

Any textual comment associated with this product-deal attachment. Visible and editable in the application UI.



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

def comments
  @comments
end

#discount_percentage ⇒ Object

Discount %. If omitted, will be set to 0



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

def discount_percentage
  @discount_percentage
end

#duration ⇒ Object

Duration of the product (when product durations are not enabled for the company or if omitted, defaults to 1)



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

def duration
  @duration
end

#enabled_flag ⇒ Object

Whether the product is enabled on the deal or not. This makes it possible to add products to a deal with specific price and discount criteria - but keep them disabled, which refrains them from being included in deal price calculation. When omitted, the product will be marked as enabled by default.



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

def enabled_flag
  @enabled_flag
end

#item_price ⇒ Object

Price at which this product will be added to the deal



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

def item_price
  @item_price
end

#product_id ⇒ Object

ID of the product that will be attached



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

def product_id
  @product_id
end

#product_variation_id ⇒ Object

ID of the product variation to use. When omitted, no variation will be used.



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

def product_variation_id
  @product_variation_id
end

#quantity ⇒ Object

Quantity – e.g. how many items of this product will be added to the deal



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

def quantity
  @quantity
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 42

def self.attribute_map
  {
    :'item_price' => :'item_price',
    :'quantity' => :'quantity',
    :'discount_percentage' => :'discount_percentage',
    :'duration' => :'duration',
    :'product_variation_id' => :'product_variation_id',
    :'comments' => :'comments',
    :'enabled_flag' => :'enabled_flag',
    :'product_id' => :'product_id'
  }
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



193
194
195
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 193

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



76
77
78
79
80
81
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 76

def self.openapi_all_of
  [
  :'BasicDealProduct',
  :'NewDealProductAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 56

def self.openapi_types
  {
    :'item_price' => :'Float',
    :'quantity' => :'Integer',
    :'discount_percentage' => :'Float',
    :'duration' => :'Float',
    :'product_variation_id' => :'Integer',
    :'comments' => :'String',
    :'enabled_flag' => :'NumberBoolean',
    :'product_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_price == o.item_price &&
      quantity == o.quantity &&
      discount_percentage == o.discount_percentage &&
      duration == o.duration &&
      product_variation_id == o.product_variation_id &&
      comments == o.comments &&
      enabled_flag == o.enabled_flag &&
      product_id == o.product_id
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 221

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 290

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 200

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


180
181
182
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



186
187
188
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 186

def hash
  [item_price, quantity, discount_percentage, duration, product_variation_id, comments, enabled_flag, product_id].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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 137

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

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

  if @product_id.nil?
    invalid_properties.push('invalid value for "product_id", product_id 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



266
267
268
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 266

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 272

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



260
261
262
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 260

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



156
157
158
159
160
161
 
# File 'lib/pipedrive-openapi-client/models/new_deal_product.rb', line 156

def valid?
  return false if @item_price.nil?
  return false if @quantity.nil?
  return false if @product_id.nil?
  true
end