createOrderNote function

Future<ApiResponse<OrderNoteView>> createOrderNote(ExsitedClient client, Object orderId, String note, { Map<String, Object?>? files, bool? raiseOnError, String? responseFormat, })

POST /api/{api_version}/orders/{order_id}/notes

Sent as a form, the text as the note field, and as multipart with any files beside it: the endpoint reads no JSON body.

Implementation

Future<ApiResponse<OrderNoteView>> createOrderNote(
  ExsitedClient client,
  Object orderId,
  String note, {
  Map<String, Object?>? files,
  bool? raiseOnError,
  String? responseFormat,
}) {
  if (note.isEmpty) {
    throw SdkUsageError(
        'note is required: the note text is the body of this request');
  }
  return client.sendPostRequest(OrdersUrls.orderNotes,
      pathParams: {'order_id': orderId},
      formData: {'note': note},
      files: files,
      raiseOnError: raiseOnError,
      responseFormat: responseFormat,
      dtoDecoder: OrderNoteView.fromMap);
}