Class: ConnectWise::OrderStatus

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderStatus

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/connect_wise/models/order_status.rb', line 66

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::OrderStatus` 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::OrderStatus`. 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.name = attributes[:name] if attributes.key?(:name)

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

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

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

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

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

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

  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.



19
20
21
 
# File 'lib/connect_wise/models/order_status.rb', line 19

def _info
  @_info
end

#closed_flag ⇒ Object

Returns the value of attribute closed_flag.



19
20
21
 
# File 'lib/connect_wise/models/order_status.rb', line 19

def closed_flag
  @closed_flag
end

#default_flag ⇒ Object

Returns the value of attribute default_flag.



19
20
21
 
# File 'lib/connect_wise/models/order_status.rb', line 19

def default_flag
  @default_flag
end

#email_template ⇒ Object

Returns the value of attribute email_template.



19
20
21
 
# File 'lib/connect_wise/models/order_status.rb', line 19

def email_template
  @email_template
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/connect_wise/models/order_status.rb', line 19

def id
  @id
end

#inactive_flag ⇒ Object

Returns the value of attribute inactive_flag.



19
20
21
 
# File 'lib/connect_wise/models/order_status.rb', line 19

def inactive_flag
  @inactive_flag
end

#name ⇒ Object

Max length: 50;



17
18
19
 
# File 'lib/connect_wise/models/order_status.rb', line 17

def name
  @name
end

#sort_order ⇒ Object

Returns the value of attribute sort_order.



19
20
21
 
# File 'lib/connect_wise/models/order_status.rb', line 19

def sort_order
  @sort_order
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



36
37
38
 
# File 'lib/connect_wise/models/order_status.rb', line 36

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/connect_wise/models/order_status.rb', line 22

def self.attribute_map
  {
    name: :name,
    id: :id,
    default_flag: :defaultFlag,
    inactive_flag: :inactiveFlag,
    sort_order: :sortOrder,
    closed_flag: :closedFlag,
    email_template: :emailTemplate,
    _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



144
145
146
 
# File 'lib/connect_wise/models/order_status.rb', line 144

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



55
56
57
58
59
60
61
62
 
# File 'lib/connect_wise/models/order_status.rb', line 55

def self.openapi_nullable
  Set.new(i[
            default_flag
            inactive_flag
            sort_order
            closed_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    name: :String,
    id: :Integer,
    default_flag: :Boolean,
    inactive_flag: :Boolean,
    sort_order: :Integer,
    closed_flag: :Boolean,
    email_template: :OrderStatusEmailTemplateReference,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/connect_wise/models/order_status.rb', line 115

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

  self.class == other.class &&
    name == other.name &&
    id == other.id &&
    default_flag == other.default_flag &&
    inactive_flag == other.inactive_flag &&
    sort_order == other.sort_order &&
    closed_flag == other.closed_flag &&
    email_template == other.email_template &&
    _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



174
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/connect_wise/models/order_status.rb', line 174

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



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/connect_wise/models/order_status.rb', line 245

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/connect_wise/models/order_status.rb', line 151

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


131
132
133
 
# File 'lib/connect_wise/models/order_status.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



137
138
139
 
# File 'lib/connect_wise/models/order_status.rb', line 137

def hash
  [name, id, default_flag, inactive_flag, sort_order, closed_flag, email_template, _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



98
99
100
101
102
103
 
# File 'lib/connect_wise/models/order_status.rb', line 98

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "name", name cannot be nil.') if @name.nil?

  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



221
222
223
 
# File 'lib/connect_wise/models/order_status.rb', line 221

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



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/connect_wise/models/order_status.rb', line 227

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



215
216
217
 
# File 'lib/connect_wise/models/order_status.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



107
108
109
110
111
 
# File 'lib/connect_wise/models/order_status.rb', line 107

def valid?
  return false if @name.nil?

  true
end