Class: Hubspot::Crm::Imports::PublicImportResponse

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PublicImportResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
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
136
137
138
139
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 95

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#import_name ⇒ Object

Returns the value of attribute import_name.



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

def import_name
  @import_name
end

#import_request_json ⇒ Object

Returns the value of attribute import_request_json.



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

def import_request_json
  @import_request_json
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#opt_out_import ⇒ Object

Whether or not the import is a list of people disqualified from receiving emails.



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

def opt_out_import
  @opt_out_import
end

#state ⇒ Object

The status of the import.



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

def state
  @state
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 60

def self.attribute_map
  {
    :'state' => :'state',
    :'import_request_json' => :'importRequestJson',
    :'created_at' => :'createdAt',
    :'metadata' => :'metadata',
    :'import_name' => :'importName',
    :'updated_at' => :'updatedAt',
    :'opt_out_import' => :'optOutImport',
    :'id' => :'id'
  }
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



226
227
228
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 226

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 74

def self.openapi_types
  {
    :'state' => :'String',
    :'import_request_json' => :'Object',
    :'created_at' => :'DateTime',
    :'metadata' => :'PublicImportMetadata',
    :'import_name' => :'String',
    :'updated_at' => :'DateTime',
    :'opt_out_import' => :'Boolean',
    :'id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      state == o.state &&
      import_request_json == o.import_request_json &&
      created_at == o.created_at &&
      metadata == o.metadata &&
      import_name == o.import_name &&
      updated_at == o.updated_at &&
      opt_out_import == o.opt_out_import &&
      id == o.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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 254

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 323

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 233

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


213
214
215
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



219
220
221
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 219

def hash
  [state, import_request_json, created_at, metadata, import_name, updated_at, opt_out_import, id].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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 143

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

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

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

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

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

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



299
300
301
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 299

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 305

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



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

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



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/hubspot/codegen/crm/imports/models/public_import_response.rb', line 174

def valid?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["STARTED", "PROCESSING", "DONE", "FAILED", "CANCELED"])
  return false unless state_validator.valid?(@state)
  return false if @created_at.nil?
  return false if @metadata.nil?
  return false if @updated_at.nil?
  return false if @opt_out_import.nil?
  return false if @id.nil?
  true
end