Class: Hubspot::Crm::Exports::PublicExportListRequestAllOf

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicExportListRequestAllOf

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
162
163
164
165
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 107

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#associated_object_typeObject

Returns the value of attribute associated_object_type.



28
29
30
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 28

def associated_object_type
  @associated_object_type
end

#export_internal_values_optionsObject

Returns the value of attribute export_internal_values_options.



34
35
36
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 34

def export_internal_values_options
  @export_internal_values_options
end

#export_nameObject

Returns the value of attribute export_name.



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

def export_name
  @export_name
end

#export_typeObject

Returns the value of attribute export_type.



20
21
22
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 20

def export_type
  @export_type
end

#formatObject

Returns the value of attribute format.



22
23
24
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 22

def format
  @format
end

#languageObject

Returns the value of attribute language.



32
33
34
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 32

def language
  @language
end

#list_idObject

Returns the value of attribute list_id.



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

def list_id
  @list_id
end

#object_propertiesObject

Returns the value of attribute object_properties.



26
27
28
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 26

def object_properties
  @object_properties
end

#object_typeObject

Returns the value of attribute object_type.



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

def object_type
  @object_type
end

#override_associated_objects_per_definition_per_row_limitObject

Returns the value of attribute override_associated_objects_per_definition_per_row_limit.



36
37
38
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 36

def override_associated_objects_per_definition_per_row_limit
  @override_associated_objects_per_definition_per_row_limit
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



79
80
81
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 63

def self.attribute_map
  {
    :'export_type' => :'exportType',
    :'format' => :'format',
    :'export_name' => :'exportName',
    :'object_properties' => :'objectProperties',
    :'associated_object_type' => :'associatedObjectType',
    :'object_type' => :'objectType',
    :'language' => :'language',
    :'export_internal_values_options' => :'exportInternalValuesOptions',
    :'override_associated_objects_per_definition_per_row_limit' => :'overrideAssociatedObjectsPerDefinitionPerRowLimit',
    :'list_id' => :'listId'
  }
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



293
294
295
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 293

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

.openapi_nullableObject

List of attributes with nullable: true



100
101
102
103
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 100

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

.openapi_typesObject

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 84

def self.openapi_types
  {
    :'export_type' => :'String',
    :'format' => :'String',
    :'export_name' => :'String',
    :'object_properties' => :'Array<String>',
    :'associated_object_type' => :'String',
    :'object_type' => :'String',
    :'language' => :'String',
    :'export_internal_values_options' => :'Array<String>',
    :'override_associated_objects_per_definition_per_row_limit' => :'Boolean',
    :'list_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      export_type == o.export_type &&
      format == o.format &&
      export_name == o.export_name &&
      object_properties == o.object_properties &&
      associated_object_type == o.associated_object_type &&
      object_type == o.object_type &&
      language == o.language &&
      export_internal_values_options == o.export_internal_values_options &&
      override_associated_objects_per_definition_per_row_limit == o.override_associated_objects_per_definition_per_row_limit &&
      list_id == o.list_id
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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 324

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



395
396
397
398
399
400
401
402
403
404
405
406
407
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 395

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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 300

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


280
281
282
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 280

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



286
287
288
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 286

def hash
  [export_type, format, export_name, object_properties, associated_object_type, object_type, language, export_internal_values_options, override_associated_objects_per_definition_per_row_limit, list_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



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
200
201
202
203
204
205
206
207
208
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 169

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



371
372
373
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 371

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



377
378
379
380
381
382
383
384
385
386
387
388
389
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 377

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



365
366
367
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 365

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
# File 'lib/hubspot/codegen/crm/exports/models/public_export_list_request_all_of.rb', line 212

def valid?
  return false if @export_type.nil?
  export_type_validator = EnumAttributeValidator.new('String', ["LIST"])
  return false unless export_type_validator.valid?(@export_type)
  return false if @format.nil?
  format_validator = EnumAttributeValidator.new('String', ["XLS", "XLSX", "CSV"])
  return false unless format_validator.valid?(@format)
  return false if @export_name.nil?
  return false if @object_properties.nil?
  return false if @object_type.nil?
  return false if @language.nil?
  language_validator = EnumAttributeValidator.new('String', ["EN", "DE", "ES", "FR", "JA", "NL", "PT_BR", "IT", "PL", "SV", "FI", "ZH_TW", "DA_DK", "NO"])
  return false unless language_validator.valid?(@language)
  return false if @export_internal_values_options.nil?
  return false if @override_associated_objects_per_definition_per_row_limit.nil?
  return false if @list_id.nil?
  true
end