Class: Plaid::PartnerEndCustomerOAuthStatusUpdatedWebhook

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb

Overview

The webhook of type ‘PARTNER` and code `END_CUSTOMER_OAUTH_STATUS_UPDATED` will be fired when a partner’s end customer has an update on their OAuth registration status with an institution.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartnerEndCustomerOAuthStatusUpdatedWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
115
116
117
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 77

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::PartnerEndCustomerOAuthStatusUpdatedWebhook` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::PartnerEndCustomerOAuthStatusUpdatedWebhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'webhook_type')
    self.webhook_type = attributes[:'webhook_type']
  end

  if attributes.key?(:'webhook_code')
    self.webhook_code = attributes[:'webhook_code']
  end

  if attributes.key?(:'end_customer_client_id')
    self.end_customer_client_id = attributes[:'end_customer_client_id']
  end

  if attributes.key?(:'environment')
    self.environment = attributes[:'environment']
  end

  if attributes.key?(:'institution_id')
    self.institution_id = attributes[:'institution_id']
  end

  if attributes.key?(:'institution_name')
    self.institution_name = attributes[:'institution_name']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end
end

Instance Attribute Details

#end_customer_client_id ⇒ Object

The client ID of the end customer



26
27
28
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 26

def end_customer_client_id
  @end_customer_client_id
end

#environment ⇒ Object

Returns the value of attribute environment.



28
29
30
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 28

def environment
  @environment
end

#institution_id ⇒ Object

The institution ID



31
32
33
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 31

def institution_id
  @institution_id
end

#institution_name ⇒ Object

The institution name



34
35
36
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 34

def institution_name
  @institution_name
end

#status ⇒ Object

Returns the value of attribute status.



36
37
38
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 36

def status
  @status
end

#webhook_code ⇒ Object

‘END_CUSTOMER_OAUTH_STATUS_UPDATED`



23
24
25
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 23

def webhook_code
  @webhook_code
end

#webhook_type ⇒ Object

‘PARTNER`



20
21
22
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 20

def webhook_type
  @webhook_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



52
53
54
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 52

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 39

def self.attribute_map
  {
    :'webhook_type' => :'webhook_type',
    :'webhook_code' => :'webhook_code',
    :'end_customer_client_id' => :'end_customer_client_id',
    :'environment' => :'environment',
    :'institution_id' => :'institution_id',
    :'institution_name' => :'institution_name',
    :'status' => :'status'
  }
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



196
197
198
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 196

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 70

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 57

def self.openapi_types
  {
    :'webhook_type' => :'String',
    :'webhook_code' => :'String',
    :'end_customer_client_id' => :'String',
    :'environment' => :'WebhookEnvironmentValues',
    :'institution_id' => :'String',
    :'institution_name' => :'String',
    :'status' => :'PartnerEndCustomerOAuthStatusUpdatedValues'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 169

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      webhook_type == o.webhook_type &&
      webhook_code == o.webhook_code &&
      end_customer_client_id == o.end_customer_client_id &&
      environment == o.environment &&
      institution_id == o.institution_id &&
      institution_name == o.institution_name &&
      status == o.status
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 226

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 297

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 203

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



189
190
191
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 189

def hash
  [webhook_type, webhook_code, end_customer_client_id, environment, institution_id, institution_name, status].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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 121

def list_invalid_properties
  invalid_properties = Array.new
  if @webhook_type.nil?
    invalid_properties.push('invalid value for "webhook_type", webhook_type cannot be nil.')
  end

  if @webhook_code.nil?
    invalid_properties.push('invalid value for "webhook_code", webhook_code cannot be nil.')
  end

  if @end_customer_client_id.nil?
    invalid_properties.push('invalid value for "end_customer_client_id", end_customer_client_id cannot be nil.')
  end

  if @environment.nil?
    invalid_properties.push('invalid value for "environment", environment cannot be nil.')
  end

  if @institution_id.nil?
    invalid_properties.push('invalid value for "institution_id", institution_id cannot be nil.')
  end

  if @institution_name.nil?
    invalid_properties.push('invalid value for "institution_name", institution_name cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status 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



273
274
275
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 273

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 279

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



267
268
269
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 267

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



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb', line 156

def valid?
  return false if @webhook_type.nil?
  return false if @webhook_code.nil?
  return false if @end_customer_client_id.nil?
  return false if @environment.nil?
  return false if @institution_id.nil?
  return false if @institution_name.nil?
  return false if @status.nil?
  true
end