ordersGet method

Future<Response<BuiltList<Order>>> ordersGet({
  1. String? tenantId,
  2. int? page,
  3. String? customerId,
  4. String? serialNumber,
  5. OrderStatus? status,
  6. CancelToken? cancelToken,
  7. Map<String, dynamic>? headers,
  8. Map<String, dynamic>? extra,
  9. ValidateStatus? validateStatus,
  10. ProgressCallback? onSendProgress,
  11. ProgressCallback? onReceiveProgress,
})

List all Orders List all Orders

Parameters:

  • tenantId - The id of the tenant
  • page - The page number
  • customerId - The id of the customer
  • serialNumber - The serialNumber of the order. Matches serialNumber that begin with the values
  • status - The status of the order.
  • cancelToken - A CancelToken that can be used to cancel the operation
  • headers - Can be used to add additional headers to the request
  • extras - Can be used to add flags to the request
  • validateStatus - A ValidateStatus callback that can be used to determine request success based on the HTTP status of the response
  • onSendProgress - A ProgressCallback that can be used to get the send progress
  • onReceiveProgress - A ProgressCallback that can be used to get the receive progress

Returns a Future containing a Response with a BuiltList<Order> as data Throws DioError if API call or serialization fails

Implementation

Future<Response<BuiltList<Order>>> ordersGet({
  String? tenantId,
  int? page,
  String? customerId,
  String? serialNumber,
  OrderStatus? status,
  CancelToken? cancelToken,
  Map<String, dynamic>? headers,
  Map<String, dynamic>? extra,
  ValidateStatus? validateStatus,
  ProgressCallback? onSendProgress,
  ProgressCallback? onReceiveProgress,
}) async {
  final _path = r'/orders';
  final _options = Options(
    method: r'GET',
    headers: <String, dynamic>{
      ...?headers,
    },
    extra: <String, dynamic>{
      'secure': <Map<String, String>>[
        {
          'type': 'apiKey',
          'name': 'ApiKeyAuth',
          'keyName': 'X-TOKEN',
          'where': 'header',
        },
      ],
      ...?extra,
    },
    validateStatus: validateStatus,
  );

  final _queryParameters = <String, dynamic>{
    if (tenantId != null) r'tenant_id': encodeQueryParameter(_serializers, tenantId, const FullType(String)),
    if (page != null) r'page': encodeQueryParameter(_serializers, page, const FullType(int)),
    if (customerId != null) r'customer_id': encodeQueryParameter(_serializers, customerId, const FullType(String)),
    if (serialNumber != null) r'serial_number': encodeQueryParameter(_serializers, serialNumber, const FullType(String)),
    if (status != null) r'status': encodeQueryParameter(_serializers, status, const FullType(OrderStatus)),
  };

  final _response = await _dio.request<Object>(
    _path,
    options: _options,
    queryParameters: _queryParameters,
    cancelToken: cancelToken,
    onSendProgress: onSendProgress,
    onReceiveProgress: onReceiveProgress,
  );

  BuiltList<Order> _responseData;

  try {
    const _responseType = FullType(BuiltList, [FullType(Order)]);
    _responseData = _serializers.deserialize(
      _response.data!,
      specifiedType: _responseType,
    ) as BuiltList<Order>;

  } catch (error, stackTrace) {
    throw DioError(
      requestOptions: _response.requestOptions,
      response: _response,
      type: DioErrorType.other,
      error: error,
    )..stackTrace = stackTrace;
  }

  return Response<BuiltList<Order>>(
    data: _responseData,
    headers: _response.headers,
    isRedirect: _response.isRedirect,
    requestOptions: _response.requestOptions,
    redirects: _response.redirects,
    statusCode: _response.statusCode,
    statusMessage: _response.statusMessage,
    extra: _response.extra,
  );
}