Class: Filter

Filter

new Filter()

Specify a filter for offers.
Source:

Extends

Methods

amount(amount, equality) → {Filter}

Add filtering by amount. e.g. "300" or ">300" or "<300"
Parameters:
Name Type Description
amount string | number the amount to be filtered
equality string | Filter.EQUALITY equality for the filter. If none is specified EQUAL is used.
Source:
Returns:
the same filter.
Type
Filter

created_at(from, to) → {Filter}

Add filtering by created_at
Parameters:
Name Type Description
from number | Date the start date of the filter, either as Date or Unix-time number.
to number | Date the end date of the filter, either as Date or Unix-time number.
Source:
Returns:
the same filter.
Type
Filter

name(name) → {Filter}

Add filtering by name
Parameters:
Name Type Description
name string the name of the offer.
Source:
Returns:
the same filter.
Type
Filter

trial_period_days(client) → {Filter}

Add filtering by trial_period_days
Parameters:
Name Type Description
client string | number the trial_period_days of the offer.
Source:
Returns:
the same filter.
Type
Filter

updated_at(from, to) → {Filter}

Add filtering by updated_at
Parameters:
Name Type Description
from number | Date the start date of the filter, either as Date or Unix-time number.
to number | Date the end date of the filter, either as Date or Unix-time number.
Source:
Returns:
the same filter.
Type
Filter