class UltracartClient::OauthTokenResponse

Attributes

access_token[RW]

Access token to use in OAuth authenticated API call

error[RW]
error_description[RW]
error_uri[RW]
expires_in[RW]

The number of seconds since issuance when the access token will expire and need to be refreshed using the refresh token

refresh_token[RW]

The refresh token that should be used to fetch a new access token when the expiration occurs

scope[RW]

The scope of permissions associated with teh access token

token_type[RW]

Type of token

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/oauth_token_response.rb, line 61
def self.attribute_map
  {
    :'access_token' => :'access_token',
    :'error' => :'error',
    :'error_description' => :'error_description',
    :'error_uri' => :'error_uri',
    :'expires_in' => :'expires_in',
    :'refresh_token' => :'refresh_token',
    :'scope' => :'scope',
    :'token_type' => :'token_type'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ultracart_api/models/oauth_token_response.rb, line 90
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'error')
    self.error = attributes[:'error']
  end

  if attributes.has_key?(:'error_description')
    self.error_description = attributes[:'error_description']
  end

  if attributes.has_key?(:'error_uri')
    self.error_uri = attributes[:'error_uri']
  end

  if attributes.has_key?(:'expires_in')
    self.expires_in = attributes[:'expires_in']
  end

  if attributes.has_key?(:'refresh_token')
    self.refresh_token = attributes[:'refresh_token']
  end

  if attributes.has_key?(:'scope')
    self.scope = attributes[:'scope']
  end

  if attributes.has_key?(:'token_type')
    self.token_type = attributes[:'token_type']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/oauth_token_response.rb, line 75
def self.swagger_types
  {
    :'access_token' => :'String',
    :'error' => :'String',
    :'error_description' => :'String',
    :'error_uri' => :'String',
    :'expires_in' => :'String',
    :'refresh_token' => :'String',
    :'scope' => :'String',
    :'token_type' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/oauth_token_response.rb, line 156
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_token == o.access_token &&
      error == o.error &&
      error_description == o.error_description &&
      error_uri == o.error_uri &&
      expires_in == o.expires_in &&
      refresh_token == o.refresh_token &&
      scope == o.scope &&
      token_type == o.token_type
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/ultracart_api/models/oauth_token_response.rb, line 205
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
    temp_model = UltracartClient.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/ultracart_api/models/oauth_token_response.rb, line 271
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/ultracart_api/models/oauth_token_response.rb, line 184
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/ultracart_api/models/oauth_token_response.rb, line 171
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/oauth_token_response.rb, line 177
def hash
  [access_token, error, error_description, error_uri, expires_in, refresh_token, scope, token_type].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/ultracart_api/models/oauth_token_response.rb, line 131
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/ultracart_api/models/oauth_token_response.rb, line 251
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/ultracart_api/models/oauth_token_response.rb, line 257
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/ultracart_api/models/oauth_token_response.rb, line 245
def to_s
  to_hash.to_s
end
token_type=(token_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] token_type Object to be assigned

# File lib/ultracart_api/models/oauth_token_response.rb, line 146
def token_type=(token_type)
  validator = EnumAttributeValidator.new('String', ['bearer'])
  unless validator.valid?(token_type)
    fail ArgumentError, 'invalid value for "token_type", must be one of #{validator.allowable_values}.'
  end
  @token_type = token_type
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/ultracart_api/models/oauth_token_response.rb, line 138
def valid?
  token_type_validator = EnumAttributeValidator.new('String', ['bearer'])
  return false unless token_type_validator.valid?(@token_type)
  true
end