listReferrals method
Future<Response<BuiltList<Referral> > >
listReferrals({
- String? q,
- String? sort,
- DateTime? invitedAtAfter,
- DateTime? invitedAtBefore,
- bool? isPremium,
- int? perPage,
- int? page,
- CancelToken? cancelToken,
- Map<
String, dynamic> ? headers, - Map<
String, dynamic> ? extra, - ValidateStatus? validateStatus,
- ProgressCallback? onSendProgress,
- ProgressCallback? onReceiveProgress,
Get referrals list
Parameters:
q
- Search querysort
- Sort by provided fieldinvitedAtAfter
- Filter by invited date-time after provided valueinvitedAtBefore
- Filter by invited date-time before provided valueisPremium
- Filter by invitees is_premium statusperPage
page
cancelToken
- ACancelToken
that can be used to cancel the operationheaders
- Can be used to add additional headers to the requestextras
- Can be used to add flags to the requestvalidateStatus
- AValidateStatus
callback that can be used to determine request success based on the HTTP status of the responseonSendProgress
- AProgressCallback
that can be used to get the send progressonReceiveProgress
- AProgressCallback
that can be used to get the receive progress
Returns a Future containing a Response
with a BuiltList<Referral>
as data
Throws DioError
if API call or serialization fails
Implementation
Future<Response<BuiltList<Referral>>> listReferrals({
String? q,
String? sort,
DateTime? invitedAtAfter,
DateTime? invitedAtBefore,
bool? isPremium,
int? perPage,
int? page,
CancelToken? cancelToken,
Map<String, dynamic>? headers,
Map<String, dynamic>? extra,
ValidateStatus? validateStatus,
ProgressCallback? onSendProgress,
ProgressCallback? onReceiveProgress,
}) async {
final _path = r'/referral/referrals/';
final _options = Options(
method: r'GET',
headers: <String, dynamic>{
...?headers,
},
extra: <String, dynamic>{
'secure': <Map<String, String>>[
{
'type': 'http',
'scheme': 'bearer',
'name': 'bearerAuth',
},
],
...?extra,
},
validateStatus: validateStatus,
);
final _queryParameters = <String, dynamic>{
if (q != null) r'q': encodeQueryParameter(_serializers, q, const FullType(String)),
if (sort != null) r'sort': encodeQueryParameter(_serializers, sort, const FullType(String)),
if (invitedAtAfter != null) r'invited_at_after': encodeQueryParameter(_serializers, invitedAtAfter, const FullType(DateTime)),
if (invitedAtBefore != null) r'invited_at_before': encodeQueryParameter(_serializers, invitedAtBefore, const FullType(DateTime)),
if (isPremium != null) r'is_premium': encodeQueryParameter(_serializers, isPremium, const FullType(bool)),
if (perPage != null) r'per_page': encodeQueryParameter(_serializers, perPage, const FullType(int)),
if (page != null) r'page': encodeQueryParameter(_serializers, page, const FullType(int)),
};
final _response = await _dio.request<Object>(
_path,
options: _options,
queryParameters: _queryParameters,
cancelToken: cancelToken,
onSendProgress: onSendProgress,
onReceiveProgress: onReceiveProgress,
);
BuiltList<Referral>? _responseData;
try {
final rawResponse = _response.data;
_responseData = rawResponse == null ? null : _serializers.deserialize(
rawResponse,
specifiedType: const FullType(BuiltList, [FullType(Referral)]),
) as BuiltList<Referral>;
} catch (error, stackTrace) {
throw DioError(
requestOptions: _response.requestOptions,
response: _response,
type: DioErrorType.unknown,
error: error,
stackTrace: stackTrace,
);
}
return Response<BuiltList<Referral>>(
data: _responseData,
headers: _response.headers,
isRedirect: _response.isRedirect,
requestOptions: _response.requestOptions,
redirects: _response.redirects,
statusCode: _response.statusCode,
statusMessage: _response.statusMessage,
extra: _response.extra,
);
}