Class: SubskribeSandboxClient::CustomFieldDefinitionUpdateInput

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/models/custom_field_definition_update_input.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomFieldDefinitionUpdateInput

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
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
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 73

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'fieldName')
    self.field_name = attributes[:'fieldName']
  end

  if attributes.has_key?(:'fieldLabel')
    self.field_label = attributes[:'fieldLabel']
  end

  if attributes.has_key?(:'fieldType')
    self.field_type = attributes[:'fieldType']
  end

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

  if attributes.has_key?(:'defaultValue')
    self.default_value = attributes[:'defaultValue']
  end
end

Instance Attribute Details

#default_valueObject

Returns the value of attribute default_value.



25
26
27
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 25

def default_value
  @default_value
end

#field_labelObject

Returns the value of attribute field_label.



19
20
21
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 19

def field_label
  @field_label
end

#field_nameObject

Returns the value of attribute field_name.



17
18
19
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 17

def field_name
  @field_name
end

#field_typeObject

Returns the value of attribute field_type.



21
22
23
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 21

def field_type
  @field_type
end

#optionsObject

Returns the value of attribute options.



23
24
25
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 23

def options
  @options
end

Class Method Details

.attribute_mapObject

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



50
51
52
53
54
55
56
57
58
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 50

def self.attribute_map
  {
    :'field_name' => :'fieldName',
    :'field_label' => :'fieldLabel',
    :'field_type' => :'fieldType',
    :'options' => :'options',
    :'default_value' => :'defaultValue'
  }
end

.swagger_typesObject

Attribute type mapping.



61
62
63
64
65
66
67
68
69
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 61

def self.swagger_types
  {
    :'field_name' => :'String',
    :'field_label' => :'String',
    :'field_type' => :'String',
    :'options' => :'Array<String>',
    :'default_value' => :'CustomFieldDefault'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



129
130
131
132
133
134
135
136
137
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      field_name == o.field_name &&
      field_label == o.field_label &&
      field_type == o.field_type &&
      options == o.options &&
      default_value == o.default_value
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



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
209
210
211
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 175

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
    temp_model = SubskribeSandboxClient.const_get(type).new
    temp_model.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



241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 241

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 154

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


141
142
143
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 141

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



147
148
149
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 147

def hash
  [field_name, field_label, field_type, options, default_value].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



104
105
106
107
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 104

def list_invalid_properties
  invalid_properties = Array.new
  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



221
222
223
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 221

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



227
228
229
230
231
232
233
234
235
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 227

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



215
216
217
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 215

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



111
112
113
114
115
# File 'lib/subskribe_sandbox/models/custom_field_definition_update_input.rb', line 111

def valid?
  field_type_validator = EnumAttributeValidator.new('String', ['STRING', 'PICKLIST', 'MULTISELECT_PICKLIST'])
  return false unless field_type_validator.valid?(@field_type)
  true
end