class AsposeEmailCloud::EmailClientAccountOauthCredentials

Represents email client account OAuth 2.0 credentials

Attributes

client_id[RW]

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

@return [String]

client_secret[RW]

The client secret obtained during application registration.

@return [String]

login[RW]

Email client account login

@return [String]

refresh_token[RW]

OAuth 2.0 refresh token

@return [String]

request_url[RW]

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

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# 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
new( login: nil, client_id: nil, client_secret: nil, refresh_token: nil, request_url: nil) click to toggle source

Initializes the object @param [String] login Email client account login

@param [String] client_id The client ID obtained from the Google Cloud Console during application registration.

@param [String] client_secret The client secret obtained during application registration.

@param [String] refresh_token OAuth 2.0 refresh token

@param [String] request_url The url to obtain access token. If not specified, will try to discover from email client account host.

# 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.login = login if login
  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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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 &&
      login == o.login &&
      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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
client_id=(client_id) click to toggle source

Custom attribute writer method with validation @param [Object] client_id Value to be assigned

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 170
def client_id=(client_id)
  if client_id.nil?
    fail ArgumentError, 'client_id cannot be nil'
  end

  if client_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "client_id", the character length must be great than or equal to 1.'
  end

  @client_id = client_id
end
client_secret=(client_secret) click to toggle source

Custom attribute writer method with validation @param [Object] client_secret Value to be assigned

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 184
def client_secret=(client_secret)
  if client_secret.nil?
    fail ArgumentError, 'client_secret cannot be nil'
  end

  if client_secret.to_s.length < 1
    fail ArgumentError, 'invalid value for "client_secret", the character length must be great than or equal to 1.'
  end

  @client_secret = client_secret
end
discriminator() click to toggle source
# 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) click to toggle source
# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 225
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 231
def hash
  [login, discriminator, client_id, client_secret, refresh_token, request_url].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
login=(login) click to toggle source

Custom attribute writer method with validation @param [Object] login Value to be assigned

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 156
def login=(login)
  if login.nil?
    fail ArgumentError, 'login cannot be nil'
  end

  if login.to_s.length < 1
    fail ArgumentError, 'invalid value for "login", the character length must be great than or equal to 1.'
  end

  @login = login
end
refresh_token=(refresh_token) click to toggle source

Custom attribute writer method with validation @param [Object] refresh_token Value to be assigned

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 198
def refresh_token=(refresh_token)
  if refresh_token.nil?
    fail ArgumentError, 'refresh_token cannot be nil'
  end

  if refresh_token.to_s.length < 1
    fail ArgumentError, 'invalid value for "refresh_token", the character length must be great than or equal to 1.'
  end

  @refresh_token = refresh_token
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 311
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose-email-cloud/models/email_client_account_oauth_credentials.rb, line 305
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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