com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponsePhoneCall 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

/*
 * Verification | Sinch
 *
 * OpenAPI document version: 2.0.1
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit the class manually.
 */

package com.sinch.sdk.domains.verification.models.v1.webhooks;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sinch.sdk.domains.verification.models.v1.start.request.PhoneCallSpeech;

/** Phone Call Request Event Response */
@JsonDeserialize(builder = VerificationRequestEventResponsePhoneCallImpl.Builder.class)
public interface VerificationRequestEventResponsePhoneCall
    extends com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponse {

  /**
   * Get action
   *
   * @return action
   */
  VerificationEventResponseAction getAction();

  /**
   * The Phone Call PIN that should be entered by the user. Sinch servers automatically generate PIN
   * codes for Phone Call verification. If you want to set your own code, you can specify it in the
   * response to the Verification Request Event.
   *
   * @return code
   */
  String getCode();

  /**
   * Get speech
   *
   * @return speech
   */
  PhoneCallSpeech getSpeech();

  /**
   * Getting builder
   *
   * @return New Builder instance
   */
  static Builder builder() {
    return new VerificationRequestEventResponsePhoneCallImpl.Builder();
  }

  /** Dedicated Builder */
  interface Builder
      extends com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponse
          .Builder {

    /**
     * see getter
     *
     * @param action see getter
     * @return Current builder
     * @see #getAction
     */
    Builder setAction(VerificationEventResponseAction action);

    /**
     * see getter
     *
     * @param code see getter
     * @return Current builder
     * @see #getCode
     */
    Builder setCode(String code);

    /**
     * see getter
     *
     * @param speech see getter
     * @return Current builder
     * @see #getSpeech
     */
    Builder setSpeech(PhoneCallSpeech speech);

    /**
     * Create instance
     *
     * @return The instance build with current builder values
     */
    VerificationRequestEventResponsePhoneCall build();
  }
}