Class: Filter

Filter

new Filter()

Specify a filter for clients.
Source:

Extends

Methods

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

description(description) → {Filter}

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

email(email) → {Filter}

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

offer(offer) → {Filter}

Add filtering by offer
Parameters:
Name Type Description
offer string | Offer the offer object or its id.
Source:
Returns:
the same filter.
Type
Filter

payment(payment) → {Filter}

Add filtering by payment
Parameters:
Name Type Description
payment string | Payment the payment object or its id.
Source:
Returns:
the same filter.
Type
Filter

subscription(subscription) → {Filter}

Add filtering by subscription
Parameters:
Name Type Description
subscription string | Subscription the subscription object or its id.
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