Class: TrinsicApi::IndiaPanStructuredNumber

Inherits:
ApiModelBase show all
Defined in:
lib/trinsic_api/models/india_pan_structured_number.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 = {}) ⇒ IndiaPanStructuredNumber

Initializes the object

Parameters:

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

    Model attributes in the form of 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::IndiaPanStructuredNumber` 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 `TrinsicApi::IndiaPanStructuredNumber`. 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?(:'series_code')
    self.series_code = attributes[:'series_code']
  else
    self.series_code = nil
  end

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

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

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

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

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

Instance Attribute Details

#assessee_category_code ⇒ Object

Code that represents the entity that is subject to income tax in India. Position: - Character 4 of the PAN Possible values: - "A" for Association of Persons (AOP) - "B" for Body of Individuals (BOI) - "C" for Company - "F" for Firm - "G" for Government - "H" for Hindu Undivided Family (HUF) - "J" for Artificial Juridical Person - "L" for Local Authority - "P" for Individual - "T" for Trust



22
23
24
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 22

def assessee_category_code
  @assessee_category_code
end

#assessee_category_name ⇒ Object

Human-readable label for the assessee category when it matches a known code. Possible values: - Association of Persons (AOP) - Body of Individuals (BOI) - Company - Firm - Government - Hindu Undivided Family (HUF) - Artificial Juridical Person - Local Authority - Individual - Trust Omitted when the letter is not a standard category code.



25
26
27
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 25

def assessee_category_name
  @assessee_category_name
end

#check_letter ⇒ Object

Alphabetic check character for the first nine characters of the PAN. The algorithm has not been made publicly available by the Income Tax Department of India. Position: - Character 10 of the PAN. Possible values: - One uppercase Latin letter A through Z



34
35
36
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 34

def check_letter
  @check_letter
end

#name_prefix_letter ⇒ Object

First letter of the name of the entity that is subject to income tax in India. Position: - Character 5 of the PAN. Format: - When AssesseeCategoryCode is P, this character is the first letter of the individual’s family name as recorded for the PAN. - When AssesseeCategoryCode is A, B, C, F, G, H, J, L, or T, this character is the first letter of the name of the association, body, company, firm, government, HUF, local authority, or trust. Possible values: - Any uppercase Latin letter



28
29
30
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 28

def name_prefix_letter
  @name_prefix_letter
end

#serial_number ⇒ Object

Sequential four-digit field assigned by the Income Tax Department of India. Each PAN receives a unique serial within the given series code and assessee category. Position: - Characters 6 through 9 of the PAN. Possible values: - Four-digit strings 0001 through 9999 inclusive, using only digits 0 through 9



31
32
33
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 31

def serial_number
  @serial_number
end

#series_code ⇒ Object

Three-letter block issued by the Income Tax Department of India. Ties the number to a specific Income Tax Office or jurisdiction using an internal labeling system. Position: - Characters 1 through 3 of the PAN Possible values: - Any three-letter block of uppercase Latin letters



19
20
21
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 19

def series_code
  @series_code
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



49
50
51
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 37

def self.attribute_map
  {
    :'series_code' => :'seriesCode',
    :'assessee_category_code' => :'assesseeCategoryCode',
    :'assessee_category_name' => :'assesseeCategoryName',
    :'name_prefix_letter' => :'namePrefixLetter',
    :'serial_number' => :'serialNumber',
    :'check_letter' => :'checkLetter'
  }
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 246

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



71
72
73
74
75
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 71

def self.openapi_nullable
  Set.new([
    :'assessee_category_name',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 59

def self.openapi_types
  {
    :'series_code' => :'String',
    :'assessee_category_code' => :'String',
    :'assessee_category_name' => :'String',
    :'name_prefix_letter' => :'String',
    :'serial_number' => :'String',
    :'check_letter' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      series_code == o.series_code &&
      assessee_category_code == o.assessee_category_code &&
      assessee_category_name == o.assessee_category_name &&
      name_prefix_letter == o.name_prefix_letter &&
      serial_number == o.serial_number &&
      check_letter == o.check_letter
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


233
234
235
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 239

def hash
  [series_code, assessee_category_code, assessee_category_name, name_prefix_letter, serial_number, check_letter].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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 130

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

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

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

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

  if @check_letter.nil?
    invalid_properties.push('invalid value for "check_letter", check_letter cannot be nil.')
  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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 268

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



158
159
160
161
162
163
164
165
166
 
# File 'lib/trinsic_api/models/india_pan_structured_number.rb', line 158

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @series_code.nil?
  return false if @assessee_category_code.nil?
  return false if @name_prefix_letter.nil?
  return false if @serial_number.nil?
  return false if @check_letter.nil?
  true
end