Class: StickyIoRestfulApiV2025731::DataGetCustomerCustomFields

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb

Overview

DataGetCustomerCustomFields Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(id:, field_type_id:, name:, token_key:, is_multi:, options:, type_id:, additional_properties: nil) ⇒ DataGetCustomerCustomFields

Returns a new instance of DataGetCustomerCustomFields.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 63

def initialize(id:, field_type_id:, name:, token_key:, is_multi:, options:,
               type_id:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @id = id
  @field_type_id = field_type_id
  @name = name
  @token_key = token_key
  @is_multi = is_multi
  @options = options
  @type_id = type_id
  @additional_properties = additional_properties
end

Instance Attribute Details

#field_type_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 18

def field_type_id
  @field_type_id
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 14

def id
  @id
end

#is_multi ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


30
31
32
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 30

def is_multi
  @is_multi
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


22
23
24
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 22

def name
  @name
end

#options ⇒ Array[Object]

TODO: Write general description for this method

Returns:

  • (Array[Object]) 


34
35
36
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 34

def options
  @options
end

#token_key ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 26

def token_key
  @token_key
end

#type_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 38

def type_id
  @type_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 79

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : nil
  field_type_id = hash.key?('field_type_id') ? hash['field_type_id'] : nil
  name = hash.key?('name') ? hash['name'] : nil
  token_key = hash.key?('token_key') ? hash['token_key'] : nil
  is_multi = hash.key?('is_multi') ? hash['is_multi'] : nil
  options = hash.key?('options') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:DataGetCustomerCustomFieldsOptions), hash['options']
  ) : nil
  type_id = hash.key?('type_id') ? hash['type_id'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  DataGetCustomerCustomFields.new(id: id,
                                  field_type_id: field_type_id,
                                  name: name,
                                  token_key: token_key,
                                  is_multi: is_multi,
                                  options: options,
                                  type_id: type_id,
                                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 41

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['field_type_id'] = 'field_type_id'
  @_hash['name'] = 'name'
  @_hash['token_key'] = 'token_key'
  @_hash['is_multi'] = 'is_multi'
  @_hash['options'] = 'options'
  @_hash['type_id'] = 'type_id'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



59
60
61
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 59

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 54

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



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
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 113

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.id,
                            ->(val) { val.instance_of? Integer }) and
        APIHelper.valid_type?(value.field_type_id,
                              ->(val) { val.instance_of? Integer }) and
        APIHelper.valid_type?(value.name,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.token_key,
                              ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.is_multi,
                              ->(val) { val.instance_of? Integer }) and
        UnionTypeLookUp.get(:DataGetCustomerCustomFieldsOptions)
                       .validate(value.options) and
        APIHelper.valid_type?(value.type_id,
                              ->(val) { val.instance_of? Integer })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['id'],
                          ->(val) { val.instance_of? Integer }) and
      APIHelper.valid_type?(value['field_type_id'],
                            ->(val) { val.instance_of? Integer }) and
      APIHelper.valid_type?(value['name'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['token_key'],
                            ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['is_multi'],
                            ->(val) { val.instance_of? Integer }) and
      UnionTypeLookUp.get(:DataGetCustomerCustomFieldsOptions)
                     .validate(value['options']) and
      APIHelper.valid_type?(value['type_id'],
                            ->(val) { val.instance_of? Integer })
  )
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



162
163
164
165
166
167
168
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 162

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, field_type_id: #{@field_type_id.inspect}, name:"\
  " #{@name.inspect}, token_key: #{@token_key.inspect}, is_multi: #{@is_multi.inspect},"\
  " options: #{@options.inspect}, type_id: #{@type_id.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



154
155
156
157
158
159
 
# File 'lib/sticky_io_restful_api_v2025731/models/data_get_customer_custom_fields.rb', line 154

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, field_type_id: #{@field_type_id}, name: #{@name}, token_key:"\
  " #{@token_key}, is_multi: #{@is_multi}, options: #{@options}, type_id: #{@type_id},"\
  " additional_properties: #{@additional_properties}>"
end