Class: Hubspot::Crm::Pipelines::PipelineStage

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PipelineStage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



79
80
81
82
83
84
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
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 79

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

Whether the pipeline is archived.



41
42
43
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 41

def archived
  @archived
end

#archived_at ⇒ Object

The date the pipeline was archived. ‘archivedAt` will only be present if the pipeline is archived.



35
36
37
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 35

def archived_at
  @archived_at
end

#created_at ⇒ Object

The date the pipeline stage was created. The stages on default pipelines will have createdAt = 0.



32
33
34
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 32

def created_at
  @created_at
end

#display_order ⇒ Object

The order for displaying this pipeline stage. If two pipeline stages have a matching ‘displayOrder`, they will be sorted alphabetically by label.



23
24
25
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 23

def display_order
  @display_order
end

#id ⇒ Object

A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage.



29
30
31
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 29

def id
  @id
end

#label ⇒ Object

A label used to organize pipeline stages in HubSpot’s UI. Each pipeline stage’s label must be unique within that pipeline.



20
21
22
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 20

def label
  @label
end

#metadata ⇒ Object

A JSON object containing properties that are not present on all object pipelines. For ‘deals` pipelines, the `probability` field is required (`{ "probability": 0.5 }`), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1. For `tickets` pipelines, the `ticketState` field is optional (`{ "ticketState": "OPEN" }`), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are `OPEN` or `CLOSED`.



26
27
28
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 26

def metadata
  @metadata
end

#updated_at ⇒ Object

The date the pipeline stage was last updated.



38
39
40
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 38

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 44

def self.attribute_map
  {
    :'label' => :'label',
    :'display_order' => :'displayOrder',
    :'metadata' => :'metadata',
    :'id' => :'id',
    :'created_at' => :'createdAt',
    :'archived_at' => :'archivedAt',
    :'updated_at' => :'updatedAt',
    :'archived' => :'archived'
  }
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



205
206
207
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 205

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 58

def self.openapi_types
  {
    :'label' => :'String',
    :'display_order' => :'Integer',
    :'metadata' => :'Hash<String, String>',
    :'id' => :'String',
    :'created_at' => :'DateTime',
    :'archived_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'archived' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label == o.label &&
      display_order == o.display_order &&
      metadata == o.metadata &&
      id == o.id &&
      created_at == o.created_at &&
      archived_at == o.archived_at &&
      updated_at == o.updated_at &&
      archived == o.archived
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 233

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
    Hubspot::Crm::Pipelines.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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 302

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 212

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


192
193
194
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



198
199
200
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 198

def hash
  [label, display_order, metadata, id, created_at, archived_at, updated_at, archived].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
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
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 129

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

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

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

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

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

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

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



278
279
280
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 278

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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 284

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



272
273
274
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 272

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



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 164

def valid?
  return false if @label.nil?
  return false if @display_order.nil?
  return false if @metadata.nil?
  return false if @id.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @archived.nil?
  true
end