Class: SquareConnect::ObtainTokenResponse
- Inherits:
-
Object
- Object
- SquareConnect::ObtainTokenResponse
- Defined in:
- lib/square_connect/models/obtain_token_response.rb
Instance Attribute Summary collapse
-
#access_token ⇒ Object
A valid OAuth access token.
-
#expires_at ⇒ Object
The date when access_token expires, in [ISO 8601](www.iso.org/iso/home/standards/iso8601.htm) format.
-
#id_token ⇒ Object
Then OpenID token belonging to this this person.
-
#merchant_id ⇒ Object
The ID of the authorizing merchant’s business.
-
#plan_id ⇒ Object
__LEGACY FIELD__.
-
#refresh_token ⇒ Object
A refresh token.
-
#subscription_id ⇒ Object
__LEGACY FIELD__.
-
#token_type ⇒ Object
This value is always bearer.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ObtainTokenResponse
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ ObtainTokenResponse
Initializes the object
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# 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 |
Instance Attribute Details
#access_token ⇒ Object
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.
16 17 18 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 16 def access_token @access_token end |
#expires_at ⇒ Object
The date when access_token expires, in [ISO 8601](www.iso.org/iso/home/standards/iso8601.htm) format.
22 23 24 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 22 def expires_at @expires_at end |
#id_token ⇒ Object
Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request.
34 35 36 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 34 def id_token @id_token end |
#merchant_id ⇒ Object
The ID of the authorizing merchant’s business.
25 26 27 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 25 def merchant_id @merchant_id end |
#plan_id ⇒ Object
__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.
31 32 33 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 31 def plan_id @plan_id end |
#refresh_token ⇒ Object
A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).
37 38 39 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 37 def refresh_token @refresh_token end |
#subscription_id ⇒ Object
__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.
28 29 30 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 28 def subscription_id @subscription_id end |
#token_type ⇒ Object
This value is always bearer.
19 20 21 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 19 def token_type @token_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
41 42 43 44 45 46 47 48 49 50 51 52 |
# 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 |
.swagger_types ⇒ Object
Attribute type mapping.
55 56 57 58 59 60 61 62 63 64 65 66 |
# 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 |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
125 126 127 128 129 130 131 132 133 134 135 136 |
# 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) ⇒ Object
Deserializes the data based on type
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
240 241 242 243 244 245 246 247 248 249 250 251 252 |
# 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) ⇒ Object
Builds the object from hash
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# 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) ⇒ Boolean
140 141 142 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 140 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
146 147 148 |
# 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 ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
112 113 114 115 |
# 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 ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
220 221 222 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 220 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
226 227 228 229 230 231 232 233 234 |
# 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 ⇒ String
Returns the string representation of the object
214 215 216 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 214 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
119 120 121 |
# File 'lib/square_connect/models/obtain_token_response.rb', line 119 def valid? return true end |