Class: ThePlaidApi::CraMonitoringInsightsSubscribeRequest

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

Overview

CraMonitoringInsightsSubscribeRequest defines the request schema for ‘/cra/monitoring_insights/subscribe`

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:, client_id: SKIP, secret: SKIP, user_id: SKIP, item_id: SKIP, income_categories: SKIP, user_token: SKIP, additional_properties: nil) ⇒ CraMonitoringInsightsSubscribeRequest

Returns a new instance of CraMonitoringInsightsSubscribeRequest.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 85

def initialize(webhook:, client_id: SKIP, secret: SKIP, user_id: SKIP,
               item_id: SKIP, income_categories: SKIP, user_token: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @client_id = client_id unless client_id == SKIP
  @secret = secret unless secret == SKIP
  @user_id = user_id unless user_id == SKIP
  @item_id = item_id unless item_id == SKIP
  @webhook = webhook
  @income_categories = income_categories unless income_categories == SKIP
  @user_token = user_token unless user_token == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#client_id ⇒ String

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

  • (String) 


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

def client_id
  @client_id
end

#income_categories ⇒ Array[CreditBankIncomeCategory]

Income categories to include in Cash Flow Updates. If empty or ‘null`, this field will default to including all possible categories.

Returns:



43
44
45
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 43

def income_categories
  @income_categories
end

#item_id ⇒ String

The item ID to subscribe for Cash Flow Updates.

Returns:

  • (String) 


33
34
35
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 33

def item_id
  @item_id
end

#secret ⇒ String

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

  • (String) 


22
23
24
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 22

def secret
  @secret
end

#user_id ⇒ String

A unique user identifier, created by ‘/user/create`. Integrations that began using `/user/create` after December 10, 2025 use this field to identify a user instead of the `user_token`. For more details, see [new user APIs](plaid.com/docs/api/users/user-apis).

Returns:

  • (String) 


29
30
31
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 29

def user_id
  @user_id
end

#user_token ⇒ String

The user token associated with the User data is being requested for. This field is used only by customers with pre-existing integrations that already use the ‘user_token` field. All other customers should use the `user_id` instead. For more details, see [New User APIs](plaid.com/docs/api/users/user-apis).

Returns:

  • (String) 


51
52
53
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 51

def user_token
  @user_token
end

#webhook ⇒ String

URL to which Plaid will send Cash Flow Updates webhooks, for example when the requested Cash Flow Updates report is ready.

Returns:

  • (String) 


38
39
40
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 38

def webhook
  @webhook
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 102

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  webhook = hash.key?('webhook') ? hash['webhook'] : nil
  client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
  secret = hash.key?('secret') ? hash['secret'] : SKIP
  user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
  item_id = hash.key?('item_id') ? hash['item_id'] : SKIP
  income_categories =
    hash.key?('income_categories') ? hash['income_categories'] : SKIP
  user_token = hash.key?('user_token') ? hash['user_token'] : SKIP

  # 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.
  CraMonitoringInsightsSubscribeRequest.new(webhook: webhook,
                                            client_id: client_id,
                                            secret: secret,
                                            user_id: user_id,
                                            item_id: item_id,
                                            income_categories: income_categories,
                                            user_token: user_token,
                                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 54

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['secret'] = 'secret'
  @_hash['user_id'] = 'user_id'
  @_hash['item_id'] = 'item_id'
  @_hash['webhook'] = 'webhook'
  @_hash['income_categories'] = 'income_categories'
  @_hash['user_token'] = 'user_token'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



79
80
81
82
83
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 79

def self.nullables
  %w[
    income_categories
  ]
end

.optionals ⇒ Object

An array for optional fields



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 67

def self.optionals
  %w[
    client_id
    secret
    user_id
    item_id
    income_categories
    user_token
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



142
143
144
145
146
147
148
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 142

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, user_id:"\
  " #{@user_id.inspect}, item_id: #{@item_id.inspect}, webhook: #{@webhook.inspect},"\
  " income_categories: #{@income_categories.inspect}, user_token: #{@user_token.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



134
135
136
137
138
139
 
# File 'lib/the_plaid_api/models/cra_monitoring_insights_subscribe_request.rb', line 134

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, user_id: #{@user_id},"\
  " item_id: #{@item_id}, webhook: #{@webhook}, income_categories: #{@income_categories},"\
  " user_token: #{@user_token}, additional_properties: #{@additional_properties}>"
end