class SquareConnect::ObtainTokenResponse

Attributes

access_token[RW]

A valid OAuth access token. OAuth access tokens are 64 bytes long. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information.

expires_at[RW]

The date when access_token expires, in [ISO 8601](www.iso.org/iso/home/standards/iso8601.htm) format.

id_token[RW]

Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request.

merchant_id[RW]

The ID of the authorizing merchant's business.

plan_id[RW]

__LEGACY FIELD__. The ID of the subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.

refresh_token[RW]

A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).

subscription_id[RW]

__LEGACY FIELD__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.

token_type[RW]

This value is always bearer.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/obtain_token_response.rb, line 41
def self.attribute_map
  {
    :'access_token' => :'access_token',
    :'token_type' => :'token_type',
    :'expires_at' => :'expires_at',
    :'merchant_id' => :'merchant_id',
    :'subscription_id' => :'subscription_id',
    :'plan_id' => :'plan_id',
    :'id_token' => :'id_token',
    :'refresh_token' => :'refresh_token'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/square_connect/models/obtain_token_response.rb, line 70
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?(:'token_type')
    self.token_type = attributes[:'token_type']
  end

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/obtain_token_response.rb, line 55
def self.swagger_types
  {
    :'access_token' => :'String',
    :'token_type' => :'String',
    :'expires_at' => :'String',
    :'merchant_id' => :'String',
    :'subscription_id' => :'String',
    :'plan_id' => :'String',
    :'id_token' => :'String',
    :'refresh_token' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/square_connect/models/obtain_token_response.rb, line 125
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_token == o.access_token &&
      token_type == o.token_type &&
      expires_at == o.expires_at &&
      merchant_id == o.merchant_id &&
      subscription_id == o.subscription_id &&
      plan_id == o.plan_id &&
      id_token == o.id_token &&
      refresh_token == o.refresh_token
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/square_connect/models/obtain_token_response.rb, line 174
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 = SquareConnect.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/square_connect/models/obtain_token_response.rb, line 240
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/square_connect/models/obtain_token_response.rb, line 153
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 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/square_connect/models/obtain_token_response.rb, line 140
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/square_connect/models/obtain_token_response.rb, line 146
def hash
  [access_token, token_type, expires_at, merchant_id, subscription_id, plan_id, id_token, refresh_token].hash
end
list_invalid_properties() click to toggle source

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

# File lib/square_connect/models/obtain_token_response.rb, line 112
def list_invalid_properties
  invalid_properties = Array.new
  return 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/square_connect/models/obtain_token_response.rb, line 220
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/square_connect/models/obtain_token_response.rb, line 226
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/square_connect/models/obtain_token_response.rb, line 214
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/square_connect/models/obtain_token_response.rb, line 119
def valid?
  return true
end