org.knowm.xchange.ripple.RippleAuthenticated Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xchange-ripple Show documentation

XChange implementation for the Ripple Network

There is a newer version: 5.2.0

package org.knowm.xchange.ripple;

import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.DELETE;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.MediaType;
import java.io.IOException;
import org.knowm.xchange.ripple.dto.RippleException;
import org.knowm.xchange.ripple.dto.trade.RippleOrderCancelRequest;
import org.knowm.xchange.ripple.dto.trade.RippleOrderCancelResponse;
import org.knowm.xchange.ripple.dto.trade.RippleOrderEntryRequest;
import org.knowm.xchange.ripple.dto.trade.RippleOrderEntryResponse;

/** See https://github.com/ripple/ripple-rest for up-to-date documentation. */
@Path("v1")
@Produces(MediaType.APPLICATION_JSON)
public interface RippleAuthenticated {

  /** Places an order */
  @POST
  @Path("accounts/{address}/orders")
  @Consumes(MediaType.APPLICATION_JSON)
  RippleOrderEntryResponse orderEntry(
      @PathParam("address") final String address,
      @QueryParam("validated") final boolean validated,
      final RippleOrderEntryRequest request)
      throws IOException, RippleException;

  /** Cancel an order */
  @DELETE
  @Path("accounts/{address}/orders/{orderId}")
  @Consumes(MediaType.APPLICATION_JSON)
  RippleOrderCancelResponse orderCancel(
      @PathParam("address") final String address,
      @PathParam("orderId") final long orderId,
      @QueryParam("validated") final boolean validated,
      final RippleOrderCancelRequest request)
      throws IOException, RippleException;
}