Class: ZSGFClient::UserAccessToken

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

Overview

用户令牌实体，用于管理用户的访问令牌及其相关信息。

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UserAccessToken

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 109

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_token ⇒ Object

访问令牌的具体值，用于身份验证。



35
36
37
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 35

def access_token
  @access_token
end

#create_date ⇒ Object

令牌的创建日期，默认为当前时间。



47
48
49
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 47

def create_date
  @create_date
end

#description ⇒ Object

令牌的详细描述信息。



41
42
43
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 41

def description
  @description
end

#enable ⇒ Object

指示令牌是否处于启用状态。



26
27
28
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 26

def enable
  @enable
end

#expire_time ⇒ Object

令牌的过期时间，超过该时间令牌将失效。



44
45
46
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 44

def expire_time
  @expire_time
end

#id ⇒ Object

用户令牌的唯一标识符。



20
21
22
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 20

def id
  @id
end

#last_update ⇒ Object

令牌的最后更新日期，默认为当前时间。



50
51
52
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 50

def last_update
  @last_update
end

#permissions ⇒ Object

令牌拥有的权限列表，多个权限以逗号分隔。



29
30
31
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 29

def permissions
  @permissions
end

#tags ⇒ Object

用于分类或标记令牌的标签。



38
39
40
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 38

def tags
  @tags
end

#title ⇒ Object

令牌的标题或名称，用于标识令牌。



32
33
34
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 32

def title
  @title
end

#user_id ⇒ Object

与令牌关联的用户ID。



23
24
25
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 23

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 270

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



70
71
72
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 53

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'userID',
    :'enable' => :'enable',
    :'permissions' => :'permissions',
    :'title' => :'title',
    :'access_token' => :'accessToken',
    :'tags' => :'tags',
    :'description' => :'description',
    :'expire_time' => :'expireTime',
    :'create_date' => :'createDate',
    :'last_update' => :'lastUpdate'
  }
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/zsgf_client/models/user_access_token.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



97
98
99
100
101
102
103
104
105
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 97

def self.openapi_nullable
  Set.new([
    :'permissions',
    :'title',
    :'access_token',
    :'tags',
    :'description',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 80

def self.openapi_types
  {
    :'id' => :'Integer',
    :'user_id' => :'Integer',
    :'enable' => :'Boolean',
    :'permissions' => :'String',
    :'title' => :'String',
    :'access_token' => :'String',
    :'tags' => :'String',
    :'description' => :'String',
    :'expire_time' => :'Time',
    :'create_date' => :'Time',
    :'last_update' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      enable == o.enable &&
      permissions == o.permissions &&
      title == o.title &&
      access_token == o.access_token &&
      tags == o.tags &&
      description == o.description &&
      expire_time == o.expire_time &&
      create_date == o.create_date &&
      last_update == o.last_update
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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 341

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


233
234
235
 
# File 'lib/zsgf_client/models/user_access_token.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/zsgf_client/models/user_access_token.rb', line 239

def hash
  [id, user_id, enable, permissions, title, access_token, tags, description, expire_time, create_date, last_update].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



170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 170

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@title.nil? && @title.to_s.length > 255
    invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 255.')
  end

  if !@tags.nil? && @tags.to_s.length > 255
    invalid_properties.push('invalid value for "tags", the character length must be smaller than or equal to 255.')
  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



317
318
319
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 323

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



311
312
313
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 311

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



186
187
188
189
190
191
 
# File 'lib/zsgf_client/models/user_access_token.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@title.nil? && @title.to_s.length > 255
  return false if !@tags.nil? && @tags.to_s.length > 255
  true
end