Class: ZSGFClient::SignUpRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SignUpRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 100

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

  if attributes.key?(:'pwd')
    self.pwd = attributes[:'pwd']
  else
    self.pwd = nil
  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

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

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

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

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

Instance Attribute Details

#avatar ⇒ Object

用户头像URL



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

def avatar
  @avatar
end

#data ⇒ Object

自定义数据



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

def data
  @data
end

#email ⇒ Object

用户邮箱



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

def email
  @email
end

#email_code ⇒ Object

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



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

def email_code
  @email_code
end

#nick_name ⇒ Object

用户昵称，长度不能超过20个字符



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

def nick_name
  @nick_name
end

#phone ⇒ Object

用户手机号，必须为11位数字



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

def phone
  @phone
end

#phone_code ⇒ Object

手机验证码（只有启用的手机验证码功能时，才需要传入），长度为4到8位的数字



43
44
45
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 43

def phone_code
  @phone_code
end

#pwd ⇒ Object

登录密码，长度必须在6到32个字符之间，只能包含字母和数字



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

def pwd
  @pwd
end

#user_name ⇒ Object

用户名，长度必须在6到32个字符之间，只能包含字母、数字、下划线和连字符



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

def user_name
  @user_name
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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 407

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_map ⇒ Object

Returns attribute mapping this model knows about



61
62
63
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 46

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



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 383

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



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 71

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 354

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



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 478

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


370
371
372
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 370

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



376
377
378
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 376

def hash
  [user_name, pwd, nick_name, avatar, data, email, email_code, phone, phone_code].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



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
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 157

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

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

  if @user_name.to_s.length < 6
    invalid_properties.push('invalid value for "user_name", the character length must be great than or equal to 6.')
  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

  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

  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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



454
455
456
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 454

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



448
449
450
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 448

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/zsgf_client/models/sign_up_request.rb', line 225

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @user_name.nil?
  return false if @user_name.to_s.length > 32
  return false if @user_name.to_s.length < 6
  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 !@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
  return false if !@email_code.nil? && @email_code !~ Regexp.new(/\d{4,8}$/)
  return false if !@phone.nil? && @phone !~ Regexp.new(/^(\d{11})?$/)
  return false if !@phone_code.nil? && @phone_code !~ Regexp.new(/\d{4,8}$/)
  true
end