Package com.ringcentral.definitions

Class ListStatesParameters

java.lang.Object

com.ringcentral.definitions.ListStatesParameters

public class ListStatesParameters
extends Object

Query parameters for operation listStates

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	allCountries	If set to `true` then states of all countries are returned and `countryId` is ignored, even if specified.
Long	countryId	Internal identifier of a country Format: int64
Long	page	Indicates a page number to retrieve.
Long	perPage	Indicates a page size (number of items) Format: int32 Default: 100
Boolean	withPhoneNumbers	If `true` the list of states with phone numbers available for buying is returned

Constructor Summary

Constructors

Constructor	Description
ListStatesParameters()

Method Summary

Modifier and Type	Method	Description
ListStatesParameters	allCountries(Boolean allCountries)
ListStatesParameters	countryId(Long countryId)
ListStatesParameters	page(Long page)
ListStatesParameters	perPage(Long perPage)
ListStatesParameters	withPhoneNumbers(Boolean withPhoneNumbers)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

allCountries

public Boolean allCountries

If set to `true` then states of all countries are returned and `countryId` is ignored, even if specified. If the value is empty then the parameter is ignored

countryId

public Long countryId

Internal identifier of a country Format: int64

page

public Long page

Indicates a page number to retrieve. Only positive number values are accepted Format: int32 Default: 1

perPage

public Long perPage

Indicates a page size (number of items) Format: int32 Default: 100

withPhoneNumbers

public Boolean withPhoneNumbers

If `true` the list of states with phone numbers available for buying is returned

Constructor Details

ListStatesParameters

public ListStatesParameters()

Method Details

allCountries

public ListStatesParameters allCountries(Boolean allCountries)

countryId

public ListStatesParameters countryId(Long countryId)

page

public ListStatesParameters page(Long page)

perPage

public ListStatesParameters perPage(Long perPage)

withPhoneNumbers

public ListStatesParameters withPhoneNumbers(Boolean withPhoneNumbers)