Class: ZSGFClient::PhoneSignUpRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/zsgf_client/models/phone_sign_up_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PhoneSignUpRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 93

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

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

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

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

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

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

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

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

Instance Attribute Details

#avatarObject

用户头像URL



37
38
39
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 37

def avatar
  @avatar
end

#dataObject

自定义数据



40
41
42
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 40

def data
  @data
end

#emailObject

用户邮箱



28
29
30
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 28

def email
  @email
end

#email_codeObject

邮箱验证码(只有启用的邮箱验证码功能时,才需要传入),长度为4到8位的数字



31
32
33
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 31

def email_code
  @email_code
end

#nick_nameObject

用户昵称



34
35
36
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 34

def nick_name
  @nick_name
end

#phoneObject

用户手机号



19
20
21
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 19

def phone
  @phone
end

#phone_codeObject

手机验证码,长度为4到8位的数字



22
23
24
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 22

def phone_code
  @phone_code
end

#pwdObject

用户密码,长度为6到32个字符



25
26
27
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 25

def pwd
  @pwd
end

Class Method Details

._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



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 389

def self._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 = ZSGFClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



57
58
59
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 57

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



62
63
64
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 62

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 43

def self.attribute_map
  {
    :'phone' => :'phone',
    :'phone_code' => :'phoneCode',
    :'pwd' => :'pwd',
    :'email' => :'email',
    :'email_code' => :'emailCode',
    :'nick_name' => :'nickName',
    :'avatar' => :'avatar',
    :'data' => :'data'
  }
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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 365

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_nullableObject

List of attributes with nullable: true



81
82
83
84
85
86
87
88
89
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 81

def self.openapi_nullable
  Set.new([
    :'email',
    :'email_code',
    :'nick_name',
    :'avatar',
    :'data'
  ])
end

.openapi_typesObject

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 67

def self.openapi_types
  {
    :'phone' => :'String',
    :'phone_code' => :'String',
    :'pwd' => :'String',
    :'email' => :'String',
    :'email_code' => :'String',
    :'nick_name' => :'String',
    :'avatar' => :'String',
    :'data' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



337
338
339
340
341
342
343
344
345
346
347
348
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 337

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone == o.phone &&
      phone_code == o.phone_code &&
      pwd == o.pwd &&
      email == o.email &&
      email_code == o.email_code &&
      nick_name == o.nick_name &&
      avatar == o.avatar &&
      data == o.data
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



460
461
462
463
464
465
466
467
468
469
470
471
472
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 460

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


352
353
354
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 352

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



358
359
360
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 358

def hash
  [phone, phone_code, pwd, email, email_code, nick_name, avatar, data].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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/zsgf_client/models/phone_sign_up_request.rb', line 148

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

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

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

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

  pattern = Regexp.new(/\d{4,8}$/)
  if @phone_code !~ pattern
    invalid_properties.push("invalid value for \"phone_code\", must conform to the pattern #{pattern}.")
  end

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

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

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

  pattern = Regexp.new(/^[a-zA-Z0-9_\-!@#$%^&*()]*$/)
  if @pwd !~ pattern
    invalid_properties.push("invalid value for \"pwd\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/\d{4,8}$/)
  if !@email_code.nil? && @email_code !~ pattern
    invalid_properties.push("invalid value for \"email_code\", must conform to the pattern #{pattern}.")
  end

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

  if !@nick_name.nil? && @nick_name.to_s.length < 4
    invalid_properties.push('invalid value for "nick_name", the character length must be great than or equal to 4.')
  end

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



436
437
438
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 436

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



442
443
444
445
446
447
448
449
450
451
452
453
454
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 442

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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



430
431
432
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 430

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# File 'lib/zsgf_client/models/phone_sign_up_request.rb', line 215

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @phone.nil?
  return false if @phone.to_s.length < 1
  return false if @phone_code.nil?
  return false if @phone_code.to_s.length < 1
  return false if @phone_code !~ Regexp.new(/\d{4,8}$/)
  return false if @pwd.nil?
  return false if @pwd.to_s.length > 32
  return false if @pwd.to_s.length < 6
  return false if @pwd !~ Regexp.new(/^[a-zA-Z0-9_\-!@#$%^&*()]*$/)
  return false if !@email_code.nil? && @email_code !~ Regexp.new(/\d{4,8}$/)
  return false if !@nick_name.nil? && @nick_name.to_s.length > 32
  return false if !@nick_name.nil? && @nick_name.to_s.length < 4
  return false if !@avatar.nil? && @avatar.to_s.length > 999
  return false if !@data.nil? && @data.to_s.length > 9999
  true
end