Class: GoCardlessPro::Resources::CustomerNotification
- Inherits:
-
Object
- Object
- GoCardlessPro::Resources::CustomerNotification
- Defined in:
- lib/gocardless_pro/resources/customer_notification.rb
Overview
Customer Notifications represent the notification which is due to be sent to a customer after an event has happened. The event, the resource and the customer to be notified are all identified in the ‘links` property.
Note that these are ephemeral records - once the notification has been actioned in some way, it is no longer visible using this API.
<p class=“restricted-notice”><strong>Restricted</strong>: This API is currently only available for approved integrators - please <a href=“[email protected]”>get in touch</a> if you would like to use this API.</p>
Defined Under Namespace
Classes: Links
Instance Attribute Summary collapse
-
#action_taken ⇒ Object
readonly
Returns the value of attribute action_taken.
-
#action_taken_at ⇒ Object
readonly
Returns the value of attribute action_taken_at.
-
#action_taken_by ⇒ Object
readonly
Returns the value of attribute action_taken_by.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#type ⇒ Object
readonly
Returns the value of attribute type.
Instance Method Summary collapse
- #api_response ⇒ Object
-
#initialize(object, response = nil) ⇒ CustomerNotification
constructor
Initialize a customer_notification resource instance.
-
#links ⇒ Object
Return the links that the resource has.
-
#to_h ⇒ Object
Provides the customer_notification resource as a hash of all its readable attributes.
Constructor Details
#initialize(object, response = nil) ⇒ CustomerNotification
Initialize a customer_notification resource instance
38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 38 def initialize(object, response = nil) @object = object @action_taken = object['action_taken'] @action_taken_at = object['action_taken_at'] @action_taken_by = object['action_taken_by'] @id = object['id'] @links = object['links'] @type = object['type'] @response = response end |
Instance Attribute Details
#action_taken ⇒ Object (readonly)
Returns the value of attribute action_taken.
30 31 32 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 30 def action_taken @action_taken end |
#action_taken_at ⇒ Object (readonly)
Returns the value of attribute action_taken_at.
31 32 33 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 31 def action_taken_at @action_taken_at end |
#action_taken_by ⇒ Object (readonly)
Returns the value of attribute action_taken_by.
32 33 34 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 32 def action_taken_by @action_taken_by end |
#id ⇒ Object (readonly)
Returns the value of attribute id.
33 34 35 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 33 def id @id end |
#type ⇒ Object (readonly)
Returns the value of attribute type.
34 35 36 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 34 def type @type end |
Instance Method Details
#api_response ⇒ Object
50 51 52 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 50 def api_response ApiResponse.new(@response) end |
#links ⇒ Object
Return the links that the resource has
55 56 57 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 55 def links @customer_notification_links ||= Links.new(@links) end |
#to_h ⇒ Object
Provides the customer_notification resource as a hash of all its readable attributes
60 61 62 |
# File 'lib/gocardless_pro/resources/customer_notification.rb', line 60 def to_h @object end |