Contents

# Buildium::ApplicantSearchMessage

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **entity_id** | **Integer** | Filters results to any applicant associated with the specified entity identifier. This filter is used in conjunction with the `EntityType` field which must be set to the type of entity this identifier references. | [optional] |
| **entity_type** | **String** | Specifies the type of entity that `EntityId` refers to. This field is required if `EntityId` is specified. | [optional] |
| **application_statuses** | **Array<String>** | Filters results by the applicant application status. If no status is specified, applicants with an application in any status will be returned. | [optional] |
| **unit_ids** | **Array<Integer>** | Filters results to applicants associated to any of the specified rental property unit identifiers. | [optional] |
| **name** | **String** | Filters results to applicants whose name *contains* the specified value. | [optional] |
| **email** | **String** | Filters results to applicants whose email *contains* the specified value | [optional] |
| **application_submitted_start_date** | **Time** | Filters results to any applicant who submitted an application on or after the date specified. | [optional] |
| **application_submitted_end_date** | **Time** | Filters results to any applicant who submitted an application on or prior to the date specified. | [optional] |

## Example

```ruby
require 'buildium-ruby'

instance = Buildium::ApplicantSearchMessage.new(
  entity_id: null,
  entity_type: null,
  application_statuses: null,
  unit_ids: null,
  name: null,
  email: null,
  application_submitted_start_date: null,
  application_submitted_end_date: null
)
```

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
buildium-ruby-3.0.0	docs/ApplicantSearchMessage.md
buildium-ruby-2.1.0	docs/ApplicantSearchMessage.md
buildium-ruby-2.0.1	docs/ApplicantSearchMessage.md