Class: Appboy::API

Inherits:

Object

• Object
• Appboy::API

Includes:

Deprecated, Endpoints::EmailStatus, Endpoints::ScheduleMessages, Endpoints::SendMessages, Endpoints::TrackUsers

Defined in:

lib/appboy/api.rb

Instance Attribute Summary

• #app_group_id ⇒ Object readonly

  Returns the value of attribute app_group_id.

Instance Method Summary

• #export_users(**payload) ⇒ Object
• #initialize(app_group_id) ⇒ API constructor

  A new instance of API.

• #list_segments ⇒ Object

Methods included from Endpoints::EmailStatus

#email_status, #email_status_service

Methods included from Endpoints::ScheduleMessages

#schedule_messages

Methods included from Endpoints::SendMessages

#send_messages

Methods included from Endpoints::TrackUsers

#track_attribute, #track_event, #track_purchase, #track_users

Methods included from Deprecated

#schedule_message, #send_message, #track

Constructor Details

#initialize(app_group_id) ⇒ API

Returns a new instance of API.

# File 'lib/appboy/api.rb', line 26

def initialize(app_group_id)
  @app_group_id = app_group_id
end

Instance Attribute Details

#app_group_id ⇒ Object (readonly)

Returns the value of attribute app_group_id.

# File 'lib/appboy/api.rb', line 24

def app_group_id
  @app_group_id
end

Instance Method Details

#export_users(**payload) ⇒ Object

# File 'lib/appboy/api.rb', line 16

def export_users(**payload)
  Appboy::REST::ExportUsers.new.perform(app_group_id, payload)
end

#list_segments ⇒ Object

# File 'lib/appboy/api.rb', line 20

def list_segments
  Appboy::REST::ListSegments.new.perform(app_group_id)
end