com.sinch.sdk.domains.verification.models.VerificationReportFlashCall 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.verification.models;

import com.sinch.sdk.domains.verification.models.requests.StartVerificationFlashCallRequestParameters;

/**
 * Verification report related to a {@link
 * com.sinch.sdk.domains.verification.VerificationsService#startFlashCall(StartVerificationFlashCallRequestParameters)}
 * of type {@link
 * com.sinch.sdk.domains.verification.models.requests.VerificationReportFlashCallRequestParameters
 * VerificationReportFlashCallRequestParameters}
 *
 * @since 1.0
 */
public class VerificationReportFlashCall extends VerificationReport {

  private final Price verificationPrice;
  private final Price terminationPrice;
  private final Integer billableDuration;
  private final VerificationSourceType source;

  private VerificationReportFlashCall(
      VerificationId id,
      VerificationReportStatusType status,
      VerificationReportReasonType reason,
      VerificationReference reference,
      Price verificationPrice,
      Price terminationPrice,
      Integer billableDuration,
      VerificationSourceType source) {
    super(id, status, reason, reference);
    this.verificationPrice = verificationPrice;
    this.terminationPrice = terminationPrice;
    this.billableDuration = billableDuration;
    this.source = source;
  }

  /**
   * The maximum price charged for this verification process.
   *
   * This property will appear in the body of the response with a delay. It will become visible
   * only when the verification status is other than {@link VerificationReportStatusType#PENDING
   * PENDING}
   *
   * @return Verification price object
   * @since 1.0
   */
  public Price getVerificationPrice() {
    return verificationPrice;
  }

  /**
   * The maximum cost of the call made during this verification process.
   *
   * 
Present only when termination debiting is enabled (disabled by default).
   *
   * 
This property will appear in the body of the response with a delay. It will become visible
   * only after the call is completed, when its cost is known to Sinch.
   *
   * @return The termination price object
   * @since 1.0
   */
  public Price getTerminationPrice() {
    return terminationPrice;
  }

  /**
   * The time of the call for which the fee was charged.
   *
   * 
Present only when termination debiting is enabled (disabled by default).
   *
   * Depending on the type of rounding used, the value is the actual call time rounded to the
   * nearest second, minute or other value.
   *
   * @return The billable price object
   * @since 1.0
   */
  public Integer getBillableDuration() {
    return billableDuration;
  }

  /**
   * Free text that the client is sending, used to show if the call/SMS was intercepted or not.
   *
   * @return source value
   */
  public VerificationSourceType getSource() {
    return source;
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    return "VerificationReportFlashCall{"
        + "verificationPrice="
        + verificationPrice
        + ", terminationPrice="
        + terminationPrice
        + ", billableDuration="
        + billableDuration
        + ", source='"
        + source
        + '\''
        + "} "
        + super.toString();
  }

  /**
   * Getting Builder
   *
   * @return New Builder instance
   * @since 1.0
   */
  public static Builder builder() {
    return new Builder();
  }

  /** Dedicated Builder */
  public static class Builder extends VerificationReport.Builder {

    Price verificationPrice;
    Price terminationPrice;
    Integer billableDuration;
    VerificationSourceType source;

    private Builder() {}

    /**
     * See {@link VerificationReportFlashCall#getVerificationPrice()} getter
     *
     * @param verificationPrice See getter
     * @return Current builder
     * @since 1.0
     */
    public Builder setVerificationPrice(Price verificationPrice) {
      this.verificationPrice = verificationPrice;
      return this;
    }

    /**
     * See {@link VerificationReportFlashCall#getTerminationPrice()} getter
     *
     * @param terminationPrice See getter
     * @return Current builder
     * @since 1.0
     */
    public Builder setTerminationPrice(Price terminationPrice) {
      this.terminationPrice = terminationPrice;
      return this;
    }

    /**
     * See {@link VerificationReportFlashCall#getBillableDuration()} getter
     *
     * @param billableDuration See getter
     * @return Current builder
     * @since 1.0
     */
    public Builder setBillableDuration(Integer billableDuration) {
      this.billableDuration = billableDuration;
      return this;
    }

    /**
     * See {@link VerificationReportFlashCall#getSource()} getter
     *
     * @param source See getter
     * @return Current builder
     * @since 1.0
     */
    public Builder setSource(VerificationSourceType source) {
      this.source = source;
      return this;
    }

    /**
     * Create instance
     *
     * @return The instance build with current builder values
     * @since 1.0
     */
    public VerificationReportFlashCall build() {
      return new VerificationReportFlashCall(
          id,
          status,
          reason,
          reference,
          verificationPrice,
          terminationPrice,
          billableDuration,
          source);
    }

    @Override
    protected Builder self() {
      return this;
    }
  }
}