Class: GongAPI::GenericSchemaFieldRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/gong_api/models/generic_schema_field_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenericSchemaFieldRequest

Initializes the object



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
140
141
142
143
144
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 98

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

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

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

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

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

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

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

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

Instance Attribute Details

#is_deleted ⇒ Object

"true" deletes the field from the schema and its value is removed from all objects. Use with caution.



17
18
19
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 17

def is_deleted
  @is_deleted
end

#label ⇒ Object

The label is used to display the field



20
21
22
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 20

def label
  @label
end

#last_modified ⇒ Object

The last modification timestamp of the field schema.
The timestamp should be in the ISO-8601 format without milliseconds e.g., "2020-12-17T13:45:01Z"



23
24
25
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 23

def last_modified
  @last_modified
end

#name ⇒ Object

Deprecated. Please use uniqueName



26
27
28
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 26

def name
  @name
end

#ordered_value_list ⇒ Object

Required for fields of type PICKLIST. Provides the list of available values for the field



29
30
31
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 29

def ordered_value_list
  @ordered_value_list
end

#reference_to ⇒ Object

Required for field of type REFERENCE. Defines the type of object referred to by this field. Must be one of "ACCOUNT", "CONTACT", "DEAL", "LEAD" or "USER"



32
33
34
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 32

def reference_to
  @reference_to
end

#type ⇒ Object

The field type (case-sensitive). See the Supported Field Types table.



35
36
37
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 35

def type
  @type
end

#unique_name ⇒ Object

The unique name of the field in the CRM system



38
39
40
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 38

def unique_name
  @unique_name
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 63

def self.attribute_map
  {
    :'is_deleted' => :'isDeleted',
    :'label' => :'label',
    :'last_modified' => :'lastModified',
    :'name' => :'name',
    :'ordered_value_list' => :'orderedValueList',
    :'reference_to' => :'referenceTo',
    :'type' => :'type',
    :'unique_name' => :'uniqueName'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



216
217
218
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 77

def self.openapi_types
  {
    :'is_deleted' => :'Object',
    :'label' => :'Object',
    :'last_modified' => :'Object',
    :'name' => :'Object',
    :'ordered_value_list' => :'Object',
    :'reference_to' => :'Object',
    :'type' => :'Object',
    :'unique_name' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_deleted == o.is_deleted &&
      label == o.label &&
      last_modified == o.last_modified &&
      name == o.name &&
      ordered_value_list == o.ordered_value_list &&
      reference_to == o.reference_to &&
      type == o.type &&
      unique_name == o.unique_name
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



246
247
248
249
250
251
252
253
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
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 246

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
    GongAPI.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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 315

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 223

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


203
204
205
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



209
210
211
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 209

def hash
  [is_deleted, label, last_modified, name, ordered_value_list, reference_to, type, unique_name].hash
end

#list_invalid_properties ⇒ Object

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 148

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



291
292
293
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 291

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 297

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



285
286
287
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 285

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



167
168
169
170
171
172
173
174
 
# File 'lib/gong_api/models/generic_schema_field_request.rb', line 167

def valid?
  return false if @label.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('Object', ['BOOLEAN', 'CURRENCY', 'DATE', 'DATETIME', 'EMAILADDRESS', 'ID', 'NUMBER', 'PERCENT', 'PHONENUMBER', 'PICKLIST', 'REFERENCE', 'STRING', 'STRINGARRAY', 'URL'])
  return false unless type_validator.valid?(@type)
  return false if @unique_name.nil?
  true
end