Class: ConnectWise::WorkflowActionUserDefinedField

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/workflow_action_user_defined_field.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WorkflowActionUserDefinedField

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


72
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
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 72

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::WorkflowActionUserDefinedField` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::WorkflowActionUserDefinedField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

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

  self.event_id = attributes[:event_id] if attributes.key?(:event_id)

  self.action_id = attributes[:action_id] if attributes.key?(:action_id)

  self.caption = attributes[:caption] if attributes.key?(:caption)

  self.user_defined_field_id = attributes[:user_defined_field_id] if attributes.key?(:user_defined_field_id)

  self.value = attributes[:value] if attributes.key?(:value)

  self.overwrite_flag = attributes[:overwrite_flag] if attributes.key?(:overwrite_flag)

  self.pod_description = attributes[:pod_description] if attributes.key?(:pod_description)

  self.field_type_id = attributes[:field_type_id] if attributes.key?(:field_type_id)

  self.entry_type_id = attributes[:entry_type_id] if attributes.key?(:entry_type_id)

  self.required_flag = attributes[:required_flag] if attributes.key?(:required_flag)

  self.inactive_flag = attributes[:inactive_flag] if attributes.key?(:inactive_flag)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def _info
  @_info
end

#action_id ⇒ Object

Returns the value of attribute action_id.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def action_id
  @action_id
end

#caption ⇒ Object

Returns the value of attribute caption.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def caption
  @caption
end

#entry_type_id ⇒ Object

Returns the value of attribute entry_type_id.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def entry_type_id
  @entry_type_id
end

#event_id ⇒ Object

Returns the value of attribute event_id.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def event_id
  @event_id
end

#field_type_id ⇒ Object

Returns the value of attribute field_type_id.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def field_type_id
  @field_type_id
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def id
  @id
end

#inactive_flag ⇒ Object

Returns the value of attribute inactive_flag.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def inactive_flag
  @inactive_flag
end

#overwrite_flag ⇒ Object

Returns the value of attribute overwrite_flag.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def overwrite_flag
  @overwrite_flag
end

#pod_description ⇒ Object

Returns the value of attribute pod_description.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def pod_description
  @pod_description
end

#required_flag ⇒ Object

Returns the value of attribute required_flag.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def required_flag
  @required_flag
end

#user_defined_field_id ⇒ Object

Returns the value of attribute user_defined_field_id.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def user_defined_field_id
  @user_defined_field_id
end

#value ⇒ Object

Returns the value of attribute value.



16
17
18
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 16

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



38
39
40
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 38

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 19

def self.attribute_map
  {
    id: :id,
    event_id: :eventId,
    action_id: :actionId,
    caption: :caption,
    user_defined_field_id: :userDefinedFieldId,
    value: :value,
    overwrite_flag: :overwriteFlag,
    pod_description: :podDescription,
    field_type_id: :fieldTypeId,
    entry_type_id: :entryTypeId,
    required_flag: :requiredFlag,
    inactive_flag: :inactiveFlag,
    _info: :_info
  }
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



160
161
162
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 160

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
67
68
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 62

def self.openapi_nullable
  Set.new(i[
            overwrite_flag
            required_flag
            inactive_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 43

def self.openapi_types
  {
    id: :Integer,
    event_id: :Integer,
    action_id: :Integer,
    caption: :String,
    user_defined_field_id: :Integer,
    value: :String,
    overwrite_flag: :Boolean,
    pod_description: :String,
    field_type_id: :String,
    entry_type_id: :String,
    required_flag: :Boolean,
    inactive_flag: :Boolean,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 126

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    event_id == other.event_id &&
    action_id == other.action_id &&
    caption == other.caption &&
    user_defined_field_id == other.user_defined_field_id &&
    value == other.value &&
    overwrite_flag == other.overwrite_flag &&
    pod_description == other.pod_description &&
    field_type_id == other.field_type_id &&
    entry_type_id == other.entry_type_id &&
    required_flag == other.required_flag &&
    inactive_flag == other.inactive_flag &&
    _info == other._info
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 190

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 = ConnectWise.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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 261

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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 167

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)
      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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


147
148
149
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 147

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



153
154
155
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 153

def hash
  [id, event_id, action_id, caption, user_defined_field_id, value, overwrite_flag, pod_description, field_type_id, entry_type_id, required_flag, inactive_flag, _info].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



114
115
116
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 114

def list_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



237
238
239
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 237

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



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 243

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



231
232
233
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 231

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



120
121
122
 
# File 'lib/connect_wise/models/workflow_action_user_defined_field.rb', line 120

def valid?
  true
end