api/src/main/java/org/apache/fineract/cn/teller/api/v1/client/TellerManager.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.fineract.cn.teller.api.v1.client;

import org.apache.fineract.cn.teller.api.v1.domain.Teller;
import org.apache.fineract.cn.teller.api.v1.domain.TellerBalanceSheet;
import org.apache.fineract.cn.teller.api.v1.domain.TellerDenomination;
import org.apache.fineract.cn.teller.api.v1.domain.TellerManagementCommand;
import org.apache.fineract.cn.teller.api.v1.domain.TellerTransaction;
import org.apache.fineract.cn.teller.api.v1.domain.TellerTransactionCosts;
import org.apache.fineract.cn.teller.api.v1.domain.UnlockDrawerCommand;
import java.util.List;
import javax.validation.Valid;
import org.apache.fineract.cn.api.annotation.ThrowsException;
import org.apache.fineract.cn.api.annotation.ThrowsExceptions;
import org.apache.fineract.cn.api.util.CustomFeignClientsConfiguration;
import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;

@FeignClient(path = "/teller/v1", url = "http://${kubernetes.teller.service.name}:${kubernetes.teller.server.port}", configuration = CustomFeignClientsConfiguration.class)
public interface TellerManager {

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller",
      method = RequestMethod.POST,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerValidationException.class),
      @ThrowsException(status = HttpStatus.CONFLICT, exception = TellerAlreadyExistsException.class)
  })
  void create(@PathVariable("officeIdentifier") final String officeIdentifier, @RequestBody @Valid final Teller teller);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller/{tellerCode}",
      method = RequestMethod.GET,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.ALL_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerValidationException.class)
  })
  Teller find(@PathVariable("officeIdentifier") final String officeIdentifier,
              @PathVariable("tellerCode") final String tellerCode);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller",
      method = RequestMethod.GET,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.ALL_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerValidationException.class)
  })
  List<Teller> fetch(@PathVariable("officeIdentifier") final String officeIdentifier);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller/{tellerCode}",
      method = RequestMethod.PUT,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerValidationException.class)
  })
  void change(@PathVariable("officeIdentifier") final String officeIdentifier,
              @PathVariable("tellerCode") final String tellerCode,
              @RequestBody @Valid final Teller teller);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller/{tellerCode}/commands",
      method = RequestMethod.POST,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerValidationException.class)
  })
  void post(@PathVariable("officeIdentifier") final String officeIdentifier,
            @PathVariable("tellerCode") final String tellerCode,
            @RequestBody @Valid final TellerManagementCommand tellerManagementCommand);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller/{tellerCode}/balance",
      method = RequestMethod.GET,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.ALL_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class)
  })
  TellerBalanceSheet getBalance(@PathVariable("officeIdentifier") final String officeIdentifier,
                                @PathVariable("tellerCode") final String tellerCode);

  @RequestMapping(
      value = "/teller/{tellerCode}/drawer",
      method = RequestMethod.POST,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.CONFLICT, exception = TellerNotFoundException.class)
  })
  Teller unlockDrawer(@PathVariable("tellerCode") final String tellerCode,
                    @RequestBody @Valid final UnlockDrawerCommand unlockDrawerCommand);

  @RequestMapping(
      value = "/teller/{tellerCode}",
      method = RequestMethod.POST,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerValidationException.class)
  })
  void post(@PathVariable("tellerCode") final String tellerCode,
            @RequestParam(value = "command", required = true) final String command);

  @RequestMapping(
      value = "/teller/{tellerCode}/transactions",
      method = RequestMethod.POST,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.BAD_REQUEST, exception = TellerTransactionValidationException.class),
      @ThrowsException(status = HttpStatus.CONFLICT, exception = TransactionProcessingException.class)
  })
  TellerTransactionCosts post(@PathVariable("tellerCode") final String tellerCode,
                              @RequestBody @Valid final TellerTransaction tellerTransaction);

  @RequestMapping(
      value = "/teller/{tellerCode}/transactions/{identifier}",
      method = RequestMethod.POST,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.CONFLICT, exception = TransactionProcessingException.class)
  })
  void confirm(@PathVariable("tellerCode") final String tellerCode,
               @PathVariable("identifier") final String tellerTransactionIdentifier,
               @RequestParam(value = "command", required = true) final String command,
               @RequestParam(value = "charges", required = false, defaultValue = "excluded") final String charges);

  @RequestMapping(
      value = "/teller/{tellerCode}/transactions",
      method = RequestMethod.GET,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.ALL_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class)
  })
  List<TellerTransaction> fetch(@PathVariable("tellerCode") final String tellerCode,
                                @RequestParam(value = "status", required = false) final String status);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller/{tellerCode}",
      method = RequestMethod.DELETE,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.ALL_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.CONFLICT, exception = TellerValidationException.class)
  })
  void deleteTeller(@PathVariable("officeIdentifier") final String officeIdentifier,
                    @PathVariable("tellerCode") final String tellerCode);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller/{tellerCode}/denominations",
      method = RequestMethod.POST,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.APPLICATION_JSON_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.CONFLICT, exception = TellerValidationException.class)
  })
  void saveTellerDenomination(@PathVariable("officeIdentifier") final String officeIdentifier,
                              @PathVariable("tellerCode") final String tellerCode,
                              @RequestBody @Valid final TellerDenomination tellerDenomination);

  @RequestMapping(
      value = "/offices/{officeIdentifier}/teller/{tellerCode}/denominations",
      method = RequestMethod.GET,
      consumes = MediaType.APPLICATION_JSON_VALUE,
      produces = MediaType.ALL_VALUE
  )
  @ThrowsExceptions({
      @ThrowsException(status = HttpStatus.NOT_FOUND, exception = TellerNotFoundException.class),
      @ThrowsException(status = HttpStatus.CONFLICT, exception = TellerValidationException.class)
  })
  List<TellerDenomination> fetchTellerDenominations(
      @PathVariable("officeIdentifier") final String officeIdentifier,
      @PathVariable("tellerCode") final String tellerCode,
      @RequestParam(value = "dateRange", required = false) final String dateRange);
}