Class: SquareConnect::ObtainTokenRequest
- Inherits:
-
Object
- Object
- SquareConnect::ObtainTokenRequest
- Defined in:
- lib/square_connect/models/obtain_token_request.rb
Instance Attribute Summary collapse
-
#client_id ⇒ Object
The Square-issued ID of your application, available from the [application dashboard](connect.squareup.com/apps).
-
#client_secret ⇒ Object
The Square-issued application secret for your application, available from the [application dashboard](connect.squareup.com/apps).
-
#code ⇒ Object
The authorization code to exchange.
-
#grant_type ⇒ Object
Specifies the method to request an OAuth access token.
-
#migration_token ⇒ Object
Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13.
-
#redirect_uri ⇒ Object
The redirect URL assigned in the [application dashboard](connect.squareup.com/apps).
-
#refresh_token ⇒ Object
A valid refresh token for generating a new OAuth access token.
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 = {}) ⇒ ObtainTokenRequest
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 = {}) ⇒ ObtainTokenRequest
Initializes the object
65 66 67 68 69 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 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 65 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?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.has_key?(:'client_secret') self.client_secret = attributes[:'client_secret'] end if attributes.has_key?(:'code') self.code = attributes[:'code'] end if attributes.has_key?(:'redirect_uri') self.redirect_uri = attributes[:'redirect_uri'] end if attributes.has_key?(:'grant_type') self.grant_type = attributes[:'grant_type'] end if attributes.has_key?(:'refresh_token') self.refresh_token = attributes[:'refresh_token'] end if attributes.has_key?(:'migration_token') self.migration_token = attributes[:'migration_token'] end end |
Instance Attribute Details
#client_id ⇒ Object
The Square-issued ID of your application, available from the [application dashboard](connect.squareup.com/apps).
16 17 18 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 16 def client_id @client_id end |
#client_secret ⇒ Object
The Square-issued application secret for your application, available from the [application dashboard](connect.squareup.com/apps).
19 20 21 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 19 def client_secret @client_secret end |
#code ⇒ Object
The authorization code to exchange. This is required if ‘grant_type` is set to `authorization_code`, to indicate that the application wants to exchange an authorization code for an OAuth access token.
22 23 24 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 22 def code @code end |
#grant_type ⇒ Object
Specifies the method to request an OAuth access token. Valid values are: ‘authorization_code`, `refresh_token`, and `migration_token`
28 29 30 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 28 def grant_type @grant_type end |
#migration_token ⇒ Object
Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if ‘grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration).
34 35 36 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 34 def migration_token @migration_token end |
#redirect_uri ⇒ Object
The redirect URL assigned in the [application dashboard](connect.squareup.com/apps).
25 26 27 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 25 def redirect_uri @redirect_uri end |
#refresh_token ⇒ Object
A valid refresh token for generating a new OAuth access token. A valid refresh token is required if ‘grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token.
31 32 33 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 31 def refresh_token @refresh_token end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 38 def self.attribute_map { :'client_id' => :'client_id', :'client_secret' => :'client_secret', :'code' => :'code', :'redirect_uri' => :'redirect_uri', :'grant_type' => :'grant_type', :'refresh_token' => :'refresh_token', :'migration_token' => :'migration_token' } end |
.swagger_types ⇒ Object
Attribute type mapping.
51 52 53 54 55 56 57 58 59 60 61 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 51 def self.swagger_types { :'client_id' => :'String', :'client_secret' => :'String', :'code' => :'String', :'redirect_uri' => :'String', :'grant_type' => :'String', :'refresh_token' => :'String', :'migration_token' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 131 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && client_secret == o.client_secret && code == o.code && redirect_uri == o.redirect_uri && grant_type == o.grant_type && refresh_token == o.refresh_token && migration_token == o.migration_token end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 211 212 213 214 215 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 179 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
245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 245 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
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 158 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
145 146 147 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 145 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
151 152 153 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 151 def hash [client_id, client_secret, code, redirect_uri, grant_type, refresh_token, migration_token].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 103 def list_invalid_properties invalid_properties = Array.new if @client_id.nil? invalid_properties.push("invalid value for 'client_id', client_id cannot be nil.") end if @client_secret.nil? invalid_properties.push("invalid value for 'client_secret', client_secret cannot be nil.") end if @grant_type.nil? invalid_properties.push("invalid value for 'grant_type', grant_type cannot be nil.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
225 226 227 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 225 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
231 232 233 234 235 236 237 238 239 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 231 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
219 220 221 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 219 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
122 123 124 125 126 127 |
# File 'lib/square_connect/models/obtain_token_request.rb', line 122 def valid? return false if @client_id.nil? return false if @client_secret.nil? return false if @grant_type.nil? return true end |