Class: Zernio::CreatePhoneNumberKycLinkRequest

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/zernio-sdk/models/create_phone_number_kyc_link_request.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 = {}) ⇒ CreatePhoneNumberKycLinkRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 98

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

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

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

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

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

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

Instance Attribute Details

#area_code ⇒ Object

Area code (NDC) the eventual number must be in. Hard constraint carried by the link; the end customer filling the form makes no area choice. Options come from GET /v1/phone-numbers/availability (areaOptions).



24
25
26
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 24

def area_code
  @area_code
end

#branding ⇒ Object

Returns the value of attribute branding.



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

def branding
  @branding
end

#country ⇒ Object

ISO 3166-1 alpha-2 country code (must be a regulated/KYC country).



21
22
23
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 21

def country
  @country
end

#language ⇒ Object

Language of the hosted page: its copy, the carrier requirement texts (translated once per country and cached), the pre-submit review notes and the status emails to the end customer. Omitted: the browser language of the end customer, falling back to English. The end customer can also switch with ?lang= on the page.



27
28
29
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 27

def language
  @language
end

#profile_id ⇒ Object

Returns the value of attribute profile_id.



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

def profile_id
  @profile_id
end

#redirect_url ⇒ Object

Where to send the end customer's browser after a successful submit. On completion Zernio appends kyc=submitted and country=<ISO-2> as query params. When omitted, the hosted page shows a built-in confirmation screen instead.



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

def redirect_url
  @redirect_url
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



69
70
71
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 69

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 74

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 57

def self.attribute_map
  {
    :'profile_id' => :'profileId',
    :'country' => :'country',
    :'area_code' => :'areaCode',
    :'language' => :'language',
    :'branding' => :'branding',
    :'redirect_url' => :'redirect_url'
  }
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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 265

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



91
92
93
94
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 79

def self.openapi_types
  {
    :'profile_id' => :'String',
    :'country' => :'String',
    :'area_code' => :'String',
    :'language' => :'String',
    :'branding' => :'CreatePhoneNumberKycLinkRequestBranding',
    :'redirect_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      profile_id == o.profile_id &&
      country == o.country &&
      area_code == o.area_code &&
      language == o.language &&
      branding == o.branding &&
      redirect_url == o.redirect_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 252

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



258
259
260
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 258

def hash
  [profile_id, country, area_code, language, branding, redirect_url].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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 143

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

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

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

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

  pattern = Regexp.new(/^\d{1,4}$/)
  if !@area_code.nil? && @area_code !~ pattern
    invalid_properties.push("invalid value for \"area_code\", must conform to the pattern #{pattern}.")
  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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 287

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



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/zernio-sdk/models/create_phone_number_kyc_link_request.rb', line 172

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @profile_id.nil?
  return false if @country.nil?
  return false if @country.to_s.length > 2
  return false if @country.to_s.length < 2
  return false if !@area_code.nil? && @area_code !~ Regexp.new(/^\d{1,4}$/)
  language_validator = EnumAttributeValidator.new('String', ["en", "es", "pt-BR"])
  return false unless language_validator.valid?(@language)
  true
end