Class: ThePlaidApi::BankIncomeRefreshCompleteWebhook

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb

Overview

Fired when a refreshed bank income report has finished generating or failed to generate, triggered by calling ‘/credit/bank_income/refresh`. To get this webhook, subscribe via the [Dashboard](dashboard.plaid.com/developers/webhooks).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(webhook_type:, webhook_code:, user_id:, result:, environment:, additional_properties: nil) ⇒ BankIncomeRefreshCompleteWebhook

Returns a new instance of BankIncomeRefreshCompleteWebhook.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 59

def initialize(webhook_type:, webhook_code:, user_id:, result:,
               environment:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @webhook_type = webhook_type
  @webhook_code = webhook_code
  @user_id = user_id
  @result = result
  @environment = environment
  @additional_properties = additional_properties
end

Instance Attribute Details

#environment ⇒ WebhookEnvironmentValues

The Plaid environment the webhook was sent from

Returns:



36
37
38
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 36

def environment
  @environment
end

#result ⇒ BankIncomeRefreshCompleteResult

The result of the bank income refresh report generation ‘SUCCESS`: The refreshed report was successfully generated and can be retrieved via `/credit/bank_income/get`. `FAILURE`: The refreshed report failed to be generated

Returns:



32
33
34
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 32

def result
  @result
end

#user_id ⇒ String

The ‘user_id` corresponding to the user the webhook has fired for.

Returns:

  • (String) 


25
26
27
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 25

def user_id
  @user_id
end

#webhook_code ⇒ String

‘BANK_INCOME_REFRESH_COMPLETE`

Returns:

  • (String) 


21
22
23
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 21

def webhook_code
  @webhook_code
end

#webhook_type ⇒ String

‘INCOME`

Returns:

  • (String) 


17
18
19
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 17

def webhook_type
  @webhook_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  webhook_type = hash.key?('webhook_type') ? hash['webhook_type'] : nil
  webhook_code = hash.key?('webhook_code') ? hash['webhook_code'] : nil
  user_id = hash.key?('user_id') ? hash['user_id'] : nil
  result = hash.key?('result') ? hash['result'] : nil
  environment = hash.key?('environment') ? hash['environment'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  BankIncomeRefreshCompleteWebhook.new(webhook_type: webhook_type,
                                       webhook_code: webhook_code,
                                       user_id: user_id,
                                       result: result,
                                       environment: environment,
                                       additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



39
40
41
42
43
44
45
46
47
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 39

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['webhook_type'] = 'webhook_type'
  @_hash['webhook_code'] = 'webhook_code'
  @_hash['user_id'] = 'user_id'
  @_hash['result'] = 'result'
  @_hash['environment'] = 'environment'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



55
56
57
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 55

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



50
51
52
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 50

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



108
109
110
111
112
113
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 108

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} webhook_type: #{@webhook_type.inspect}, webhook_code:"\
  " #{@webhook_code.inspect}, user_id: #{@user_id.inspect}, result: #{@result.inspect},"\
  " environment: #{@environment.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



100
101
102
103
104
105
 
# File 'lib/the_plaid_api/models/bank_income_refresh_complete_webhook.rb', line 100

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} webhook_type: #{@webhook_type}, webhook_code: #{@webhook_code}, user_id:"\
  " #{@user_id}, result: #{@result}, environment: #{@environment}, additional_properties:"\
  " #{@additional_properties}>"
end