Class: Zernio::GetWhatsAppNumberKycForm200ResponseFieldsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ GetWhatsAppNumberKycForm200ResponseFieldsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



107
108
109
110
111
112
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
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 107

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

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

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

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

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

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

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

Instance Attribute Details

#audience ⇒ Object

When set, the requirement applies ONLY to this end-user type — provide it for that type and OMIT it for the other (e.g. Brazil: "Cartão CNPJ" is business-only, "CPF" and "ID/Passport Copy" are personal-only). Submitting both sets makes the regulator ask whether the number is for personal or business use and stalls the review. Pass entityType on POST so the server drops the inapplicable set.



35
36
37
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 35

def audience
  @audience
end

#description ⇒ Object

Plain-English explanation of what to provide.



26
27
28
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 26

def description
  @description
end

#example ⇒ Object

Concrete example value.



29
30
31
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 29

def example
  @example
end

#kind ⇒ Object

"action" = an out-of-band verification (e.g. Onfido); not filled here, fulfilled after the order via a link.



23
24
25
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 23

def kind
  @kind
end

#label ⇒ Object

Returns the value of attribute label.



20
21
22
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 20

def label
  @label
end

#local_to ⇒ Object

ISO country the value must be local to



32
33
34
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 32

def local_to
  @local_to
end

#requirement_id ⇒ Object

Returns the value of attribute requirement_id.



18
19
20
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 18

def requirement_id
  @requirement_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



73
74
75
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 73

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 78

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 60

def self.attribute_map
  {
    :'requirement_id' => :'requirementId',
    :'label' => :'label',
    :'kind' => :'kind',
    :'description' => :'description',
    :'example' => :'example',
    :'local_to' => :'localTo',
    :'audience' => :'audience'
  }
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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 218

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



96
97
98
99
100
101
102
103
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 96

def self.openapi_nullable
  Set.new([
    :'description',
    :'example',
    :'local_to',
    :'audience'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 83

def self.openapi_types
  {
    :'requirement_id' => :'String',
    :'label' => :'String',
    :'kind' => :'String',
    :'description' => :'String',
    :'example' => :'String',
    :'local_to' => :'String',
    :'audience' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      requirement_id == o.requirement_id &&
      label == o.label &&
      kind == o.kind &&
      description == o.description &&
      example == o.example &&
      local_to == o.local_to &&
      audience == o.audience
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


205
206
207
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 211

def hash
  [requirement_id, label, kind, description, example, local_to, audience].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



152
153
154
155
156
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 152

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 240

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



160
161
162
163
164
165
166
167
 
# File 'lib/zernio-sdk/models/get_whats_app_number_kyc_form200_response_fields_inner.rb', line 160

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  kind_validator = EnumAttributeValidator.new('String', ["text", "date", "address", "file", "action"])
  return false unless kind_validator.valid?(@kind)
  audience_validator = EnumAttributeValidator.new('String', ["business", "individual"])
  return false unless audience_validator.valid?(@audience)
  true
end