Class: Devdraft::CreateTaxDto

Inherits:
ApiModelBase show all
Defined in:
lib/devdraft/models/create_tax_dto.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateTaxDto

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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 73

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Devdraft::CreateTaxDto` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Devdraft::CreateTaxDto`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'percentage')
    self.percentage = attributes[:'percentage']
  else
    self.percentage = nil
  end

  if attributes.key?(:'active')
    self.active = attributes[:'active']
  else
    self.active = true
  end

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

Instance Attribute Details

#active ⇒ Object

Whether this tax is currently active and can be applied.



28
29
30
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 28

def active
  @active
end

#app_ids ⇒ Object

Array of app IDs where this tax should be available. If not provided, tax will be available for the current app.



31
32
33
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 31

def app_ids
  @app_ids
end

#description ⇒ Object

Optional description explaining what this tax covers.



22
23
24
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 22

def description
  @description
end

#name ⇒ Object

Tax name. Used to identify and reference this tax rate.



19
20
21
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 19

def name
  @name
end

#percentage ⇒ Object

Tax percentage rate. Must be between 0 and 100.



25
26
27
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 25

def percentage
  @percentage
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 50

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 34

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'percentage' => :'percentage',
    :'active' => :'active',
    :'app_ids' => :'appIds'
  }
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 243

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



66
67
68
69
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 66

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 55

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'percentage' => :'Float',
    :'active' => :'Boolean',
    :'app_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
226
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 218

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      percentage == o.percentage &&
      active == o.active &&
      app_ids == o.app_ids
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 236

def hash
  [name, description, percentage, active, app_ids].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



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
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 118

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
  end

  if !@description.nil? && @description.to_s.length > 255
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
  end

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

  if @percentage > 100
    invalid_properties.push('invalid value for "percentage", must be smaller than or equal to 100.')
  end

  if @percentage < 0
    invalid_properties.push('invalid value for "percentage", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 265

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/devdraft/models/create_tax_dto.rb', line 154

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 100
  return false if @name.to_s.length < 1
  return false if !@description.nil? && @description.to_s.length > 255
  return false if @percentage.nil?
  return false if @percentage > 100
  return false if @percentage < 0
  true
end