Class: CyberSource::CreateAccessTokenRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/create_access_token_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAccessTokenRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 56

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?(:'grant_type')
    self.grant_type = attributes[:'grant_type']
  end

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

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

Instance Attribute Details

#client_id ⇒ Object

The client ID that you received when you registered your application in the CyberSource Business Center. This identifies your client application.



18
19
20
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 18

def client_id
  @client_id
end

#client_secret ⇒ Object

The client secret that you received when you registered your application in the CyberSource Business Center.



21
22
23
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 21

def client_secret
  @client_secret
end

#code ⇒ Object

This value is sent by CyberSource in the redirect URL. For security reasons, the code expires in 10 minutes. If it expires, you must repeat the redirect to request another. Conditional. This value is equired if grant_type is ‘authorization_code`.



27
28
29
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 27

def code
  @code
end

#grant_type ⇒ Object

The grant type value determines which type of flow is used to obtain the access token. The first time your application requests a token, use the value ‘authorization_code`. When you use this value, you must also include the `code` field in the request. For subsequent request, use `refresh_token`. When you use this value, you must also include the `refresh_token` field in the request. Valid values: - authorization_code - refresh_token



24
25
26
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 24

def grant_type
  @grant_type
end

#refresh_token ⇒ Object

Conditional. Required if grant_type is ‘refresh_token`.



30
31
32
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 30

def refresh_token
  @refresh_token
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 33

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'client_secret' => :'client_secret',
    :'grant_type' => :'grant_type',
    :'code' => :'code',
    :'refresh_token' => :'refresh_token'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 44

def self.swagger_types
  {
    :'client_id' => :'String',
    :'client_secret' => :'String',
    :'grant_type' => :'String',
    :'code' => :'String',
    :'refresh_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      client_secret == o.client_secret &&
      grant_type == o.grant_type &&
      code == o.code &&
      refresh_token == o.refresh_token
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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/cybersource_rest_client/models/create_access_token_request.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 = CyberSource.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


140
141
142
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 146

def hash
  [client_id, client_secret, grant_type, code, refresh_token].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 85

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



220
221
222
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 220

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
229
230
231
232
233
234
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.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

Returns:

  • (String) —

    String presentation of the object



214
215
216
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.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

Returns:

  • (Boolean) —

    true if the model is valid



100
101
102
103
104
 
# File 'lib/cybersource_rest_client/models/create_access_token_request.rb', line 100

def valid?
  return false if @client_id.nil?
  return false if @client_secret.nil?
  true
end