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

import com.sinch.sdk.domains.verification.models.Link;
import com.sinch.sdk.domains.verification.models.VerificationId;
import java.util.Collection;

/**
 * Base class to all Start verification requests
 *
 * @since 1.0
 */
public class StartVerificationResponse {

  private final VerificationId id;
  private final Collection links;

  protected StartVerificationResponse(VerificationId id, Collection links) {
    this.id = id;
    this.links = links;
  }

  /**
   * Verification identifier used to query for status.
   *
   * @return Id value
   * @since 1.0
   */
  public VerificationId getId() {
    return id;
  }

  /**
   * Available methods and actions which can be done after a successful Verification
   *
   * @return Links value
   * @since 1.0
   */
  public Collection getLinks() {
    return links;
  }

  @Override
  public String toString() {
    return "StartVerificationResponse{" + "id='" + id + '\'' + ", links=" + links + '}';
  }

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

  /**
   * Dedicated Builder
   *
   * @param  Builder
   * @since 1.0
   */
  public static class Builder> {

    VerificationId id;
    Collection links;

    protected Builder() {}
    ;

    /**
     * See {@link StartVerificationResponse#getId() getter}
     *
     * @param id see getter
     * @return The current builder
     * @since 1.0
     */
    public B setId(VerificationId id) {
      this.id = id;
      return self();
    }

    /**
     * See {@link StartVerificationResponse#getLinks() getter}
     *
     * @param links see getter
     * @return The current builder
     * @since 1.0
     */
    public B setLinks(Collection links) {
      this.links = links;
      return self();
    }

    /**
     * Create instance
     *
     * @return The instance build with current builder values
     * @since 1.0
     */
    public StartVerificationResponse build() {
      return new StartVerificationResponse(id, links);
    }

    @SuppressWarnings("unchecked")
    protected B self() {
      return (B) this;
    }
  }
}