Class: Hubspot::Crm::Extensions::Cards::IntegratorCardPayloadResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb

Overview

The card details payload, sent to HubSpot by an app in response to a data fetch request when a user visits a CRM record page.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IntegratorCardPayloadResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 97

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

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

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

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

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

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

Instance Attribute Details

URL to a page the integrator has built that displays all details for this card. This URL will be displayed to users under a ‘See more [x]` link if there are more than five items in your response, where `[x]` is the value of `itemLabel`.



26
27
28
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 26

def all_items_link_url
  @all_items_link_url
end

#card_label ⇒ Object

The label to be used for the ‘allItemsLinkUrl` link (e.g. ’See more tickets’). If not provided, this falls back to the card’s title.



29
30
31
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 29

def card_label
  @card_label
end

#response_version ⇒ Object

Returns the value of attribute response_version.



36
37
38
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 36

def response_version
  @response_version
end

#sections ⇒ Object

A list of up to five valid card sub categories.



34
35
36
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 34

def sections
  @sections
end

#top_level_actions ⇒ Object

Returns the value of attribute top_level_actions.



31
32
33
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 31

def top_level_actions
  @top_level_actions
end

#total_count ⇒ Object

The total number of card properties that will be sent in this response.



23
24
25
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 23

def total_count
  @total_count
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 61

def self.attribute_map
  {
    :'total_count' => :'totalCount',
    :'all_items_link_url' => :'allItemsLinkUrl',
    :'card_label' => :'cardLabel',
    :'top_level_actions' => :'topLevelActions',
    :'sections' => :'sections',
    :'response_version' => :'responseVersion'
  }
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



195
196
197
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 195

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



90
91
92
93
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 90

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 78

def self.openapi_types
  {
    :'total_count' => :'Integer',
    :'all_items_link_url' => :'String',
    :'card_label' => :'String',
    :'top_level_actions' => :'TopLevelActions',
    :'sections' => :'Array<IntegratorObjectResult>',
    :'response_version' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_count == o.total_count &&
      all_items_link_url == o.all_items_link_url &&
      card_label == o.card_label &&
      top_level_actions == o.top_level_actions &&
      sections == o.sections &&
      response_version == o.response_version
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



226
227
228
229
230
231
232
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
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 226

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::Extensions::Cards.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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 297

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 202

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


182
183
184
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 188

def hash
  [total_count, all_items_link_url, card_label, top_level_actions, sections, response_version].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



139
140
141
142
143
144
145
146
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 139

def list_invalid_properties
  invalid_properties = Array.new
  if @total_count.nil?
    invalid_properties.push('invalid value for "total_count", total_count 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



273
274
275
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 273

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 279

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



267
268
269
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 267

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



150
151
152
153
154
155
 
# File 'lib/hubspot/codegen/crm/extensions/cards/models/integrator_card_payload_response.rb', line 150

def valid?
  return false if @total_count.nil?
  response_version_validator = EnumAttributeValidator.new('String', ["v1", "v3"])
  return false unless response_version_validator.valid?(@response_version)
  true
end