Add deprecated annotations to the SiteApiKey

MOB-5015

Author: Andrii-Horishnii-Glia

widgetssdk/src/main/java/com/glia/widgets/AuthorizationMethod.kt

@@ -24,7 +24,16 @@ sealed interface AuthorizationMethod {
      * @param secret The site API key secret
      *
      * @see GliaWidgetsConfig
+     *
+     * @deprecated Will be removed in version 4.0.0.
      */
+    @Deprecated(
+        "Use AuthorizationMethod.UserApiKey from com.glia.widgets package",
+        ReplaceWith(
+            "AuthorizationMethod.UserApiKey(id, secret)",
+            "com.glia.widgets.AuthorizationMethod"
+        )
+    )
     open class SiteApiKey(val id: String, val secret: String) : AuthorizationMethod
 }
 

widgetssdk/src/main/java/com/glia/widgets/GliaWidgetsConfig.kt

@@ -161,7 +161,7 @@ class GliaWidgetsConfig private constructor(builder: Builder) {
          * @param region Region in which the site is created.
          * One of [Regions].
          * @return Builder instance
-         * @deprecated Will be removed in 4.0.0 version.
+         * @deprecated Will be removed in version 4.0.0.
          */
         @Deprecated("Use {@link #setRegion(Region)}")
         fun setRegion(region: String): Builder {
@@ -173,30 +173,58 @@ class GliaWidgetsConfig private constructor(builder: Builder) {
          * @hidden
          * @param baseDomain Base domain to be used.
          * @return Builder instance
-         * @deprecated Will be removed in 4.0.0 version.
+         * @deprecated Will be removed in version 4.0.0.
          */
         @Deprecated("Use {@link #setRegion(Region)}")
         fun setBaseDomain(baseDomain: String): Builder {
             this.baseDomain = baseDomain
             return this
         }
 
+        /**
+         * @param siteApiKey - your site API key
+         * @return Builder instance
+         * @deprecated Will be removed in version 4.0.0.
+         */
         @Deprecated(
-            "Use {@link #setSiteApiKey(SiteApiKey)}",
+            "Use {@link #setAuthorizationMethod(AuthorizationMethod.UserApiKey)}",
             ReplaceWith(
-                "setSiteApiKey(SiteApiKey(id, secret))",
-                "com.glia.widgets.SiteApiKey"
+                "setAuthorizationMethod(AuthorizationMethod.UserApiKey(id, secret))",
+                "com.glia.widgets.AuthorizationMethod"
             )
         )
         fun setSiteApiKey(siteApiKey: com.glia.androidsdk.SiteApiKey): Builder {
             return setSiteApiKey(siteApiKey.toWidgetType())
         }
 
+        /**
+         * @param siteApiKey - your site API key
+         * @return Builder instance
+         * @deprecated Will be removed in version 4.0.0.
+         */
+        @Deprecated(
+            "Use {@link #setAuthorizationMethod(AuthorizationMethod.UserApiKey)}",
+            ReplaceWith(
+                "setAuthorizationMethod(AuthorizationMethod.UserApiKey(id, secret))",
+                "com.glia.widgets.AuthorizationMethod"
+            )
+        )
         fun setSiteApiKey(siteApiKey: AuthorizationMethod.SiteApiKey): Builder {
             this.authorizationMethod = siteApiKey
             return this
         }
 
+        /**
+         * @param authorizationMethod - your API key
+         * @return Builder instance
+         *
+         * Example:
+         * ```
+         * .setAuthorizationMethod(
+         *     AuthorizationMethod.UserApiKey("API_KEY_ID", "API_KEY_SECRET")
+         * )
+         * ```
+         */
         fun setAuthorizationMethod(authorizationMethod: AuthorizationMethod): Builder {
             this.authorizationMethod = authorizationMethod
             return this

widgetssdk/src/main/java/com/glia/widgets/SiteApiKey.kt

@@ -7,5 +7,14 @@ package com.glia.widgets
  * @param secret The site API Key secret
  *
  * @see GliaWidgetsConfig
+ *
+ * @deprecated Will be removed in version 4.0.0.
  */
+@Deprecated(
+    "Use AuthorizationMethod.SiteApiKey from com.glia.widgets package",
+    ReplaceWith(
+        "AuthorizationMethod.SiteApiKey(id, secret)",
+        "com.glia.widgets.AuthorizationMethod"
+    )
+)
 class SiteApiKey(id: String, secret: String): AuthorizationMethod.SiteApiKey(id, secret)