diff --git a/core-api-library/library/src/main/java/net/gini/android/core/api/DocumentManager.kt b/core-api-library/library/src/main/java/net/gini/android/core/api/DocumentManager.kt index c4c5baaa20..1e642da50e 100644 --- a/core-api-library/library/src/main/java/net/gini/android/core/api/DocumentManager.kt +++ b/core-api-library/library/src/main/java/net/gini/android/core/api/DocumentManager.kt @@ -9,7 +9,7 @@ import net.gini.android.core.api.models.SpecificExtraction import org.json.JSONObject /** - * The [DocumentManager] is a high level API on top of the Gini API, which is used via the [DocumentRepository]. It + * The [DocumentManager] is a high level API on top of the Gini API, via which the [DocumentRepository] is used. It * provides high level methods to handle document related tasks easily. */ abstract class DocumentManager, E: ExtractionsContainer>(private val documentRepository: DR) { diff --git a/core-api-library/library/src/main/java/net/gini/android/core/api/MediaTypes.java b/core-api-library/library/src/main/java/net/gini/android/core/api/MediaTypes.java index fc39563e79..c19f0ecf82 100644 --- a/core-api-library/library/src/main/java/net/gini/android/core/api/MediaTypes.java +++ b/core-api-library/library/src/main/java/net/gini/android/core/api/MediaTypes.java @@ -1,9 +1,11 @@ package net.gini.android.core.api; - import androidx.annotation.NonNull; import androidx.annotation.Nullable; +/** + * Media Types used across the application (e.g document types, http headers) + */ public class MediaTypes { public static final String IMAGE_JPEG = "image/jpeg"; diff --git a/core-api-library/library/src/main/java/net/gini/android/core/api/Resource.kt b/core-api-library/library/src/main/java/net/gini/android/core/api/Resource.kt index af35b376d4..b97ea15e89 100644 --- a/core-api-library/library/src/main/java/net/gini/android/core/api/Resource.kt +++ b/core-api-library/library/src/main/java/net/gini/android/core/api/Resource.kt @@ -4,7 +4,7 @@ import net.gini.android.core.api.requests.ApiException import java.util.concurrent.CancellationException /** - * Represents a requested API resource. Resources can be requested successfully, with an error or they can be cancelled. + * Represents a requested API resource. Resource requests can be returned successfully, with an error or they can be cancelled. */ sealed class Resource( open val data: T? = null, diff --git a/core-api-library/library/src/main/java/net/gini/android/core/api/internal/GiniCoreAPIBuilder.kt b/core-api-library/library/src/main/java/net/gini/android/core/api/internal/GiniCoreAPIBuilder.kt index 79f2bc8935..97453da585 100644 --- a/core-api-library/library/src/main/java/net/gini/android/core/api/internal/GiniCoreAPIBuilder.kt +++ b/core-api-library/library/src/main/java/net/gini/android/core/api/internal/GiniCoreAPIBuilder.kt @@ -36,6 +36,16 @@ import javax.net.ssl.SSLContext import javax.net.ssl.SSLSocketFactory import javax.net.ssl.TrustManager +/** + * The [GiniCoreAPIBuilder] allows you to build and configure a [GiniCoreAPI] instance. + * + * @constructor Initializes a new builder instance. + * @param context your application's Context instance (Android) + * @param clientId your application's client ID for the Gini Health API + * @param clientSecret your application's client secret for the Gini Health API + * @param emailDomain the email domain which is used for created Gini users + * @param sessionManager if not null, then the [SessionManager] instance will be used for session management. If null, then anonymous Gini users will be used. + */ abstract class GiniCoreAPIBuilder, G : GiniCoreAPI, DR : DocumentRepository, E : ExtractionsContainer>( private val context: Context, private val clientId: String, @@ -107,6 +117,9 @@ abstract class GiniCoreAPIBuilder, G : GiniCoreAPI { + + /** + * Request completed successfully and extractions were returned. + */ class Success(val value: T) : ResultWrapper() + + /** + * Request was unable to complete - returns the cause of the error + */ class Error(val error: Throwable) : ResultWrapper() + + /** + * Request did not complete yet. + */ class Loading : ResultWrapper() } diff --git a/health-sdk/sdk/src/main/java/net/gini/android/health/sdk/review/model/PaymentDetails.kt b/health-sdk/sdk/src/main/java/net/gini/android/health/sdk/review/model/PaymentDetails.kt index be71d00bff..8fc86a391d 100644 --- a/health-sdk/sdk/src/main/java/net/gini/android/health/sdk/review/model/PaymentDetails.kt +++ b/health-sdk/sdk/src/main/java/net/gini/android/health/sdk/review/model/PaymentDetails.kt @@ -8,6 +8,9 @@ import net.gini.android.core.api.models.SpecificExtraction import net.gini.android.health.sdk.review.error.NoPaymentDataExtracted import net.gini.android.health.sdk.util.toBackendFormat +/** + * Represents the payment details of an invoice as extracted from a document. + */ @Parcelize data class PaymentDetails( val recipient: String, @@ -44,7 +47,7 @@ internal fun String.toAmount(): String { /** * Checks if the document is payable which looks for iban extraction. */ -val PaymentDetails.isPayable get() = iban.isNotEmpty() +val PaymentDetails.isPayable get() = iban.isNotEmpty() // It appears this is not used anymore - we could remove it at a later stage (would remove it from the documentation as well) internal fun MutableMap.withFeedback(paymentDetails: PaymentDetails): Map { this["payment"] = this["payment"].let { payment ->