Class: Hubspot::Crm::Lists::ListCreateRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListCreateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
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
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 74

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

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

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

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

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

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

Instance Attribute Details

#custom_properties ⇒ Object

The list of custom properties to tie to the list. Custom property name is the key, the value is the value.



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

def custom_properties
  @custom_properties
end

#filter_branch ⇒ Object

Returns the value of attribute filter_branch.



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

def filter_branch
  @filter_branch
end

#list_folder_id ⇒ Object

The ID of the folder that the list should be created in. If left blank, then the list will be created in the root of the list folder structure.



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

def list_folder_id
  @list_folder_id
end

#name ⇒ Object

The name of the list, which must be globally unique across all public lists in the portal.



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

def name
  @name
end

#object_type_id ⇒ Object

The object type ID of the type of objects that the list will store.



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

def object_type_id
  @object_type_id
end

#processing_type ⇒ Object

The processing type of the list. One of: ‘SNAPSHOT`, `MANUAL`, or `DYNAMIC`.



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

def processing_type
  @processing_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 38

def self.attribute_map
  {
    :'object_type_id' => :'objectTypeId',
    :'processing_type' => :'processingType',
    :'custom_properties' => :'customProperties',
    :'list_folder_id' => :'listFolderId',
    :'name' => :'name',
    :'filter_branch' => :'filterBranch'
  }
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



170
171
172
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 170

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 55

def self.openapi_types
  {
    :'object_type_id' => :'String',
    :'processing_type' => :'String',
    :'custom_properties' => :'Hash<String, String>',
    :'list_folder_id' => :'Integer',
    :'name' => :'String',
    :'filter_branch' => :'PublicPropertyAssociationFilterBranchFilterBranchesInner'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object_type_id == o.object_type_id &&
      processing_type == o.processing_type &&
      custom_properties == o.custom_properties &&
      list_folder_id == o.list_folder_id &&
      name == o.name &&
      filter_branch == o.filter_branch
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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 201

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::Lists.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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 272

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 177

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


157
158
159
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 163

def hash
  [object_type_id, processing_type, custom_properties, list_folder_id, name, filter_branch].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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 116

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

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

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



248
249
250
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 248

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 254

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



242
243
244
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 242

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



135
136
137
138
139
140
 
# File 'lib/hubspot/codegen/crm/lists/models/list_create_request.rb', line 135

def valid?
  return false if @object_type_id.nil?
  return false if @processing_type.nil?
  return false if @name.nil?
  true
end