Class: Socketlab::FblReport

Inherits:
SocketlabRequest show all
Defined in:
lib/socketlab/fbl_report.rb

Instance Attribute Summary collapse

Attributes inherited from SocketlabRequest

#api_password, #api_response, #api_server, #api_user, #api_version, #error, #query_params

Instance Method Summary collapse

Methods inherited from SocketlabRequest

#initialize, #set_query_params_type, #set_request_options, #socketlab_request, #success?

Constructor Details

This class inherits a constructor from Socketlab::SocketlabRequest

Instance Attribute Details

#countObject

Returns the value of attribute count.



4
5
6
# File 'lib/socketlab/fbl_report.rb', line 4

def count
  @count
end

#itemsObject

Returns the value of attribute items.



4
5
6
# File 'lib/socketlab/fbl_report.rb', line 4

def items
  @items
end

#timestampObject

Returns the value of attribute timestamp.



4
5
6
# File 'lib/socketlab/fbl_report.rb', line 4

def timestamp
  @timestamp
end

#total_countObject

Returns the value of attribute total_count.



4
5
6
# File 'lib/socketlab/fbl_report.rb', line 4

def total_count
  @total_count
end

#total_pagesObject

Returns the value of attribute total_pages.



4
5
6
# File 'lib/socketlab/fbl_report.rb', line 4

def total_pages
  @total_pages
end

Instance Method Details

#api_request(query = {:type=>"JSON"}) ⇒ Object

JSON, JSONP, XML or CSV date_format yyyy-mm-dd hh:mm:ss If the time is omitted it will default to 00:00:00. query= timeZone offset, mailingId=>“”,:messageId=>“”,:index=>“”,:count=>“”:type=>“JSON”



9
10
11
12
# File 'lib/socketlab/fbl_report.rb', line 9

def api_request(query={:type=>"JSON"})
  @query_params = query
  socketlab_request("messagesFblReported")
end

#set_responseObject

Assuming type is json



15
16
17
# File 'lib/socketlab/fbl_report.rb', line 15

def set_response
  super(FblReportItem)
end