Class: Hubspot::Crm::Pipelines::PipelineInput

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

Overview

An input used to create or replace a pipeline’s definition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PipelineInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 55

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

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

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

Instance Attribute Details

#display_order ⇒ Object

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



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

def display_order
  @display_order
end

#label ⇒ Object

A unique label used to organize pipelines in HubSpot’s UI



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

def label
  @label
end

#stages ⇒ Object

Pipeline stage inputs used to create the new or replacement pipeline.



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

def stages
  @stages
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 30

def self.attribute_map
  {
    :'stages' => :'stages',
    :'label' => :'label',
    :'display_order' => :'displayOrder'
  }
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



136
137
138
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 136

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
51
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 48

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 39

def self.openapi_types
  {
    :'stages' => :'Array<PipelineStageInput>',
    :'label' => :'String',
    :'display_order' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



113
114
115
116
117
118
119
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 113

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      stages == o.stages &&
      label == o.label &&
      display_order == o.display_order
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



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

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 233

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 143

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


123
124
125
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 123

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



129
130
131
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 129

def hash
  [stages, label, display_order].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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 85

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

  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

  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



209
210
211
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 209

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



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

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



203
204
205
 
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_input.rb', line 203

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



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

def valid?
  return false if @stages.nil?
  return false if @label.nil?
  return false if @display_order.nil?
  true
end