com.sinch.sdk.domains.sms.adapters.DeliveryReportsService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation
SDK providing a Java API for the Sinch REST APIs.
There is a newer version: 1.4.0
package com.sinch.sdk.domains.sms.adapters;

import com.sinch.sdk.core.exceptions.ApiException;
import com.sinch.sdk.core.http.AuthManager;
import com.sinch.sdk.core.http.HttpClient;
import com.sinch.sdk.core.http.HttpMapper;
import com.sinch.sdk.core.models.pagination.Page;
import com.sinch.sdk.core.utils.EnumDynamic;
import com.sinch.sdk.domains.sms.adapters.api.v1.DeliveryReportsApi;
import com.sinch.sdk.domains.sms.adapters.converters.DeliveryReportDtoConverter;
import com.sinch.sdk.domains.sms.models.DeliveryReportBatch;
import com.sinch.sdk.domains.sms.models.DeliveryReportRecipient;
import com.sinch.sdk.domains.sms.models.DeliveryReportType;
import com.sinch.sdk.domains.sms.models.SMSCursorPageNavigator;
import com.sinch.sdk.domains.sms.models.dto.v1.DeliveryReportListDto;
import com.sinch.sdk.domains.sms.models.requests.DeliveryReportBatchGetRequestParameters;
import com.sinch.sdk.domains.sms.models.requests.DeliveryReportListRequestParameters;
import com.sinch.sdk.domains.sms.models.responses.DeliveryReportsListResponse;
import com.sinch.sdk.models.SmsContext;
import java.time.Instant;
import java.util.Collection;
import java.util.Map;
import java.util.stream.Collectors;

/**
 * Delivery reports Service
 *
 * The REST API uses message statuses and error codes in delivery reports, which refer to the
 * state of the batch and can be present in either Retrieve
 * a delivery report or sent as a callback.
 *
 * @see https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports
 * @since 1.0
 */
public class DeliveryReportsService implements com.sinch.sdk.domains.sms.DeliveryReportsService {

  private final String uriUUID;
  private final DeliveryReportsApi api;

  protected DeliveryReportsApi getApi() {
    return this.api;
  }

  public DeliveryReportsService(
      String uriUUID,
      SmsContext context,
      HttpClient httpClient,
      Map authManagers) {
    this.uriUUID = uriUUID;
    this.api =
        new DeliveryReportsApi(httpClient, context.getSmsServer(), authManagers, new HttpMapper());
  }

  public DeliveryReportBatch get(String batchId, DeliveryReportBatchGetRequestParameters parameters)
      throws ApiException {

    DeliveryReportBatchGetRequestParameters guardParameters =
        null != parameters ? parameters : DeliveryReportBatchGetRequestParameters.builder().build();

    return DeliveryReportDtoConverter.convert(
        getApi()
            .getDeliveryReportByBatchId(
                uriUUID,
                batchId,
                guardParameters.getType().map(DeliveryReportType::value).orElse(null),
                guardParameters
                    .geStatues()
                    .map(f -> f.stream().map(EnumDynamic::value).collect(Collectors.joining(",")))
                    .orElse(null),
                guardParameters
                    .getCodes()
                    .map(f -> f.stream().map(Object::toString).collect(Collectors.joining(",")))
                    .orElse(null)));
  }

  public DeliveryReportRecipient getForNumber(String batchId, String recipient)
      throws ApiException {
    return DeliveryReportDtoConverter.convert(
        getApi().getDeliveryReportByPhoneNumber(uriUUID, batchId, recipient));
  }

  public DeliveryReportsListResponse list() throws ApiException {
    return this.list(null);
  }

  public DeliveryReportsListResponse list(DeliveryReportListRequestParameters parameters)
      throws ApiException {
    DeliveryReportListRequestParameters guardParameters =
        null != parameters ? parameters : DeliveryReportListRequestParameters.builder().build();

    DeliveryReportListDto response =
        getApi()
            .getDeliveryReports(
                uriUUID,
                guardParameters.getPage().orElse(null),
                guardParameters.getPageSize().orElse(null),
                guardParameters.getStartDate().map(Instant::toString).orElse(null),
                guardParameters.getEndDate().map(Instant::toString).orElse(null),
                guardParameters
                    .getStatuses()
                    .map(f -> f.stream().map(EnumDynamic::value).collect(Collectors.joining(",")))
                    .orElse(null),
                guardParameters
                    .getCodes()
                    .map(f -> f.stream().map(Object::toString).collect(Collectors.joining(",")))
                    .orElse(null),
                guardParameters.getClientReference().orElse(null));

    Collection content = DeliveryReportDtoConverter.convert(response);
    SMSCursorPageNavigator navigator =
        new SMSCursorPageNavigator(response.getPage(), response.getPageSize());

    return new DeliveryReportsListResponse(this, new Page<>(guardParameters, content, navigator));
  }
}