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

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
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
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 111

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?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#archived ⇒ Object

Whether the pipeline is archived.



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

def archived
  @archived
end

#archived_at ⇒ Object

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



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

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.



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

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.



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

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.



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

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.



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

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



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

def metadata
  @metadata
end

#updated_at ⇒ Object

The date the pipeline stage was last updated.



44
45
46
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 44

def updated_at
  @updated_at
end

#write_permissions ⇒ Object

Returns the value of attribute write_permissions.



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

def write_permissions
  @write_permissions
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 69

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



254
255
256
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 254

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



104
105
106
107
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 104

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 89

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 225

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 285

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Hubspot::Crm::Pipelines.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 356

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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 261

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


241
242
243
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 247

def hash
  [created_at, archived_at, archived, metadata, display_order, write_permissions, label, id, updated_at].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



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
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 165

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

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

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

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

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

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

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



332
333
334
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 332

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 338

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



326
327
328
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 326

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



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage.rb', line 200

def valid?
  return false if @created_at.nil?
  return false if @archived.nil?
  return false if @metadata.nil?
  return false if @display_order.nil?
  write_permissions_validator = EnumAttributeValidator.new('String', ["CRM_PERMISSIONS_ENFORCEMENT", "READ_ONLY", "INTERNAL_ONLY"])
  return false unless write_permissions_validator.valid?(@write_permissions)
  return false if @label.nil?
  return false if @id.nil?
  return false if @updated_at.nil?
  true
end