Class: MangoModel::Report

Inherits:
EntityBase show all
Includes:
MangoPay::Jsonifier
Defined in:
lib/mangopay/model/entity/report.rb

Overview

Report entity The Report object enables possibility to download huge lists of transactions or wallets to CSV form for accounting and analysis purposes.

Constant Summary

Constants included from MangoPay::Jsonifier

MangoPay::Jsonifier::LOG

Instance Attribute Summary collapse

Attributes inherited from EntityBase

#creation_date, #id, #tag

Method Summary

Methods included from MangoPay::Jsonifier

#dejsonify, #jsonify!

Methods included from NonInstantiable

#initialize

Instance Attribute Details

#callback_url ⇒ Object

String

URL which MangoPay will ping once the report is ready

to be downloaded (works in a similar way to Hooks)



20
21
22
 
# File 'lib/mangopay/model/entity/report.rb', line 20

def callback_url
  @callback_url
end

#columns ⇒ Object

Array

List of names of the columns to be included in the report



43
44
45
 
# File 'lib/mangopay/model/entity/report.rb', line 43

def columns
  @columns
end

#download_format ⇒ Object

DownloadFormat

The format of the downloadable report



23
24
25
 
# File 'lib/mangopay/model/entity/report.rb', line 23

def download_format
  @download_format
end

#download_url ⇒ Object

String

URL where the report can be downloaded



16
17
18
 
# File 'lib/mangopay/model/entity/report.rb', line 16

def download_url
  @download_url
end

#filters ⇒ Object

ReportFilter

Object which allows filtering of report entries



40
41
42
 
# File 'lib/mangopay/model/entity/report.rb', line 40

def filters
  @filters
end

#preview ⇒ Object

true/false

Whether the report should be limited to the first

10 rows, making its execution faster



37
38
39
 
# File 'lib/mangopay/model/entity/report.rb', line 37

def preview
  @preview
end

#report_date ⇒ Object

Integer

Time when the report was executed (UNIX timestamp)



13
14
15
 
# File 'lib/mangopay/model/entity/report.rb', line 13

def report_date
  @report_date
end

#report_type ⇒ Object

ReportType

The type of report



26
27
28
 
# File 'lib/mangopay/model/entity/report.rb', line 26

def report_type
  @report_type
end

#result_code ⇒ Object

String

The result code



46
47
48
 
# File 'lib/mangopay/model/entity/report.rb', line 46

def result_code
  @result_code
end

#result_message ⇒ Object

String

Explanation of the result



49
50
51
 
# File 'lib/mangopay/model/entity/report.rb', line 49

def result_message
  @result_message
end

#sort ⇒ Object

String

The column to sort by and the direction, separated

by a ‘:’ character (i.e. CreationDate:DESC)



33
34
35
 
# File 'lib/mangopay/model/entity/report.rb', line 33

def sort
  @sort
end

#status ⇒ Object

ReportStatus

Its status



29
30
31
 
# File 'lib/mangopay/model/entity/report.rb', line 29

def status
  @status
end