com.sinch.sdk.domains.verification.api.v1.VerificationStartService 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.api.v1;

import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestData;
import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestFlashCall;
import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestPhoneCall;
import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestSms;
import com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponseData;
import com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponseFlashCall;
import com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponsePhoneCall;
import com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponseSms;

/**
 * Verification Start Service
 *
 * Start new verification requests
 *
 * This method is used by the mobile and web Verification SDKs to start a verification. It can
 * also be used to request a verification from your backend, by making a request.
 *
 * @see https://developers.sinch.com/docs/verification/api-reference/verification/tag/Verifications
 * @since 1.1
 */
public interface VerificationStartService {

  /**
   * Start verification by {@link
   * com.sinch.sdk.domains.verification.models.v1.VerificationMethod#SMS}
   *
   * @param parameters Parameters to be used to start verification
   * @return Verification response
   * @since 1.1
   */
  VerificationStartResponseSms startSms(VerificationStartRequestSms parameters);

  /**
   * Start verification by {@link
   * com.sinch.sdk.domains.verification.models.v1.VerificationMethod#FLASH_CALL}
   *
   * @param parameters Parameters to be used to start verification
   * @return Verification response
   * @since 1.1
   */
  VerificationStartResponseFlashCall startFlashCall(VerificationStartRequestFlashCall parameters);

  /**
   * Start verification by {@link
   * com.sinch.sdk.domains.verification.models.v1.VerificationMethod#PHONE_CALL}
   *
   * @param parameters Parameters to be used to start verification
   * @return Verification response
   * @since 1.1
   */
  VerificationStartResponsePhoneCall startPhoneCall(VerificationStartRequestPhoneCall parameters);

  /**
   * Start verification by {@link
   * com.sinch.sdk.domains.verification.models.v1.VerificationMethod#DATA}
   *
   * @param parameters Parameters to be used to start verification
   * @return Verification response
   * @since 1.1
   */
  VerificationStartResponseData startData(VerificationStartRequestData parameters);
}