add note about TelegramPaymentChargeId

CHANGELOG.md

@@ -1,6 +1,9 @@
 # TelegramBotAPI changelog
 
-## 13.1.0
+## 14.0.0
+
+* `Core`:
+    * `TelegramPaymentChargeId` has been added as value class and replaced raw strings in `SuccessfulPayment` type of `telegramPaymentChargeId`
 
 ## 13.0.0
 

gradle.properties

@@ -6,4 +6,4 @@ kotlin.incremental=true
 kotlin.incremental.js=true
 
 library_group=dev.inmo
-library_version=13.1.0
+library_version=14.0.0

tgbotapi.api/src/commonMain/kotlin/dev/inmo/tgbotapi/extensions/api/send/payments/RefundStarPayment.kt

@@ -0,0 +1,17 @@
+package dev.inmo.tgbotapi.extensions.api.send.payments
+
+import dev.inmo.tgbotapi.bot.TelegramBot
+import dev.inmo.tgbotapi.requests.send.payments.RefundStarPayment
+import dev.inmo.tgbotapi.types.UserId
+import dev.inmo.tgbotapi.types.payments.SuccessfulPayment
+import dev.inmo.tgbotapi.types.payments.abstracts.TelegramPaymentChargeId
+
+suspend fun TelegramBot.refundStarPayment(
+    userId: UserId,
+    telegramPaymentChargeId: TelegramPaymentChargeId
+) = execute(RefundStarPayment(userId, telegramPaymentChargeId))
+
+suspend fun TelegramBot.refundStarPayment(
+    userId: UserId,
+    successfulPayment: SuccessfulPayment
+) = refundStarPayment(userId, successfulPayment.telegramPaymentChargeId)

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/requests/send/payments/RefundStarPayment.kt

@@ -0,0 +1,21 @@
+package dev.inmo.tgbotapi.requests.send.payments
+
+import dev.inmo.tgbotapi.requests.abstracts.SimpleRequest
+import dev.inmo.tgbotapi.types.*
+import dev.inmo.tgbotapi.types.payments.abstracts.TelegramPaymentChargeId
+import kotlinx.serialization.*
+import kotlinx.serialization.builtins.serializer
+
+@Serializable
+data class RefundStarPayment(
+    @SerialName(userIdField)
+    val userId: UserId,
+    @SerialName(telegramPaymentChargeIdField)
+    val telegramPaymentChargeId: TelegramPaymentChargeId
+) : SimpleRequest<Boolean> {
+    override fun method(): String = "refundStarPayment"
+    override val resultDeserializer: DeserializationStrategy<Boolean>
+        get() = Boolean.serializer()
+    override val requestSerializer: SerializationStrategy<*>
+        get() = serializer()
+}

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/payments/SuccessfulPayment.kt

@@ -14,7 +14,7 @@ data class SuccessfulPayment(
     @SerialName(invoicePayloadField)
     val invoicePayload: String,
     @SerialName(telegramPaymentChargeIdField)
-    val telegramPaymentChargeId: String,
+    val telegramPaymentChargeId: TelegramPaymentChargeId,
     @SerialName(providerPaymentChargeIdField)
     val providerPaymentChargeId: String,
     @SerialName(shippingOptionIdField)

tgbotapi.core/src/commonMain/kotlin/dev/inmo/tgbotapi/types/payments/abstracts/TelegramPaymentChargeId.kt

@@ -0,0 +1,10 @@
+package dev.inmo.tgbotapi.types.payments.abstracts
+
+import kotlinx.serialization.Serializable
+import kotlin.jvm.JvmInline
+
+@Serializable
+@JvmInline
+value class TelegramPaymentChargeId(
+    val string: String
+)