Class: Hubspot::Crm::Pipelines::PipelineStageInput
- Inherits:
-
Object
- Object
- Hubspot::Crm::Pipelines::PipelineStageInput
- Defined in:
- lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb
Instance Attribute Summary collapse
-
#display_order ⇒ Object
The order for displaying this pipeline stage.
-
#label ⇒ Object
A label used to organize pipeline stages in HubSpot’s UI.
-
#metadata ⇒ Object
A JSON object containing properties that are not present on all object pipelines.
Class Method Summary collapse
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ PipelineStageInput
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ PipelineStageInput
Initializes the object
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 60 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Pipelines::PipelineStageInput` 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::PipelineStageInput`. 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?(:'metadata') if (value = attributes[:'metadata']).is_a?(Hash) self. = value end end if attributes.key?(:'display_order') self.display_order = attributes[:'display_order'] end if attributes.key?(:'label') self.label = attributes[:'label'] end end |
Instance Attribute Details
#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.
24 25 26 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 24 def display_order @display_order 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.
27 28 29 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 27 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`.
21 22 23 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 21 def @metadata end |
Class Method Details
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
39 40 41 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 39 def self.acceptable_attributes attribute_map.values end |
.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_stage_input.rb', line 30 def self.attribute_map { :'metadata' => :'metadata', :'display_order' => :'displayOrder', :'label' => :'label' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
141 142 143 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 141 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
53 54 55 56 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 53 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
44 45 46 47 48 49 50 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 44 def self.openapi_types { :'metadata' => :'Hash<String, String>', :'display_order' => :'Integer', :'label' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
118 119 120 121 122 123 124 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 118 def ==(o) return true if self.equal?(o) self.class == o.class && == o. && display_order == o.display_order && label == o.label end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 172 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
243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 243 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
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 148 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
128 129 130 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 128 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
134 135 136 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 134 def hash [, display_order, label].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 90 def list_invalid_properties invalid_properties = Array.new 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 invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
219 220 221 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 219 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
225 226 227 228 229 230 231 232 233 234 235 236 237 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 225 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
213 214 215 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 213 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
109 110 111 112 113 114 |
# File 'lib/hubspot/codegen/crm/pipelines/models/pipeline_stage_input.rb', line 109 def valid? return false if @metadata.nil? return false if @display_order.nil? return false if @label.nil? true end |