Class: Figo::Notification

Inherits:
Base
  • Object
show all
Defined in:
lib/notification/model.rb

Overview

Object representing a configured notification, e.g. a webhook or email hook

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#dump, dump_attributes

Constructor Details

#initialize(session, json) ⇒ Notification

Returns a new instance of Notification.



7
8
9
 
# File 'lib/notification/model.rb', line 7

def initialize(session, json)
  super(session, json)
end

Instance Attribute Details

#notification_id ⇒ String

Internal figo Connect notification ID from the notification registration response

Returns:

  • (String) 


13
14
15
 
# File 'lib/notification/model.rb', line 13

def notification_id
  @notification_id
end

#notify_uri ⇒ String

Notification messages will be sent to this URL

Returns:

  • (String) 


21
22
23
 
# File 'lib/notification/model.rb', line 21

def notify_uri
  @notify_uri
end

#observe_key ⇒ String

One of the notification keys specified in the figo Connect API specification

Returns:

  • (String) 


17
18
19
 
# File 'lib/notification/model.rb', line 17

def observe_key
  @observe_key
end

#state ⇒ String

State similiar to sync and logon process. It will passed as POST payload for webhooks

Returns:

  • (String) 


25
26
27
 
# File 'lib/notification/model.rb', line 25

def state
  @state
end