Class: Increase::Models::EventSubscription

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/increase/models/event_subscription.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from BaseModel

#[], #inspect, #to_h, #to_s

Instance Attribute Details

#created_at ⇒ String

The time the event subscription was created.

Returns:

  • (String) 


14
 
# File 'lib/increase/models/event_subscription.rb', line 14

required :created_at, String

#id ⇒ String

The event subscription identifier.

Returns:

  • (String) 


9
 
# File 'lib/increase/models/event_subscription.rb', line 9

required :id, String

#idempotency_key ⇒ String

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Returns:

  • (String) 


19
 
# File 'lib/increase/models/event_subscription.rb', line 19

required :idempotency_key, String

#oauth_connection_id ⇒ String

If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.

Returns:

  • (String) 


24
 
# File 'lib/increase/models/event_subscription.rb', line 24

required :oauth_connection_id, String

#selected_event_category ⇒ Symbol

If specified, this subscription will only receive webhooks for Events with the specified category.

Returns:

  • (Symbol) 


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
 
# File 'lib/increase/models/event_subscription.rb', line 29

required :selected_event_category,
Increase::Enum.new(
  :'account.created',
  :'account.updated',
  :'account_number.created',
  :'account_number.updated',
  :'account_statement.created',
  :'account_transfer.created',
  :'account_transfer.updated',
  :'ach_prenotification.created',
  :'ach_prenotification.updated',
  :'ach_transfer.created',
  :'ach_transfer.updated',
  :'bookkeeping_account.created',
  :'bookkeeping_account.updated',
  :'bookkeeping_entry_set.updated',
  :'card.created',
  :'card.updated',
  :'card_payment.created',
  :'card_payment.updated',
  :'card_profile.created',
  :'card_profile.updated',
  :'card_dispute.created',
  :'card_dispute.updated',
  :'check_deposit.created',
  :'check_deposit.updated',
  :'check_transfer.created',
  :'check_transfer.updated',
  :'declined_transaction.created',
  :'digital_card_profile.created',
  :'digital_card_profile.updated',
  :'digital_wallet_token.created',
  :'digital_wallet_token.updated',
  :'document.created',
  :'entity.created',
  :'entity.updated',
  :'event_subscription.created',
  :'event_subscription.updated',
  :'export.created',
  :'export.updated',
  :'external_account.created',
  :'external_account.updated',
  :'file.created',
  :'group.updated',
  :'group.heartbeat',
  :'inbound_ach_transfer.created',
  :'inbound_ach_transfer.updated',
  :'inbound_ach_transfer_return.created',
  :'inbound_ach_transfer_return.updated',
  :'inbound_check_deposit.created',
  :'inbound_check_deposit.updated',
  :'inbound_mail_item.created',
  :'inbound_mail_item.updated',
  :'inbound_wire_drawdown_request.created',
  :'inbound_wire_transfer.created',
  :'inbound_wire_transfer.updated',
  :'intrafi_account_enrollment.created',
  :'intrafi_account_enrollment.updated',
  :'intrafi_exclusion.created',
  :'intrafi_exclusion.updated',
  :'lockbox.created',
  :'lockbox.updated',
  :'oauth_connection.created',
  :'oauth_connection.deactivated',
  :'pending_transaction.created',
  :'pending_transaction.updated',
  :'physical_card.created',
  :'physical_card.updated',
  :'physical_card_profile.created',
  :'physical_card_profile.updated',
  :'proof_of_authorization_request.created',
  :'proof_of_authorization_request.updated',
  :'proof_of_authorization_request_submission.created',
  :'proof_of_authorization_request_submission.updated',
  :'real_time_decision.card_authorization_requested',
  :'real_time_decision.digital_wallet_token_requested',
  :'real_time_decision.digital_wallet_authentication_requested',
  :'real_time_payments_transfer.created',
  :'real_time_payments_transfer.updated',
  :'real_time_payments_request_for_payment.created',
  :'real_time_payments_request_for_payment.updated',
  :'transaction.created',
  :'wire_drawdown_request.created',
  :'wire_drawdown_request.updated',
  :'wire_transfer.created',
  :'wire_transfer.updated'
)

#status ⇒ Symbol

This indicates if we'll send notifications to this subscription.

Returns:

  • (Symbol) 


120
 
# File 'lib/increase/models/event_subscription.rb', line 120

required :status, Increase::Enum.new(:active, :disabled, :deleted, :requires_attention)

#type ⇒ Symbol

A constant representing the object's type. For this resource it will always be event_subscription.

Returns:

  • (Symbol) 


125
 
# File 'lib/increase/models/event_subscription.rb', line 125

required :type, Increase::Enum.new(:event_subscription)

#url ⇒ String

The webhook url where we'll send notifications.

Returns:

  • (String) 


130
 
# File 'lib/increase/models/event_subscription.rb', line 130

required :url, String