SearchCustomersRequest class

Annotations
  • @JsonSerializable()

Constructors

SearchCustomersRequest({required CustomerQuery query, String? cursor, int? limit})
const
SearchCustomersRequest.fromJson(Map<String, dynamic> json)
Converts a Map to an SearchCustomersRequest
factory

Properties

cursor → String?
Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query.
final
hashCode → int
The hash code for this object.
no setterinherited
limit → int?
The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. The limit is ignored if it is less than the minimum or greater than the maximum value. The default value is 100.
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
query → CustomerQuery
Query customers based on the given conditions and sort order. Calling SearchCustomers without an explicit query parameter returns all customers ordered alphabetically based on given_name and family_name.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Converts a SearchCustomersRequest to a Map
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited