Class: AsposeEmailCloud::EmailClientAccountOauthCredentials

Inherits:
EmailClientAccountCredentials show all
Defined in:
lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb

Overview

Represents email client account OAuth 2.0 credentials

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(login: nil, client_id: nil, client_secret: nil, refresh_token: nil, request_url: nil) ⇒ EmailClientAccountOauthCredentials

Initializes the object

Parameters:

  • login (String) (defaults to: nil) —

    Email client account login

  • client_id (String) (defaults to: nil) —

    The client ID obtained from the Google Cloud Console during application registration.

  • client_secret (String) (defaults to: nil) —

    The client secret obtained during application registration.

  • refresh_token (String) (defaults to: nil) —

    OAuth 2.0 refresh token

  • request_url (String) (defaults to: nil) —

    The url to obtain access token. If not specified, will try to discover from email client account host.



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 83

def initialize(
  login: nil,
  client_id: nil,
  client_secret: nil,
  refresh_token: nil,
  request_url: nil)
  self. =  if 
  self.client_id = client_id if client_id
  self.client_secret = client_secret if client_secret
  self.refresh_token = refresh_token if refresh_token
  self.request_url = request_url if request_url
end

Instance Attribute Details

#client_id ⇒ String

The client ID obtained from the Google Cloud Console during application registration.

Returns:

  • (String) 


43
44
45
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 43

def client_id
  @client_id
end

#client_secret ⇒ String

The client secret obtained during application registration.

Returns:

  • (String) 


46
47
48
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 46

def client_secret
  @client_secret
end

#login ⇒ String

Email client account login

Returns:

  • (String) 


33
34
35
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 33

def 
  @login
end

#refresh_token ⇒ String

OAuth 2.0 refresh token

Returns:

  • (String) 


49
50
51
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 49

def refresh_token
  @refresh_token
end

#request_url ⇒ String

The url to obtain access token. If not specified, will try to discover from email client account host.

Returns:

  • (String) 


52
53
54
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 52

def request_url
  @request_url
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 54

def self.attribute_map
  {
    :'login' => :'login',
    :'discriminator' => :'discriminator',
    :'client_id' => :'clientId',
    :'client_secret' => :'clientSecret',
    :'refresh_token' => :'refreshToken',
    :'request_url' => :'requestUrl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 66

def self.swagger_types
  {
    :'login' => :'String',
    :'discriminator' => :'String',
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'refresh_token' => :'String',
    :'request_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 212

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      discriminator == o.discriminator &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      refresh_token == o.refresh_token &&
      request_url == o.request_url
end

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



261
262
263
264
265
266
267
268
269
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
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 261

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 331

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

#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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 238

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#discriminator ⇒ Object

getter method



34
35
36
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 34

def discriminator #getter method
  self.class.name.split('::').last
end

#discriminator=(discriminator) ⇒ Object

setter method, parameter ignored



38
39
40
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 38

def discriminator=(discriminator) #setter method, parameter ignored
  @discriminator = self.class.name.split('::').last
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


225
226
227
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 231

def hash
  [, discriminator, client_id, client_secret, refresh_token, request_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



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
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 98

def list_invalid_properties
  invalid_properties = Array.new
  if @login.nil?
    invalid_properties.push('invalid value for "login", login cannot be nil.')
  end

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

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

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

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

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

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

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

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



311
312
313
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 311

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



317
318
319
320
321
322
323
324
325
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 317

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



305
306
307
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 305

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



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb', line 141

def valid?
  return false if @login.nil?
  return false if @login.to_s.length < 1
  return false if @discriminator.nil?
  return false if @client_id.nil?
  return false if @client_id.to_s.length < 1
  return false if @client_secret.nil?
  return false if @client_secret.to_s.length < 1
  return false if @refresh_token.nil?
  return false if @refresh_token.to_s.length < 1
  true
end