Class: Increase::Models::EventListParams::Category

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/event_list_params.rb

Defined Under Namespace

Modules: In

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(associated_object_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EventListParams for more details.

Parameters:

  • associated_object_id (String) (defaults to: nil) —

    Filter Events to those belonging to the object with the provided identifier.

  • category (Increase::Models::EventListParams::Category) (defaults to: nil)
  • created_at (Increase::Models::EventListParams::CreatedAt) (defaults to: nil)
  • cursor (String) (defaults to: nil) —

    Return the page of entries after this one.

  • limit (Integer) (defaults to: nil) —

    Limit the size of the list that is returned. The default (and maximum) is 100 ob

  • request_options (Increase::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


55
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
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
118
119
120
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/increase/models/event_list_params.rb', line 55

class Category < Increase::Internal::Type::BaseModel
  # @!attribute in_
  #   Filter Events for those with the specified category or categories. For GET
  #   requests, this should be encoded as a comma-delimited string, such as
  #   `?in=one,two,three`.
  #
  #   @return [Array<Symbol, Increase::Models::EventListParams::Category::In>, nil]
  optional :in_,
           -> { Increase::Internal::Type::ArrayOf[enum: Increase::EventListParams::Category::In] },
           api_name: :in

  # @!method initialize(in_: nil)
  #   Some parameter documentations has been truncated, see
  #   {Increase::Models::EventListParams::Category} for more details.
  #
  #   @param in_ [Array<Symbol, Increase::Models::EventListParams::Category::In>] Filter Events for those with the specified category or categories. For GET reque

  module In
    extend Increase::Internal::Type::Enum

    # Occurs whenever an Account is created.
     = :"account.created"

    # Occurs whenever an Account is updated.
     = :"account.updated"

    # Occurs whenever an Account Number is created.
     = :"account_number.created"

    # Occurs whenever an Account Number is updated.
     = :"account_number.updated"

    # Occurs whenever an Account Statement is created.
     = :"account_statement.created"

    # Occurs whenever an Account Transfer is created.
     = :"account_transfer.created"

    # Occurs whenever an Account Transfer is updated.
     = :"account_transfer.updated"

    # Occurs whenever an ACH Prenotification is created.
    ACH_PRENOTIFICATION_CREATED = :"ach_prenotification.created"

    # Occurs whenever an ACH Prenotification is updated.
    ACH_PRENOTIFICATION_UPDATED = :"ach_prenotification.updated"

    # Occurs whenever an ACH Transfer is created.
    ACH_TRANSFER_CREATED = :"ach_transfer.created"

    # Occurs whenever an ACH Transfer is updated.
    ACH_TRANSFER_UPDATED = :"ach_transfer.updated"

    # Occurs whenever a Bookkeeping Account is created.
     = :"bookkeeping_account.created"

    # Occurs whenever a Bookkeeping Account is updated.
     = :"bookkeeping_account.updated"

    # Occurs whenever a Bookkeeping Entry Set is created.
    BOOKKEEPING_ENTRY_SET_UPDATED = :"bookkeeping_entry_set.updated"

    # Occurs whenever a Card is created.
    CARD_CREATED = :"card.created"

    # Occurs whenever a Card is updated.
    CARD_UPDATED = :"card.updated"

    # Occurs whenever a Card Payment is created.
    CARD_PAYMENT_CREATED = :"card_payment.created"

    # Occurs whenever a Card Payment is updated.
    CARD_PAYMENT_UPDATED = :"card_payment.updated"

    # Occurs whenever a Card Profile is created.
    CARD_PROFILE_CREATED = :"card_profile.created"

    # Occurs whenever a Card Profile is updated.
    CARD_PROFILE_UPDATED = :"card_profile.updated"

    # Occurs whenever a Card Dispute is created.
    CARD_DISPUTE_CREATED = :"card_dispute.created"

    # Occurs whenever a Card Dispute is updated.
    CARD_DISPUTE_UPDATED = :"card_dispute.updated"

    # Occurs whenever a Check Deposit is created.
    CHECK_DEPOSIT_CREATED = :"check_deposit.created"

    # Occurs whenever a Check Deposit is updated.
    CHECK_DEPOSIT_UPDATED = :"check_deposit.updated"

    # Occurs whenever a Check Transfer is created.
    CHECK_TRANSFER_CREATED = :"check_transfer.created"

    # Occurs whenever a Check Transfer is updated.
    CHECK_TRANSFER_UPDATED = :"check_transfer.updated"

    # Occurs whenever a Declined Transaction is created.
    DECLINED_TRANSACTION_CREATED = :"declined_transaction.created"

    # Occurs whenever a Digital Card Profile is created.
    DIGITAL_CARD_PROFILE_CREATED = :"digital_card_profile.created"

    # Occurs whenever a Digital Card Profile is updated.
    DIGITAL_CARD_PROFILE_UPDATED = :"digital_card_profile.updated"

    # Occurs whenever a Digital Wallet Token is created.
    DIGITAL_WALLET_TOKEN_CREATED = :"digital_wallet_token.created"

    # Occurs whenever a Digital Wallet Token is updated.
    DIGITAL_WALLET_TOKEN_UPDATED = :"digital_wallet_token.updated"

    # Occurs whenever a Document is created.
    DOCUMENT_CREATED = :"document.created"

    # Occurs whenever an Entity is created.
    ENTITY_CREATED = :"entity.created"

    # Occurs whenever an Entity is updated.
    ENTITY_UPDATED = :"entity.updated"

    # Occurs whenever an Event Subscription is created.
    EVENT_SUBSCRIPTION_CREATED = :"event_subscription.created"

    # Occurs whenever an Event Subscription is updated.
    EVENT_SUBSCRIPTION_UPDATED = :"event_subscription.updated"

    # Occurs whenever an Export is created.
    EXPORT_CREATED = :"export.created"

    # Occurs whenever an Export is updated.
    EXPORT_UPDATED = :"export.updated"

    # Occurs whenever an External Account is created.
     = :"external_account.created"

    # Occurs whenever an External Account is updated.
     = :"external_account.updated"

    # Occurs whenever a FedNow Transfer is created.
    FEDNOW_TRANSFER_CREATED = :"fednow_transfer.created"

    # Occurs whenever a FedNow Transfer is updated.
    FEDNOW_TRANSFER_UPDATED = :"fednow_transfer.updated"

    # Occurs whenever a File is created.
    FILE_CREATED = :"file.created"

    # Occurs whenever a Group is updated.
    GROUP_UPDATED = :"group.updated"

    # Increase may send webhooks with this category to see if a webhook endpoint is working properly.
    GROUP_HEARTBEAT = :"group.heartbeat"

    # Occurs whenever an Inbound ACH Transfer is created.
    INBOUND_ACH_TRANSFER_CREATED = :"inbound_ach_transfer.created"

    # Occurs whenever an Inbound ACH Transfer is updated.
    INBOUND_ACH_TRANSFER_UPDATED = :"inbound_ach_transfer.updated"

    # Occurs whenever an Inbound ACH Transfer Return is created.
    INBOUND_ACH_TRANSFER_RETURN_CREATED = :"inbound_ach_transfer_return.created"

    # Occurs whenever an Inbound ACH Transfer Return is updated.
    INBOUND_ACH_TRANSFER_RETURN_UPDATED = :"inbound_ach_transfer_return.updated"

    # Occurs whenever an Inbound Check Deposit is created.
    INBOUND_CHECK_DEPOSIT_CREATED = :"inbound_check_deposit.created"

    # Occurs whenever an Inbound Check Deposit is updated.
    INBOUND_CHECK_DEPOSIT_UPDATED = :"inbound_check_deposit.updated"

    # Occurs whenever an Inbound FedNow Transfer is created.
    INBOUND_FEDNOW_TRANSFER_CREATED = :"inbound_fednow_transfer.created"

    # Occurs whenever an Inbound FedNow Transfer is updated.
    INBOUND_FEDNOW_TRANSFER_UPDATED = :"inbound_fednow_transfer.updated"

    # Occurs whenever an Inbound Mail Item is created.
    INBOUND_MAIL_ITEM_CREATED = :"inbound_mail_item.created"

    # Occurs whenever an Inbound Mail Item is updated.
    INBOUND_MAIL_ITEM_UPDATED = :"inbound_mail_item.updated"

    # Occurs whenever an Inbound Real-Time Payments Transfer is created.
    INBOUND_REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"inbound_real_time_payments_transfer.created"

    # Occurs whenever an Inbound Real-Time Payments Transfer is updated.
    INBOUND_REAL_TIME_PAYMENTS_TRANSFER_UPDATED = :"inbound_real_time_payments_transfer.updated"

    # Occurs whenever an Inbound Wire Drawdown Request is created.
    INBOUND_WIRE_DRAWDOWN_REQUEST_CREATED = :"inbound_wire_drawdown_request.created"

    # Occurs whenever an Inbound Wire Transfer is created.
    INBOUND_WIRE_TRANSFER_CREATED = :"inbound_wire_transfer.created"

    # Occurs whenever an Inbound Wire Transfer is updated.
    INBOUND_WIRE_TRANSFER_UPDATED = :"inbound_wire_transfer.updated"

    # Occurs whenever an IntraFi Account Enrollment is created.
     = :"intrafi_account_enrollment.created"

    # Occurs whenever an IntraFi Account Enrollment is updated.
     = :"intrafi_account_enrollment.updated"

    # Occurs whenever an IntraFi Exclusion is created.
    INTRAFI_EXCLUSION_CREATED = :"intrafi_exclusion.created"

    # Occurs whenever an IntraFi Exclusion is updated.
    INTRAFI_EXCLUSION_UPDATED = :"intrafi_exclusion.updated"

    # Occurs whenever a Legacy Card Dispute is created.
    LEGACY_CARD_DISPUTE_CREATED = :"legacy_card_dispute.created"

    # Occurs whenever a Legacy Card Dispute is updated.
    LEGACY_CARD_DISPUTE_UPDATED = :"legacy_card_dispute.updated"

    # Occurs whenever a Lockbox is created.
    LOCKBOX_CREATED = :"lockbox.created"

    # Occurs whenever a Lockbox is updated.
    LOCKBOX_UPDATED = :"lockbox.updated"

    # Occurs whenever an OAuth Connection is created.
    OAUTH_CONNECTION_CREATED = :"oauth_connection.created"

    # Occurs whenever an OAuth Connection is deactivated.
    OAUTH_CONNECTION_DEACTIVATED = :"oauth_connection.deactivated"

    # Occurs whenever a Card Push Transfer is created.
    CARD_PUSH_TRANSFER_CREATED = :"card_push_transfer.created"

    # Occurs whenever a Card Push Transfer is updated.
    CARD_PUSH_TRANSFER_UPDATED = :"card_push_transfer.updated"

    # Occurs whenever a Card Validation is created.
    CARD_VALIDATION_CREATED = :"card_validation.created"

    # Occurs whenever a Card Validation is updated.
    CARD_VALIDATION_UPDATED = :"card_validation.updated"

    # Occurs whenever a Pending Transaction is created.
    PENDING_TRANSACTION_CREATED = :"pending_transaction.created"

    # Occurs whenever a Pending Transaction is updated.
    PENDING_TRANSACTION_UPDATED = :"pending_transaction.updated"

    # Occurs whenever a Physical Card is created.
    PHYSICAL_CARD_CREATED = :"physical_card.created"

    # Occurs whenever a Physical Card is updated.
    PHYSICAL_CARD_UPDATED = :"physical_card.updated"

    # Occurs whenever a Physical Card Profile is created.
    PHYSICAL_CARD_PROFILE_CREATED = :"physical_card_profile.created"

    # Occurs whenever a Physical Card Profile is updated.
    PHYSICAL_CARD_PROFILE_UPDATED = :"physical_card_profile.updated"

    # Occurs whenever a Program is created.
    PROGRAM_CREATED = :"program.created"

    # Occurs whenever a Program is updated.
    PROGRAM_UPDATED = :"program.updated"

    # Occurs whenever a Proof of Authorization Request is created.
    PROOF_OF_AUTHORIZATION_REQUEST_CREATED = :"proof_of_authorization_request.created"

    # Occurs whenever a Proof of Authorization Request is updated.
    PROOF_OF_AUTHORIZATION_REQUEST_UPDATED = :"proof_of_authorization_request.updated"

    # Occurs whenever a Real-Time Decision is created in response to a card authorization.
    REAL_TIME_DECISION_CARD_AUTHORIZATION_REQUESTED = :"real_time_decision.card_authorization_requested"

    # Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.
    REAL_TIME_DECISION_DIGITAL_WALLET_TOKEN_REQUESTED = :"real_time_decision.digital_wallet_token_requested"

    # Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.
    REAL_TIME_DECISION_DIGITAL_WALLET_AUTHENTICATION_REQUESTED =
      :"real_time_decision.digital_wallet_authentication_requested"

    # Occurs whenever a Real-Time Decision is created in response to 3DS authentication.
    REAL_TIME_DECISION_CARD_AUTHENTICATION_REQUESTED = :"real_time_decision.card_authentication_requested"

    # Occurs whenever a Real-Time Decision is created in response to 3DS authentication challenges.
    REAL_TIME_DECISION_CARD_AUTHENTICATION_CHALLENGE_REQUESTED =
      :"real_time_decision.card_authentication_challenge_requested"

    # Occurs whenever a Real-Time Payments Transfer is created.
    REAL_TIME_PAYMENTS_TRANSFER_CREATED = :"real_time_payments_transfer.created"

    # Occurs whenever a Real-Time Payments Transfer is updated.
    REAL_TIME_PAYMENTS_TRANSFER_UPDATED = :"real_time_payments_transfer.updated"

    # Occurs whenever a Real-Time Payments Request for Payment is created.
    REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_CREATED = :"real_time_payments_request_for_payment.created"

    # Occurs whenever a Real-Time Payments Request for Payment is updated.
    REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"

    # Occurs whenever a Swift Transfer is created.
    SWIFT_TRANSFER_CREATED = :"swift_transfer.created"

    # Occurs whenever a Swift Transfer is updated.
    SWIFT_TRANSFER_UPDATED = :"swift_transfer.updated"

    # Occurs whenever a Transaction is created.
    TRANSACTION_CREATED = :"transaction.created"

    # Occurs whenever a Wire Drawdown Request is created.
    WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"

    # Occurs whenever a Wire Drawdown Request is updated.
    WIRE_DRAWDOWN_REQUEST_UPDATED = :"wire_drawdown_request.updated"

    # Occurs whenever a Wire Transfer is created.
    WIRE_TRANSFER_CREATED = :"wire_transfer.created"

    # Occurs whenever a Wire Transfer is updated.
    WIRE_TRANSFER_UPDATED = :"wire_transfer.updated"

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#in_ ⇒ Array<Symbol, Increase::Models::EventListParams::Category::In>?

Filter Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ‘?in=one,two,three`.

Returns:



62
63
64
 
# File 'lib/increase/models/event_list_params.rb', line 62

optional :in_,
-> { Increase::Internal::Type::ArrayOf[enum: Increase::EventListParams::Category::In] },
api_name: :in