Class: FilterRequest
- Inherits:
-
Object
- Object
- FilterRequest
- Defined in:
- lib/mangopay/model/request/filter_request.rb
Overview
Requests filtering of response lists
Instance Attribute Summary collapse
-
#after_date ⇒ Object
- Integer
-
Minimum creation date of result entities.
-
#before_date ⇒ Object
- Integer
-
Maximum creation date of result entities.
-
#dispute_type ⇒ Object
- DisputeType
-
Type of dispute entities to be retrieved.
-
#event_type ⇒ Object
- EventType
-
Type of events to be retrieved.
-
#nature ⇒ Object
- TransactionNature
-
Nature of transaction entities to be retrieved.
-
#page ⇒ Object
- Integer
-
Number of the page of results to be retrieved.
-
#per_page ⇒ Object
- Integer
-
Number of results to be included per page.
-
#sort_direction ⇒ Object
- SortDirection
-
Direction of sorting by specified field.
-
#sort_field ⇒ Object
- SortField
-
Field by which to sort results.
-
#status ⇒ Object
- DocumentStatus/TransactionStatus/DisputeStatus
-
Status of entities to be retrieved.
-
#type ⇒ Object
- TransactionType/DisputeDocumentType
-
Type of entities to be retrieved.
Instance Attribute Details
#after_date ⇒ Object
- Integer
-
Minimum creation date of result entities
20 21 22 |
# File 'lib/mangopay/model/request/filter_request.rb', line 20 def after_date @after_date end |
#before_date ⇒ Object
- Integer
-
Maximum creation date of result entities
17 18 19 |
# File 'lib/mangopay/model/request/filter_request.rb', line 17 def before_date @before_date end |
#dispute_type ⇒ Object
- DisputeType
-
Type of dispute entities to be retrieved
33 34 35 |
# File 'lib/mangopay/model/request/filter_request.rb', line 33 def dispute_type @dispute_type end |
#event_type ⇒ Object
- EventType
-
Type of events to be retrieved
36 37 38 |
# File 'lib/mangopay/model/request/filter_request.rb', line 36 def event_type @event_type end |
#nature ⇒ Object
- TransactionNature
-
Nature of transaction entities to be retrieved
27 28 29 |
# File 'lib/mangopay/model/request/filter_request.rb', line 27 def nature @nature end |
#page ⇒ Object
- Integer
-
Number of the page of results to be retrieved
5 6 7 |
# File 'lib/mangopay/model/request/filter_request.rb', line 5 def page @page end |
#per_page ⇒ Object
- Integer
-
Number of results to be included per page
8 9 10 |
# File 'lib/mangopay/model/request/filter_request.rb', line 8 def per_page @per_page end |
#sort_direction ⇒ Object
- SortDirection
-
Direction of sorting by specified field
14 15 16 |
# File 'lib/mangopay/model/request/filter_request.rb', line 14 def sort_direction @sort_direction end |
#sort_field ⇒ Object
- SortField
-
Field by which to sort results
11 12 13 |
# File 'lib/mangopay/model/request/filter_request.rb', line 11 def sort_field @sort_field end |
#status ⇒ Object
- DocumentStatus/TransactionStatus/DisputeStatus
-
Status of entities
to be retrieved
24 25 26 |
# File 'lib/mangopay/model/request/filter_request.rb', line 24 def status @status end |
#type ⇒ Object
- TransactionType/DisputeDocumentType
-
Type of entities to be retrieved
30 31 32 |
# File 'lib/mangopay/model/request/filter_request.rb', line 30 def type @type end |