Class: Pipedrive::BasicGoal

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

Direct Known Subclasses

NewGoal

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BasicGoal

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 89

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

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

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

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

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

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

Instance Attribute Details

#assignee ⇒ Object

Who is this goal assigned to. It requires the following JSON structure: { "id": "1", "type": "person" }. ‘type` can be either `person`, `company` or `team`. ID of the assignee person, company or team.



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

def assignee
  @assignee
end

#duration ⇒ Object

Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD.



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

def duration
  @duration
end

#expected_outcome ⇒ Object

Expected outcome of the goal. Expected outcome can be tracked either by ‘quantity` or by `sum`. It requires the following JSON structure: { "target": "50", "tracking_metric": "quantity" } or { "target": "50", "tracking_metric": "sum", "currency_id": 1 }. `currency_id` should only be added to `sum` type of goals.



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

def expected_outcome
  @expected_outcome
end

#interval ⇒ Object

Date when the goal starts and ends. It requires the following JSON structure: { "start": "2019-01-01", "end": "2022-12-31" }. Date in format of YYYY-MM-DD.



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

def interval
  @interval
end

#title ⇒ Object

Title of the goal.



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

def title
  @title
end

#type ⇒ Object

Type of the goal. It requires the following JSON structure: { "name": "deals_started", "params": { "pipeline_id": 1 } }. Type can be one of: ‘deals_won`,`deals_progressed`,`activities_completed`,`activities_added` or `deals_started`. `params` can include `pipeline_id`, `stage_id` or `activity_type_id`. `stage_id` is related to only `deals_progressed` type of goals and `activity_type_id` to `activities_completed` or `activities_added` types of goals. To track goal in all pipelines set `pipeline_id` as `null`.



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'title' => :'title',
    :'assignee' => :'assignee',
    :'type' => :'type',
    :'expected_outcome' => :'expected_outcome',
    :'duration' => :'duration',
    :'interval' => :'interval'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 70

def self.openapi_types
  {
    :'title' => :'String',
    :'assignee' => :'Object',
    :'type' => :'Object',
    :'expected_outcome' => :'Object',
    :'duration' => :'Object',
    :'interval' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 154

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      assignee == o.assignee &&
      type == o.type &&
      expected_outcome == o.expected_outcome &&
      duration == o.duration &&
      interval == o.interval
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



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/basic_goal.rb', line 208

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 277

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 187

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


167
168
169
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



173
174
175
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 173

def hash
  [title, assignee, type, expected_outcome, duration, interval].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



129
130
131
132
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 129

def list_invalid_properties
  invalid_properties = Array.new
  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



253
254
255
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 253

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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 259

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



247
248
249
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 247

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



136
137
138
139
140
 
# File 'lib/pipedrive-openapi-client/models/basic_goal.rb', line 136

def valid?
  interval_validator = EnumAttributeValidator.new('String', ["weekly", "monthly", "quarterly", "yearly"])
  return false unless interval_validator.valid?(@interval)
  true
end