Skip to content

Commit

Permalink
docs: Synchronized generated sources with enhanced description for ja…
Browse files Browse the repository at this point in the history
…vadoc
  • Loading branch information
JPPortier committed Jun 21, 2024
1 parent aacb2ed commit 69d4d2f
Show file tree
Hide file tree
Showing 37 changed files with 64 additions and 32 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/** declaration */
/** Price */
@JsonDeserialize(builder = PriceImpl.Builder.class)
public interface Price {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,25 @@
/** The type of the verification request. */
public class VerificationMethod extends EnumDynamic<String, VerificationMethod> {

/** Verification by SMS message with a PIN code. */
public static final VerificationMethod SMS = new VerificationMethod("sms");

/**
* Verification by placing a flashVerificationResultEvent call (missed call) and detecting the
* incoming calling number (CLI).
*/
public static final VerificationMethod FLASH_CALL = new VerificationMethod("flashcall");

/**
* Verification by placing a PSTN call to the user&#39;s phone and playing an announcement, asking
* the user to press a particular digit to verify the phone number.
*/
public static final VerificationMethod PHONE_CALL = new VerificationMethod("callout");

/**
* Data verification. Verification by accessing internal infrastructure of mobile carriers to
* verify if given verification attempt was originated from device with matching phone number.
*/
public static final VerificationMethod DATA = new VerificationMethod("seamless");

private static final EnumSupportDynamic<String, VerificationMethod> ENUM_SUPPORT =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,25 @@
/** The status of the verification */
public class VerificationStatus extends EnumDynamic<String, VerificationStatus> {

/** The verification is ongoing. */
public static final VerificationStatus PENDING = new VerificationStatus("PENDING");

/** The verification was successful. */
public static final VerificationStatus SUCCESSFUL = new VerificationStatus("SUCCESSFUL");

/** The verification attempt was made, but the number wasn&#39;t verified. */
public static final VerificationStatus FAIL = new VerificationStatus("FAIL");

/** The verification attempt was denied by Sinch or your backend. */
public static final VerificationStatus DENIED = new VerificationStatus("DENIED");

/** The verification attempt was aborted by requesting a new verification. */
public static final VerificationStatus ABORTED = new VerificationStatus("ABORTED");

/**
* The verification couldn&#39;t be completed due to a network error or the number being
* unreachable.
*/
public static final VerificationStatus ERROR = new VerificationStatus("ERROR");

private static final EnumSupportDynamic<String, VerificationStatus> ENUM_SUPPORT =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** Flash Call Verification Report Request */
@JsonDeserialize(builder = VerificationReportRequestFlashCallImpl.Builder.class)
public interface VerificationReportRequestFlashCall
extends com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** Phone Call Verification Report Request */
@JsonDeserialize(builder = VerificationReportRequestPhoneCallImpl.Builder.class)
public interface VerificationReportRequestPhoneCall
extends com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** SMS Verification Report Request */
@JsonDeserialize(builder = VerificationReportRequestSmsImpl.Builder.class)
public interface VerificationReportRequestSms
extends com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.sinch.sdk.domains.verification.models.v1.VerificationStatus;
import com.sinch.sdk.domains.verification.models.v1.VerificationStatusReason;

/** declaration */
/** VerificationReportResponse */
public interface VerificationReportResponse {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import com.sinch.sdk.domains.verification.models.v1.VerificationStatus;
import com.sinch.sdk.domains.verification.models.v1.VerificationStatusReason;

/** declaration */
/** VerificationReportResponseFlashCall */
@JsonDeserialize(builder = VerificationReportResponseFlashCallImpl.Builder.class)
public interface VerificationReportResponseFlashCall
extends com.sinch.sdk.domains.verification.models.v1.report.response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import com.sinch.sdk.domains.verification.models.v1.VerificationStatus;
import com.sinch.sdk.domains.verification.models.v1.VerificationStatusReason;

/** declaration */
/** VerificationReportResponsePhoneCall */
@JsonDeserialize(builder = VerificationReportResponsePhoneCallImpl.Builder.class)
public interface VerificationReportResponsePhoneCall
extends com.sinch.sdk.domains.verification.models.v1.report.response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import com.sinch.sdk.domains.verification.models.v1.VerificationStatus;
import com.sinch.sdk.domains.verification.models.v1.VerificationStatusReason;

/** declaration */
/** VerificationReportResponseSms */
@JsonDeserialize(builder = VerificationReportResponseSmsImpl.Builder.class)
public interface VerificationReportResponseSms
extends com.sinch.sdk.domains.verification.models.v1.report.response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import com.sinch.sdk.domains.verification.models.v1.Identity;

/** declaration */
/** VerificationStartRequest */
public interface VerificationStartRequest {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sinch.sdk.domains.verification.models.v1.Identity;

/** declaration */
/** VerificationStartRequestData */
@JsonDeserialize(builder = VerificationStartRequestDataImpl.Builder.class)
public interface VerificationStartRequestData
extends com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sinch.sdk.domains.verification.models.v1.Identity;

/** declaration */
/** VerificationStartRequestFlashCall */
@JsonDeserialize(builder = VerificationStartRequestFlashCallImpl.Builder.class)
public interface VerificationStartRequestFlashCall
extends com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sinch.sdk.domains.verification.models.v1.Identity;

/** declaration */
/** VerificationStartRequestPhoneCall */
@JsonDeserialize(builder = VerificationStartRequestPhoneCallImpl.Builder.class)
public interface VerificationStartRequestPhoneCall
extends com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** VerificationStartRequestSms */
@JsonDeserialize(builder = VerificationStartRequestSmsImpl.Builder.class)
public interface VerificationStartRequestSms
extends com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequest {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import java.util.List;

/** declaration */
/** VerificationStartResponse */
public interface VerificationStartResponse {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.util.List;

/** declaration */
/** Data Response */
@JsonDeserialize(builder = VerificationStartResponseDataImpl.Builder.class)
public interface VerificationStartResponseData
extends com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.util.List;

/** declaration */
/** Flash Call Response */
@JsonDeserialize(builder = VerificationStartResponseFlashCallImpl.Builder.class)
public interface VerificationStartResponseFlashCall
extends com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.util.List;

/** declaration */
/** Phone Call Response */
@JsonDeserialize(builder = VerificationStartResponsePhoneCallImpl.Builder.class)
public interface VerificationStartResponsePhoneCall
extends com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.util.List;

/** declaration */
/** SMS Response */
@JsonDeserialize(builder = VerificationStartResponseSmsImpl.Builder.class)
public interface VerificationStartResponseSms
extends com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,22 @@
/** The type of the call result. */
public class StatusCallResult extends EnumDynamic<String, StatusCallResult> {

/** Call answered */
public static final StatusCallResult ANSWERED = new StatusCallResult("ANSWERED");

/** Call canceled */
public static final StatusCallResult CANCEL = new StatusCallResult("CANCEL");

/** Call completed */
public static final StatusCallResult COMPLETED = new StatusCallResult("COMPLETED");

/** No answer to call */
public static final StatusCallResult NO_ANSWER = new StatusCallResult("NO_ANSWER");

/** Busy Call */
public static final StatusCallResult BUSY = new StatusCallResult("BUSY");

/** Call failed */
public static final StatusCallResult FAILED = new StatusCallResult("FAILED");

private static final EnumSupportDynamic<String, StatusCallResult> ENUM_SUPPORT =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@
*/
public class StatusSource extends EnumDynamic<String, StatusSource> {

/** PIN verification was performed automatically */
public static final StatusSource INTERCEPTED = new StatusSource("intercepted");

/** PIN verification was manually performed */
public static final StatusSource MANUAL = new StatusSource("manual");

private static final EnumSupportDynamic<String, StatusSource> ENUM_SUPPORT =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import com.sinch.sdk.domains.verification.models.v1.VerificationStatusReason;
import java.time.Instant;

/** declaration */
/** Verification Status Response Common Fields */
public interface VerificationStatusResponse {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** Flash Call Verification Status Response */
@JsonDeserialize(builder = VerificationStatusResponseFlashCallImpl.Builder.class)
public interface VerificationStatusResponseFlashCall
extends com.sinch.sdk.domains.verification.models.v1.status.response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** Phone Call Verification Status Response */
@JsonDeserialize(builder = VerificationStatusResponsePhoneCallImpl.Builder.class)
public interface VerificationStatusResponsePhoneCall
extends com.sinch.sdk.domains.verification.models.v1.status.response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** SMS Verification Status Response */
@JsonDeserialize(builder = VerificationStatusResponseSmsImpl.Builder.class)
public interface VerificationStatusResponseSms
extends com.sinch.sdk.domains.verification.models.v1.status.response
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import com.sinch.sdk.domains.verification.models.v1.Identity;

/** declaration */
/** VerificationEvent */
public interface VerificationEvent {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@
public class VerificationEventResponseAction
extends EnumDynamic<String, VerificationEventResponseAction> {

/** Verification allowed */
public static final VerificationEventResponseAction ALLOW =
new VerificationEventResponseAction("allow");

/** Verification denied */
public static final VerificationEventResponseAction DENY =
new VerificationEventResponseAction("deny");

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import java.util.List;
import java.util.stream.Stream;

/** declaration */
/** VerificationRequestEvent */
@JsonDeserialize(builder = VerificationRequestEventImpl.Builder.class)
public interface VerificationRequestEvent
extends com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationEvent {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

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

/** declaration */
/** VerificationRequestEventResponse */
public interface VerificationRequestEventResponse {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/** declaration */
/** Flash Call Request Event Response */
@JsonDeserialize(builder = VerificationRequestEventResponseFlashCallImpl.Builder.class)
public interface VerificationRequestEventResponseFlashCall
extends com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sinch.sdk.domains.verification.models.v1.start.request.PhoneCallSpeech;

/** declaration */
/** Phone Call Request Event Response */
@JsonDeserialize(builder = VerificationRequestEventResponsePhoneCallImpl.Builder.class)
public interface VerificationRequestEventResponsePhoneCall
extends com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.util.List;

/** declaration */
/** SMS Request Event Response */
@JsonDeserialize(builder = VerificationRequestEventResponseSmsImpl.Builder.class)
public interface VerificationRequestEventResponseSms
extends com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationRequestEventResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import java.util.Arrays;
import java.util.stream.Stream;

/** declaration */
/** VerificationResultEvent */
@JsonDeserialize(builder = VerificationResultEventImpl.Builder.class)
public interface VerificationResultEvent
extends com.sinch.sdk.domains.verification.models.v1.webhooks.VerificationEvent {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/** declaration */
/** VerificationRequestEventResponseFlashCallContent */
@JsonDeserialize(builder = VerificationRequestEventResponseFlashCallContentImpl.Builder.class)
public interface VerificationRequestEventResponseFlashCallContent {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sinch.sdk.domains.verification.models.v1.start.request.PhoneCallSpeech;

/** declaration */
/** VerificationRequestEventResponsePhoneCallContent */
@JsonDeserialize(builder = VerificationRequestEventResponsePhoneCallContentImpl.Builder.class)
public interface VerificationRequestEventResponsePhoneCallContent {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.util.List;

/** declaration */
/** VerificationRequestEventResponseSmsContent */
@JsonDeserialize(builder = VerificationRequestEventResponseSmsContentImpl.Builder.class)
public interface VerificationRequestEventResponseSmsContent {

Expand Down

0 comments on commit 69d4d2f

Please sign in to comment.