com.ringcentral.definitions.ListContactsParameters Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ringcentral Show documentation

RingCentral Java SDK

There is a newer version: 3.2.1

package com.ringcentral.definitions;


/**
 * Query parameters for operation listContacts
 */
public class ListContactsParameters {
    /**
     * If specified, only contacts which 'First name' or 'Last name' start
     * with the mentioned substring will be returned. Case-insensitive
     */
    public String startsWith;
    /**
     * Sorts results by the specified property
     * Enum: FirstName, LastName, Company
     */
    public String[] sortBy;
    /**
     * The result set page number (1-indexed) to return
     * Maximum: 1000
     * Minimum: 1
     * Format: int32
     * Example: 1
     * Default: 1
     */
    public Long page;
    /**
     * The number of items per page. If provided value in the request
     * is greater than a maximum, the maximum value is applied
     * Maximum: 1000
     * Minimum: 1
     * Format: int32
     * Example: 100
     * Default: 100
     */
    public Long perPage;
    /**
     * Phone number in e.164 format
     */
    public String[] phoneNumber;

    public ListContactsParameters startsWith(String startsWith) {
        this.startsWith = startsWith;
        return this;
    }

    public ListContactsParameters sortBy(String[] sortBy) {
        this.sortBy = sortBy;
        return this;
    }

    public ListContactsParameters page(Long page) {
        this.page = page;
        return this;
    }

    public ListContactsParameters perPage(Long perPage) {
        this.perPage = perPage;
        return this;
    }

    public ListContactsParameters phoneNumber(String[] phoneNumber) {
        this.phoneNumber = phoneNumber;
        return this;
    }
}