Class: Iterable::InApp

Inherits:
ApiResource show all
Defined in:
lib/iterable/in_app.rb

Overview

Interact with /inApp API endpoints

Examples:

Creating in app endpoint object

# With default config
in_app = Iterable::InApp.new

# With custom config
conf = Iterable::Config.new(token: 'new-token')
in_app = Iterable::InApp.new(config)

Instance Attribute Summary

Attributes inherited from ApiResource

#conf

Instance Method Summary collapse

Methods inherited from ApiResource

#default_config, default_config, #initialize

Constructor Details

This class inherits a constructor from Iterable::ApiResource

Instance Method Details

#cancel(campaign_id: nil, attrs: {}, email: nil) ⇒ Object 



103
104
105
106
107
 
# File 'lib/iterable/in_app.rb', line 103

def cancel(campaign_id: nil, attrs: {}, email: nil)
  attrs['email'] = email if email
  attrs['campaignId'] = campaign_id if campaign_id
  Iterable.request(conf, '/push/cancel').post(attrs)
end

#messages_for_email(email, count: 1, **attrs) ⇒ Object 



32
33
34
35
36
 
# File 'lib/iterable/in_app.rb', line 32

def messages_for_email(email, count: 1, **attrs)
  attrs[:email] = email
  attrs[:count] = count
  messages(attrs)
end

#messages_for_user_id(user_id, count: 1, **attrs) ⇒ Object 



54
55
56
57
58
 
# File 'lib/iterable/in_app.rb', line 54

def messages_for_user_id(user_id, count: 1, **attrs)
  attrs[:userId] = user_id
  attrs[:count] = count
  messages(attrs)
end

#target(campaign_id:, attrs: {}, email: nil) ⇒ Object 



77
78
79
80
81
 
# File 'lib/iterable/in_app.rb', line 77

def target(campaign_id:, attrs: {}, email: nil)
  attrs['recipientEmail'] = email if email
  attrs['campaignId'] = campaign_id
  Iterable.request(conf, '/inApp/target').post(attrs)
end