LEMUBIT/PayantAndroid

package com.lemubit.lemuel.androidpayant.api;

import com.lemubit.lemuel.androidpayant.operations.OperationStatus;
import com.lemubit.lemuel.androidpayant.operations.clients.model.PayantClient;
import com.lemubit.lemuel.androidpayant.operations.clients.networkResponse.PayantClientInfo;
import com.lemubit.lemuel.androidpayant.operations.invoices.model.PayantInvoice;
import com.lemubit.lemuel.androidpayant.operations.invoices.networkResponse.PayantInvoiceHistoryInfo;
import com.lemubit.lemuel.androidpayant.operations.invoices.networkResponse.PayantInvoiceInfo;
import com.lemubit.lemuel.androidpayant.operations.payments.model.PayantPayment;
import com.lemubit.lemuel.androidpayant.operations.payments.networkResponse.PayantPaymentHistoryInfo;
import com.lemubit.lemuel.androidpayant.operations.payments.networkResponse.PayantPaymentInfo;
import com.lemubit.lemuel.androidpayant.operations.product.model.PayantProduct;
import com.lemubit.lemuel.androidpayant.operations.product.networkResponse.PayantAddProductInfo;
import com.lemubit.lemuel.androidpayant.operations.product.networkResponse.PayantProductInfo;
import com.lemubit.lemuel.androidpayant.operations.product.networkResponse.PayantProductInfoList;
import com.lemubit.lemuel.androidpayant.operations.wallets.model.PassCodes;
import com.lemubit.lemuel.androidpayant.operations.wallets.model.PayantWallet;
import com.lemubit.lemuel.androidpayant.operations.wallets.model.PayantWalletWithdraw;
import com.lemubit.lemuel.androidpayant.operations.wallets.model.PayantWalletWithdrawBulk;
import com.lemubit.lemuel.androidpayant.operations.wallets.networkResponse.PayantWalletInfo;
import com.lemubit.lemuel.androidpayant.operations.wallets.networkResponse.PayantWalletInfoList;
import com.lemubit.lemuel.androidpayant.operations.wallets.networkResponse.PayantWalletTransactionsInfo;
import com.lemubit.lemuel.androidpayant.operations.wallets.networkResponse.PayantWalletWithdrawBulkInfo;
import com.lemubit.lemuel.androidpayant.operations.wallets.networkResponse.PayantWalletWithdrawInfo;
import com.lemubit.lemuel.androidpayant.utils.PayantHistory;

import retrofit2.Call;
import retrofit2.http.Body;
import retrofit2.http.DELETE;
import retrofit2.http.GET;
import retrofit2.http.Header;
import retrofit2.http.POST;
import retrofit2.http.PUT;
import retrofit2.http.Path;

/**
 * @author lemuel
 */
public interface PayantApiService {

    /**
     * Save new Client information found in {@code PayantClient}.
     *
     * @param contentType
     * @param authorization
     * @param payantClient
     */
    @POST("clients")
    Call<PayantClientInfo> addClient(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Body PayantClient payantClient);

    /**
     * Gets information about client using Client ID.
     *
     * @param contentType
     * @param authorization
     * @param clientID
     */
    @GET("clients/{id}")
    Call<PayantClientInfo> getClient(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("id") int clientID);

    /**
     * Update client identified using clientID with information contained in PayantClient object.
     *
     * @param contentType
     * @param authorization
     * @param clientID
     * @param payantClient
     */
    @PUT("clients/{id}")
    Call<PayantClientInfo> editClient(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("id") int clientID, @Body PayantClient payantClient);


    /**
     * Delete a client identified using clientID.
     *
     * @param contentType
     * @param authorization
     * @param clientID
     */
    @DELETE("clients/{id}")
    Call<OperationStatus> deleteClient(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("id") int clientID);


    /**
     * Save new Invoice information found in {@code PayantInvoice}.
     *
     * @param contentType
     * @param authorization
     * @param payantInvoice
     */
    @POST("invoices")
    Call<PayantInvoiceInfo> addInvoice(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Body PayantInvoice payantInvoice);


    /**
     * Get invoice information using the invoice Reference Code.
     *
     * @param contentType
     * @param authorization
     * @param invoiceReferenceCode
     */
    @GET("invoices/{reference_code}")
    Call<PayantInvoiceInfo> getInvoice(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String invoiceReferenceCode);


    /**
     * Send invoice with Reference Code: {@code invoiceReferenceCode}.
     *
     * @param contentType
     * @param authorization
     * @param invoiceReferenceCode
     */
    @GET("invoices/send/{reference_code}")
    Call<OperationStatus> sendInvoice(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String invoiceReferenceCode);


    /**
     * Get payant invoice history using the parameters found in {@code PayantHistory}
     *
     * @param contentType
     * @param authorization
     * @param payantHistory
     */
    @POST("/invoices/history")
    Call<PayantInvoiceHistoryInfo> getInvoiceHistory(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Body PayantHistory payantHistory);


    /**
     * Delete invoice with reference code {@code referenceCode}
     *
     * @param contentType
     * @param authorization
     * @param referenceCode
     */
    @DELETE("invoices/{reference_code}")
    Call<OperationStatus> deleteInvoice(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String referenceCode);


    /**
     * Add new Payment with information found in {@code PayantPayment}
     *
     * @param contentType
     * @param authorization
     * @param payantPayment
     */
    @POST("payments")
    Call<PayantPaymentInfo> addPayment(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Body PayantPayment payantPayment);


    /**
     * Get payment information using the payment Reference Code {@code paymentReferenceCode}.
     *
     * @param contentType
     * @param authorization
     * @param paymentReferenceCode
     */
    @GET("payments/{reference_code}")
    Call<PayantPaymentInfo> getPayment(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String paymentReferenceCode);


    /**
     * Get payment history information
     *
     * @param contentType
     * @param authorization
     * @param payantHistory
     */
    @POST("/payments/history")
    Call<PayantPaymentHistoryInfo> getPaymentHistory(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Body PayantHistory payantHistory);


    /**
     * Add new wallet using information found in {@code payantWallet}
     *
     * @param contentType
     * @param authorization
     * @param payantWallet
     */
    @POST("wallets")
    Call<PayantWalletInfo> addWallet(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Body PayantWallet payantWallet);


    /**
     * Get payment information using the payment Reference Code {@code paymentReferenceCode}.
     *
     * @param contentType
     * @param authorization
     * @param walletReferenceCode
     */
    @GET("wallets/{reference_code}")
    Call<PayantWalletInfo> getWallet(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String walletReferenceCode);


    /**
     * Change passcode of wallet with reference code {@code walletReferenceCode} to passcode found in {@code passCodes}
     *
     * @param contentType
     * @param authorization
     * @param walletReferenceCode
     * @param passCodes
     */
    @PUT("wallets/{reference_code}")
    Call<OperationStatus> changeWalletPassCode(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String walletReferenceCode, @Body PassCodes passCodes);


    /**
     * Get list of available wallets
     *
     * @param contentType
     * @param authorization
     */
    @GET("wallets")
    Call<PayantWalletInfoList> getWallets(@Header("Content-Type") String contentType, @Header("Authorization") String authorization);


    /**
     * Enable/Disable wallet
     *
     * @param contentType
     * @param authorization
     */
    @GET("wallets/status/{reference_code}")
    Call<OperationStatus> disableOrEnableWallet(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String walletReferenceCode);


    /**
     * @param contentType
     * @param authorization
     * @param walletReferenceCode
     * @param payantWalletWithdraw
     */
    @POST("wallets/withdraw/{reference_code}")
    Call<PayantWalletWithdrawInfo> withdrawFromWallet(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String walletReferenceCode, @Body PayantWalletWithdraw payantWalletWithdraw);

    /**
     * @param contentType
     * @param authorization
     * @param walletReferenceCode
     * @param payantWalletWithdrawBulk
     */
    @POST("wallets/withdraw/{reference_code}")
    Call<PayantWalletWithdrawBulkInfo> withdrawFromWalletBulk(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String walletReferenceCode, @Body PayantWalletWithdrawBulk payantWalletWithdrawBulk);


    /**
     * @param contentType
     * @param authorization
     * @param walletReferenceCode
     * @param payantHistory
     */
    @POST("wallets/transactions/{reference_code}")
    Call<PayantWalletTransactionsInfo> getWalletTransactions(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("reference_code") String walletReferenceCode, @Body PayantHistory payantHistory);


    /**
     * @param contentType
     * @param authorization
     * @param payantProduct
     */
    @POST("products")
    Call<PayantAddProductInfo> addNewProduct(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Body PayantProduct payantProduct);


    /**
     * @param contentType
     * @param authorization
     * @param productID
     */
    @GET("products/{product_id}")
    Call<PayantProductInfo> getProduct(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("product_id") String productID);


    /**
     * @param contentType
     * @param authorization
     * @param productID
     * @param payantProduct
     */
    @PUT("products/{product_id}")
    Call<PayantAddProductInfo> editProduct(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("product_id") String productID, @Body PayantProduct payantProduct);


    /**
     * @param contentType
     * @param authorization
     */
    @GET("products")
    Call<PayantProductInfoList> getAllProduct(@Header("Content-Type") String contentType, @Header("Authorization") String authorization);


    /**
     * @param contentType
     * @param authorization
     * @param productID
     */
    @DELETE("products/{product_id}")
    Call<OperationStatus> deleteProduct(@Header("Content-Type") String contentType, @Header("Authorization") String authorization, @Path("product_id") String productID);

}