io.relayr.java.api.AccountsApi Maven / Gradle / Ivy

Go to download
package io.relayr.java.api;

import java.util.List;

import io.relayr.java.model.account.Account;
import io.relayr.java.model.account.AccountDevice;
import io.relayr.java.model.account.AccountUrl;
import retrofit.http.GET;
import retrofit.http.Path;
import retrofit.http.Query;
import rx.Observable;

public interface AccountsApi {

    /**
     * Returns list of available accounts connectable to the relayr platform.
     * @return an {@link Observable} with a list of all accounts.
     */
    @GET("/accounts") Observable> getAccounts();

    /**
     * Returns list of available devices for the account. Use {@link Account#getDevices()} instead.
     * @param accountName as an identificator {@link Account#name}
     * @return an {@link Observable} with a list of all account devices.
     */
    @GET("/accounts/{accountName}/devices")
    Observable> getAccountDevices(@Path("accountName") String accountName);

    /**
     * Returns login url for the account.
     * @param accountName as an identificator {@link Account#name}
     * @param redirectUri
     * @return login url
     */
    @GET("/accounts/{accountName}/oauthurl")
    Observable getLoginUrl(@Path("accountName") String accountName,
                                       @Query("redirect_uri") String redirectUri);

}