com.squareup.square.models

Class BatchRetrieveInventoryChangesRequest

java.lang.Object

com.squareup.square.models.BatchRetrieveInventoryChangesRequest

public class BatchRetrieveInventoryChangesRequest
extends Object

This is a model class for BatchRetrieveInventoryChangesRequest type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchRetrieveInventoryChangesRequest.Builder Class to build instances of BatchRetrieveInventoryChangesRequest.

Constructor Summary

Constructors

Modifier	Constructor and Description
	BatchRetrieveInventoryChangesRequest(List<String> catalogObjectIds, List<String> locationIds, List<String> types, List<String> states, String updatedAfter, String updatedBefore, String cursor, Integer limit) Initialization constructor.
protected	BatchRetrieveInventoryChangesRequest(io.apimatic.core.types.OptionalNullable<List<String>> catalogObjectIds, io.apimatic.core.types.OptionalNullable<List<String>> locationIds, io.apimatic.core.types.OptionalNullable<List<String>> types, io.apimatic.core.types.OptionalNullable<List<String>> states, io.apimatic.core.types.OptionalNullable<String> updatedAfter, io.apimatic.core.types.OptionalNullable<String> updatedBefore, io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<Integer> limit) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getCatalogObjectIds() Getter for CatalogObjectIds.
String	getCursor() Getter for Cursor.
Integer	getLimit() Getter for Limit.
List<String>	getLocationIds() Getter for LocationIds.
List<String>	getStates() Getter for States.
List<String>	getTypes() Getter for Types.
String	getUpdatedAfter() Getter for UpdatedAfter.
String	getUpdatedBefore() Getter for UpdatedBefore.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetCatalogObjectIds() Internal Getter for CatalogObjectIds.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCursor() Internal Getter for Cursor.
protected io.apimatic.core.types.OptionalNullable<Integer>	internalGetLimit() Internal Getter for Limit.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetLocationIds() Internal Getter for LocationIds.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetStates() Internal Getter for States.
protected io.apimatic.core.types.OptionalNullable<List<String>>	internalGetTypes() Internal Getter for Types.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUpdatedAfter() Internal Getter for UpdatedAfter.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetUpdatedBefore() Internal Getter for UpdatedBefore.
BatchRetrieveInventoryChangesRequest.Builder	toBuilder() Builds a new BatchRetrieveInventoryChangesRequest.Builder object.
String	toString() Converts this BatchRetrieveInventoryChangesRequest into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchRetrieveInventoryChangesRequest

public BatchRetrieveInventoryChangesRequest(List<String> catalogObjectIds,
                                            List<String> locationIds,
                                            List<String> types,
                                            List<String> states,
                                            String updatedAfter,
                                            String updatedBefore,
                                            String cursor,
                                            Integer limit)

Initialization constructor.

Parameters:

catalogObjectIds - List of String value for catalogObjectIds.

locationIds - List of String value for locationIds.

types - List of String value for types.

states - List of String value for states.

updatedAfter - String value for updatedAfter.

updatedBefore - String value for updatedBefore.

cursor - String value for cursor.

limit - Integer value for limit.

BatchRetrieveInventoryChangesRequest

protected BatchRetrieveInventoryChangesRequest(io.apimatic.core.types.OptionalNullable<List<String>> catalogObjectIds,
                                               io.apimatic.core.types.OptionalNullable<List<String>> locationIds,
                                               io.apimatic.core.types.OptionalNullable<List<String>> types,
                                               io.apimatic.core.types.OptionalNullable<List<String>> states,
                                               io.apimatic.core.types.OptionalNullable<String> updatedAfter,
                                               io.apimatic.core.types.OptionalNullable<String> updatedBefore,
                                               io.apimatic.core.types.OptionalNullable<String> cursor,
                                               io.apimatic.core.types.OptionalNullable<Integer> limit)

Initialization constructor.

Parameters:

catalogObjectIds - List of String value for catalogObjectIds.

locationIds - List of String value for locationIds.

types - List of String value for types.

states - List of String value for states.

updatedAfter - String value for updatedAfter.

updatedBefore - String value for updatedBefore.

cursor - String value for cursor.

limit - Integer value for limit.

Method Detail

internalGetCatalogObjectIds

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetCatalogObjectIds()

Internal Getter for CatalogObjectIds. The filter to return results by `CatalogObject` ID. The filter is only applicable when set. The default value is null.

Returns:

Returns the Internal List of String

getCatalogObjectIds

public List<String> getCatalogObjectIds()

Getter for CatalogObjectIds. The filter to return results by `CatalogObject` ID. The filter is only applicable when set. The default value is null.

Returns:

Returns the List of String

internalGetLocationIds

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetLocationIds()

Internal Getter for LocationIds. The filter to return results by `Location` ID. The filter is only applicable when set. The default value is null.

Returns:

Returns the Internal List of String

getLocationIds

public List<String> getLocationIds()

Getter for LocationIds. The filter to return results by `Location` ID. The filter is only applicable when set. The default value is null.

Returns:

Returns the List of String

internalGetTypes

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetTypes()

Internal Getter for Types. The filter to return results by `InventoryChangeType` values other than `TRANSFER`. The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`.

Returns:

Returns the Internal List of String

getTypes

public List<String> getTypes()

Getter for Types. The filter to return results by `InventoryChangeType` values other than `TRANSFER`. The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`.

Returns:

Returns the List of String

internalGetStates

protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetStates()

Internal Getter for States. The filter to return `ADJUSTMENT` query results by `InventoryState`. This filter is only applied when set. The default value is null.

Returns:

Returns the Internal List of String

getStates

public List<String> getStates()

Getter for States. The filter to return `ADJUSTMENT` query results by `InventoryState`. This filter is only applied when set. The default value is null.

Returns:

Returns the List of String

internalGetUpdatedAfter

protected io.apimatic.core.types.OptionalNullable<String> internalGetUpdatedAfter()

Internal Getter for UpdatedAfter. The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).

Returns:

Returns the Internal String

getUpdatedAfter

public String getUpdatedAfter()

Getter for UpdatedAfter. The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).

Returns:

Returns the String

internalGetUpdatedBefore

protected io.apimatic.core.types.OptionalNullable<String> internalGetUpdatedBefore()

Internal Getter for UpdatedBefore. The filter to return results with their `created_at` or `calculated_at` value strictly before the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).

Returns:

Returns the Internal String

getUpdatedBefore

public String getUpdatedBefore()

Getter for UpdatedBefore. The filter to return results with their `created_at` or `calculated_at` value strictly before the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`).

Returns:

Returns the String

internalGetCursor

protected io.apimatic.core.types.OptionalNullable<String> internalGetCursor()

Internal Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the Internal String

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information.

Returns:

Returns the String

internalGetLimit

protected io.apimatic.core.types.OptionalNullable<Integer> internalGetLimit()

Internal Getter for Limit. The number of [records](entity:InventoryChange) to return.

Returns:

Returns the Internal Integer

getLimit

public Integer getLimit()

Getter for Limit. The number of [records](entity:InventoryChange) to return.

Returns:

Returns the Integer

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this BatchRetrieveInventoryChangesRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public BatchRetrieveInventoryChangesRequest.Builder toBuilder()

Builds a new BatchRetrieveInventoryChangesRequest.Builder object. Creates the instance with the state of the current model.

Returns:

a new BatchRetrieveInventoryChangesRequest.Builder object