com.ringcentral.definitions.ListDirectoryEntriesParameters 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.3

package com.ringcentral.definitions;


/**
 * Query parameters for operation listDirectoryEntries
 */
public class ListDirectoryEntriesParameters {
    /**
     * If 'True' then contacts of all accounts in federation are returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case
     * Default: true
     */
    public Boolean showFederated;
    /**
     * Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology
     * Enum: User, Department, Announcement, Voicemail, SharedLinesGroup, PagingOnly, IvrMenu, ParkLocation, Limited, External
     */
    public String type;
    /**
     * Type of extension group
     * Enum: User, NonUser
     */
    public String typeGroup;
    /**
     * Page number
     * Format: int32
     * Default: 1
     */
    public Long page;
    /**
     * Records count to be returned per one page. The default value is 1000. Specific keyword values: `all` - all records are returned in one page; `max` - maximum count of records that can be returned in one page
     * Maximum: 2000
     * Format: int32
     * Default: 1000
     */
    public Long perPage;
    /**
     * Internal identifier of the business site to which extensions belong
     */
    public String siteId;

    public ListDirectoryEntriesParameters showFederated(Boolean showFederated) {
        this.showFederated = showFederated;
        return this;
    }

    public ListDirectoryEntriesParameters type(String type) {
        this.type = type;
        return this;
    }

    public ListDirectoryEntriesParameters typeGroup(String typeGroup) {
        this.typeGroup = typeGroup;
        return this;
    }

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

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

    public ListDirectoryEntriesParameters siteId(String siteId) {
        this.siteId = siteId;
        return this;
    }
}