From abaa6457e13c6de90ae7dfacbf2ce603d3679987 Mon Sep 17 00:00:00 2001 From: andreykropotov Date: Wed, 14 Oct 2026 17:35:20 +0400 Subject: [PATCH] feat(subscriptions): manage subscriptions for every channel --- .../Rees46FlutterSdkPlugin.kt | 47 ++++ .../pigeon/PersonalizationApi.g.kt | 147 ++++++++++++- example/ios/Podfile.lock | 8 +- ios/Classes/Rees46FlutterSdkPlugin.swift | 44 ++++ ios/Classes/pigeon/PersonalizationApi.g.swift | 162 +++++++++++++- ios/rees46_sdk.podspec | 2 +- lib/rees46_sdk.dart | 1 + lib/src/personalization_sdk.dart | 7 + lib/src/pigeon/personalization_api.g.dart | 207 +++++++++++++++++- .../manage_subscription_params.dart | 98 +++++++++ pigeons/personalization_api.dart | 65 ++++++ test/manage_subscription_test.dart | 126 +++++++++++ 12 files changed, 900 insertions(+), 14 deletions(-) create mode 100644 lib/src/subscriptions/manage_subscription_params.dart create mode 100644 test/manage_subscription_test.dart diff --git a/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/Rees46FlutterSdkPlugin.kt b/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/Rees46FlutterSdkPlugin.kt index cdc81fb..acd45ca 100644 --- a/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/Rees46FlutterSdkPlugin.kt +++ b/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/Rees46FlutterSdkPlugin.kt @@ -6,6 +6,7 @@ import android.os.Bundle import android.os.SystemClock import com.rees46.rees46_flutter_sdk.pigeon.FlutterError import com.rees46.rees46_flutter_sdk.pigeon.InitConfig +import com.rees46.rees46_flutter_sdk.pigeon.ManageSubscriptionParamsWire import com.rees46.rees46_flutter_sdk.pigeon.PersonalizationFlutterApi import com.rees46.rees46_flutter_sdk.pigeon.PersonalizationHostApi import com.rees46.rees46_flutter_sdk.pigeon.ProfileParamsWire @@ -517,6 +518,52 @@ class Rees46FlutterSdkPlugin : } } + override fun manageSubscription(params: ManageSubscriptionParamsWire, shopId: String?, callback: (Result) -> Unit) { + try { + val subscriptions = HashMap() + params.emailBulk?.let { subscriptions["email_bulk"] = it } + params.emailChain?.let { subscriptions["email_chain"] = it } + params.emailTransactional?.let { subscriptions["email_transactional"] = it } + params.smsBulk?.let { subscriptions["sms_bulk"] = it } + params.smsChain?.let { subscriptions["sms_chain"] = it } + params.smsTransactional?.let { subscriptions["sms_transactional"] = it } + params.webPushBulk?.let { subscriptions["web_push_bulk"] = it } + params.webPushChain?.let { subscriptions["web_push_chain"] = it } + params.webPushTransactional?.let { subscriptions["web_push_transactional"] = it } + params.mobilePushBulk?.let { subscriptions["mobile_push_bulk"] = it } + params.mobilePushChain?.let { subscriptions["mobile_push_chain"] = it } + params.mobilePushTransactional?.let { subscriptions["mobile_push_transactional"] = it } + params.telegramBulk?.let { subscriptions["telegram_bulk"] = it } + params.telegramChain?.let { subscriptions["telegram_chain"] = it } + params.telegramTransactional?.let { subscriptions["telegram_transactional"] = it } + params.whatsappBulk?.let { subscriptions["whatsapp_bulk"] = it } + params.whatsappChain?.let { subscriptions["whatsapp_chain"] = it } + params.whatsappTransactional?.let { subscriptions["whatsapp_transactional"] = it } + params.maxBulk?.let { subscriptions["max_bulk"] = it } + params.maxChain?.let { subscriptions["max_chain"] = it } + params.maxTransactional?.let { subscriptions["max_transactional"] = it } + params.walletBulk?.let { subscriptions["wallet_bulk"] = it } + sdk(shopId).manageSubscription( + params.email, + params.phone, + params.externalId, + params.loyaltyId, + params.telegramId, + subscriptions, + object : OnApiCallbackListener() { + override fun onSuccess(response: JSONObject?) { + callback(Result.success(Unit)) + } + override fun onError(code: Int, msg: String?) { + callback(Result.failure(FlutterError("manage_subscription_failed", msg ?: "error $code", null))) + } + } + ) + } catch (t: Throwable) { + callback(Result.failure(FlutterError("manage_subscription_failed", t.message, null))) + } + } + // region tracking namespace // // Each method hands straight to the native `tracking` namespace of the resolved instance; diff --git a/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/pigeon/PersonalizationApi.g.kt b/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/pigeon/PersonalizationApi.g.kt index 3721566..9456937 100644 --- a/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/pigeon/PersonalizationApi.g.kt +++ b/android/src/main/kotlin/com/rees46/rees46_flutter_sdk/pigeon/PersonalizationApi.g.kt @@ -270,6 +270,117 @@ data class ProfileParamsWire ( override fun hashCode(): Int = toList().hashCode() } +/** + * Wire format for `subscriptions/manage`: contacts that identify the client and one flag per + * channel and mailing type. `true` subscribes, `false` unsubscribes, `null` leaves it unchanged. + * + * Generated class from Pigeon that represents data sent in messages. + */ +data class ManageSubscriptionParamsWire ( + val email: String? = null, + val phone: String? = null, + val externalId: String? = null, + val loyaltyId: String? = null, + val telegramId: String? = null, + val emailBulk: Boolean? = null, + val emailChain: Boolean? = null, + val emailTransactional: Boolean? = null, + val smsBulk: Boolean? = null, + val smsChain: Boolean? = null, + val smsTransactional: Boolean? = null, + val webPushBulk: Boolean? = null, + val webPushChain: Boolean? = null, + val webPushTransactional: Boolean? = null, + val mobilePushBulk: Boolean? = null, + val mobilePushChain: Boolean? = null, + val mobilePushTransactional: Boolean? = null, + val telegramBulk: Boolean? = null, + val telegramChain: Boolean? = null, + val telegramTransactional: Boolean? = null, + val whatsappBulk: Boolean? = null, + val whatsappChain: Boolean? = null, + val whatsappTransactional: Boolean? = null, + val maxBulk: Boolean? = null, + val maxChain: Boolean? = null, + val maxTransactional: Boolean? = null, + val walletBulk: Boolean? = null +) + { + companion object { + fun fromList(pigeonVar_list: List): ManageSubscriptionParamsWire { + val email = pigeonVar_list[0] as String? + val phone = pigeonVar_list[1] as String? + val externalId = pigeonVar_list[2] as String? + val loyaltyId = pigeonVar_list[3] as String? + val telegramId = pigeonVar_list[4] as String? + val emailBulk = pigeonVar_list[5] as Boolean? + val emailChain = pigeonVar_list[6] as Boolean? + val emailTransactional = pigeonVar_list[7] as Boolean? + val smsBulk = pigeonVar_list[8] as Boolean? + val smsChain = pigeonVar_list[9] as Boolean? + val smsTransactional = pigeonVar_list[10] as Boolean? + val webPushBulk = pigeonVar_list[11] as Boolean? + val webPushChain = pigeonVar_list[12] as Boolean? + val webPushTransactional = pigeonVar_list[13] as Boolean? + val mobilePushBulk = pigeonVar_list[14] as Boolean? + val mobilePushChain = pigeonVar_list[15] as Boolean? + val mobilePushTransactional = pigeonVar_list[16] as Boolean? + val telegramBulk = pigeonVar_list[17] as Boolean? + val telegramChain = pigeonVar_list[18] as Boolean? + val telegramTransactional = pigeonVar_list[19] as Boolean? + val whatsappBulk = pigeonVar_list[20] as Boolean? + val whatsappChain = pigeonVar_list[21] as Boolean? + val whatsappTransactional = pigeonVar_list[22] as Boolean? + val maxBulk = pigeonVar_list[23] as Boolean? + val maxChain = pigeonVar_list[24] as Boolean? + val maxTransactional = pigeonVar_list[25] as Boolean? + val walletBulk = pigeonVar_list[26] as Boolean? + return ManageSubscriptionParamsWire(email, phone, externalId, loyaltyId, telegramId, emailBulk, emailChain, emailTransactional, smsBulk, smsChain, smsTransactional, webPushBulk, webPushChain, webPushTransactional, mobilePushBulk, mobilePushChain, mobilePushTransactional, telegramBulk, telegramChain, telegramTransactional, whatsappBulk, whatsappChain, whatsappTransactional, maxBulk, maxChain, maxTransactional, walletBulk) + } + } + fun toList(): List { + return listOf( + email, + phone, + externalId, + loyaltyId, + telegramId, + emailBulk, + emailChain, + emailTransactional, + smsBulk, + smsChain, + smsTransactional, + webPushBulk, + webPushChain, + webPushTransactional, + mobilePushBulk, + mobilePushChain, + mobilePushTransactional, + telegramBulk, + telegramChain, + telegramTransactional, + whatsappBulk, + whatsappChain, + whatsappTransactional, + maxBulk, + maxChain, + maxTransactional, + walletBulk, + ) + } + override fun equals(other: Any?): Boolean { + if (other !is ManageSubscriptionParamsWire) { + return false + } + if (this === other) { + return true + } + return PersonalizationApiPigeonUtils.deepEquals(toList(), other.toList()) } + + override fun hashCode(): Int = toList().hashCode() +} + /** * Wire format for one product line in a tracking event (maps to native `TrackingItem`). * @@ -371,10 +482,15 @@ private open class PersonalizationApiPigeonCodec : StandardMessageCodec() { } 132.toByte() -> { return (readValue(buffer) as? List)?.let { - TrackingItemWire.fromList(it) + ManageSubscriptionParamsWire.fromList(it) } } 133.toByte() -> { + return (readValue(buffer) as? List)?.let { + TrackingItemWire.fromList(it) + } + } + 134.toByte() -> { return (readValue(buffer) as? List)?.let { TrackingSourceWire.fromList(it) } @@ -396,14 +512,18 @@ private open class PersonalizationApiPigeonCodec : StandardMessageCodec() { stream.write(131) writeValue(stream, value.toList()) } - is TrackingItemWire -> { + is ManageSubscriptionParamsWire -> { stream.write(132) writeValue(stream, value.toList()) } - is TrackingSourceWire -> { + is TrackingItemWire -> { stream.write(133) writeValue(stream, value.toList()) } + is TrackingSourceWire -> { + stream.write(134) + writeValue(stream, value.toList()) + } else -> super.writeValue(stream, value) } } @@ -419,6 +539,7 @@ interface PersonalizationHostApi { /** [customFieldsJson] is JSON object string or null (maps to native custom fields map). */ fun trackEvent(event: String, time: Long?, category: String?, label: String?, value: Long?, customFieldsJson: String?, shopId: String?, callback: (Result) -> Unit) fun setProfile(params: ProfileParamsWire, shopId: String?, callback: (Result) -> Unit) + fun manageSubscription(params: ManageSubscriptionParamsWire, shopId: String?, callback: (Result) -> Unit) /** * Returns the recommendation block as a JSON string. * [paramsJson] is a JSON object string with optional filter parameters. @@ -621,6 +742,26 @@ interface PersonalizationHostApi { channel.setMessageHandler(null) } } + run { + val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationHostApi.manageSubscription$separatedMessageChannelSuffix", codec) + if (api != null) { + channel.setMessageHandler { message, reply -> + val args = message as List + val paramsArg = args[0] as ManageSubscriptionParamsWire + val shopIdArg = args[1] as String? + api.manageSubscription(paramsArg, shopIdArg) { result: Result -> + val error = result.exceptionOrNull() + if (error != null) { + reply.reply(PersonalizationApiPigeonUtils.wrapError(error)) + } else { + reply.reply(PersonalizationApiPigeonUtils.wrapResult(null)) + } + } + } + } else { + channel.setMessageHandler(null) + } + } run { val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationHostApi.getRecommendation$separatedMessageChannelSuffix", codec) if (api != null) { diff --git a/example/ios/Podfile.lock b/example/ios/Podfile.lock index 9db4988..c348614 100644 --- a/example/ios/Podfile.lock +++ b/example/ios/Podfile.lock @@ -7,10 +7,10 @@ PODS: - CocoaAsyncSocket (~> 7.6) - Flutter - FlutterMacOS - - REES46 (3.33.0) + - REES46 (3.35.0) - rees46_sdk (0.0.1): - Flutter - - REES46 (= 3.33.0) + - REES46 (= 3.35.0) DEPENDENCIES: - Flutter (from `Flutter`) @@ -38,8 +38,8 @@ SPEC CHECKSUMS: Flutter: cabc95a1d2626b1b06e7179b784ebcf0c0cde467 integration_test: 4a889634ef21a45d28d50d622cf412dc6d9f586e patrol: cea8074f183a2a4232d0ebd10569ae05149ada42 - REES46: 92331668908a711e67515f368a9b00ed775fcffc - rees46_sdk: 8ad2e581dcb34d936af65c5c7af8c9c4c84f5255 + REES46: a96357df1dbbef9a73d92961069290702334136d + rees46_sdk: 312ba7a8088eb9cd0f5476ae3d6dd9b45c46b8c4 PODFILE CHECKSUM: b6e248ac4c1eff5807c8b044b39b8bc326af3f5f diff --git a/ios/Classes/Rees46FlutterSdkPlugin.swift b/ios/Classes/Rees46FlutterSdkPlugin.swift index 53523e7..31f30fa 100644 --- a/ios/Classes/Rees46FlutterSdkPlugin.swift +++ b/ios/Classes/Rees46FlutterSdkPlugin.swift @@ -844,6 +844,50 @@ final class PersonalizationHostApiImpl: PersonalizationHostApi { } } + func manageSubscription(params: ManageSubscriptionParamsWire, shopId: String?, completion: @escaping (Result) -> Void) { + guard let sdk = sdk(shopId) else { + completion(.failure(PigeonError(code: "not_initialized", message: "SDK is not initialized", details: nil))) + return + } + sdk.manageSubscription( + email: params.email, + phone: params.phone, + userExternalId: params.externalId, + userLoyaltyId: params.loyaltyId, + telegramId: params.telegramId, + emailBulk: params.emailBulk, + emailChain: params.emailChain, + emailTransactional: params.emailTransactional, + smsBulk: params.smsBulk, + smsChain: params.smsChain, + smsTransactional: params.smsTransactional, + webPushBulk: params.webPushBulk, + webPushChain: params.webPushChain, + webPushTransactional: params.webPushTransactional, + mobilePushBulk: params.mobilePushBulk, + mobilePushChain: params.mobilePushChain, + mobilePushTransactional: params.mobilePushTransactional, + telegramBulk: params.telegramBulk, + telegramChain: params.telegramChain, + telegramTransactional: params.telegramTransactional, + whatsappBulk: params.whatsappBulk, + whatsappChain: params.whatsappChain, + whatsappTransactional: params.whatsappTransactional, + maxBulk: params.maxBulk, + maxChain: params.maxChain, + maxTransactional: params.maxTransactional, + walletBulk: params.walletBulk, + completion: { result in + switch result { + case .success: + completion(.success(())) + case .failure(let err): + completion(.failure(PigeonError(code: "manage_subscription_failed", message: String(describing: err), details: nil))) + } + } + ) + } + // MARK: - Tracking namespace // // Each method hands straight to the native `tracking` namespace of the resolved instance; diff --git a/ios/Classes/pigeon/PersonalizationApi.g.swift b/ios/Classes/pigeon/PersonalizationApi.g.swift index 59a99a8..132a49b 100644 --- a/ios/Classes/pigeon/PersonalizationApi.g.swift +++ b/ios/Classes/pigeon/PersonalizationApi.g.swift @@ -338,6 +338,138 @@ struct ProfileParamsWire: Hashable { } } +/// Wire format for `subscriptions/manage`: contacts that identify the client and one flag per +/// channel and mailing type. `true` subscribes, `false` unsubscribes, `null` leaves it unchanged. +/// +/// Generated class from Pigeon that represents data sent in messages. +struct ManageSubscriptionParamsWire: Hashable { + var email: String? = nil + var phone: String? = nil + var externalId: String? = nil + var loyaltyId: String? = nil + var telegramId: String? = nil + var emailBulk: Bool? = nil + var emailChain: Bool? = nil + var emailTransactional: Bool? = nil + var smsBulk: Bool? = nil + var smsChain: Bool? = nil + var smsTransactional: Bool? = nil + var webPushBulk: Bool? = nil + var webPushChain: Bool? = nil + var webPushTransactional: Bool? = nil + var mobilePushBulk: Bool? = nil + var mobilePushChain: Bool? = nil + var mobilePushTransactional: Bool? = nil + var telegramBulk: Bool? = nil + var telegramChain: Bool? = nil + var telegramTransactional: Bool? = nil + var whatsappBulk: Bool? = nil + var whatsappChain: Bool? = nil + var whatsappTransactional: Bool? = nil + var maxBulk: Bool? = nil + var maxChain: Bool? = nil + var maxTransactional: Bool? = nil + var walletBulk: Bool? = nil + + + // swift-format-ignore: AlwaysUseLowerCamelCase + static func fromList(_ pigeonVar_list: [Any?]) -> ManageSubscriptionParamsWire? { + let email: String? = nilOrValue(pigeonVar_list[0]) + let phone: String? = nilOrValue(pigeonVar_list[1]) + let externalId: String? = nilOrValue(pigeonVar_list[2]) + let loyaltyId: String? = nilOrValue(pigeonVar_list[3]) + let telegramId: String? = nilOrValue(pigeonVar_list[4]) + let emailBulk: Bool? = nilOrValue(pigeonVar_list[5]) + let emailChain: Bool? = nilOrValue(pigeonVar_list[6]) + let emailTransactional: Bool? = nilOrValue(pigeonVar_list[7]) + let smsBulk: Bool? = nilOrValue(pigeonVar_list[8]) + let smsChain: Bool? = nilOrValue(pigeonVar_list[9]) + let smsTransactional: Bool? = nilOrValue(pigeonVar_list[10]) + let webPushBulk: Bool? = nilOrValue(pigeonVar_list[11]) + let webPushChain: Bool? = nilOrValue(pigeonVar_list[12]) + let webPushTransactional: Bool? = nilOrValue(pigeonVar_list[13]) + let mobilePushBulk: Bool? = nilOrValue(pigeonVar_list[14]) + let mobilePushChain: Bool? = nilOrValue(pigeonVar_list[15]) + let mobilePushTransactional: Bool? = nilOrValue(pigeonVar_list[16]) + let telegramBulk: Bool? = nilOrValue(pigeonVar_list[17]) + let telegramChain: Bool? = nilOrValue(pigeonVar_list[18]) + let telegramTransactional: Bool? = nilOrValue(pigeonVar_list[19]) + let whatsappBulk: Bool? = nilOrValue(pigeonVar_list[20]) + let whatsappChain: Bool? = nilOrValue(pigeonVar_list[21]) + let whatsappTransactional: Bool? = nilOrValue(pigeonVar_list[22]) + let maxBulk: Bool? = nilOrValue(pigeonVar_list[23]) + let maxChain: Bool? = nilOrValue(pigeonVar_list[24]) + let maxTransactional: Bool? = nilOrValue(pigeonVar_list[25]) + let walletBulk: Bool? = nilOrValue(pigeonVar_list[26]) + + return ManageSubscriptionParamsWire( + email: email, + phone: phone, + externalId: externalId, + loyaltyId: loyaltyId, + telegramId: telegramId, + emailBulk: emailBulk, + emailChain: emailChain, + emailTransactional: emailTransactional, + smsBulk: smsBulk, + smsChain: smsChain, + smsTransactional: smsTransactional, + webPushBulk: webPushBulk, + webPushChain: webPushChain, + webPushTransactional: webPushTransactional, + mobilePushBulk: mobilePushBulk, + mobilePushChain: mobilePushChain, + mobilePushTransactional: mobilePushTransactional, + telegramBulk: telegramBulk, + telegramChain: telegramChain, + telegramTransactional: telegramTransactional, + whatsappBulk: whatsappBulk, + whatsappChain: whatsappChain, + whatsappTransactional: whatsappTransactional, + maxBulk: maxBulk, + maxChain: maxChain, + maxTransactional: maxTransactional, + walletBulk: walletBulk + ) + } + func toList() -> [Any?] { + return [ + email, + phone, + externalId, + loyaltyId, + telegramId, + emailBulk, + emailChain, + emailTransactional, + smsBulk, + smsChain, + smsTransactional, + webPushBulk, + webPushChain, + webPushTransactional, + mobilePushBulk, + mobilePushChain, + mobilePushTransactional, + telegramBulk, + telegramChain, + telegramTransactional, + whatsappBulk, + whatsappChain, + whatsappTransactional, + maxBulk, + maxChain, + maxTransactional, + walletBulk, + ] + } + static func == (lhs: ManageSubscriptionParamsWire, rhs: ManageSubscriptionParamsWire) -> Bool { + return deepEqualsPersonalizationApi(lhs.toList(), rhs.toList()) } + func hash(into hasher: inout Hasher) { + deepHashPersonalizationApi(value: toList(), hasher: &hasher) + } +} + /// Wire format for one product line in a tracking event (maps to native `TrackingItem`). /// /// [quantity] is the domain name for the line quantity; native sends it as `amount`. @@ -424,8 +556,10 @@ private class PersonalizationApiPigeonCodecReader: FlutterStandardReader { case 131: return ProfileParamsWire.fromList(self.readValue() as! [Any?]) case 132: - return TrackingItemWire.fromList(self.readValue() as! [Any?]) + return ManageSubscriptionParamsWire.fromList(self.readValue() as! [Any?]) case 133: + return TrackingItemWire.fromList(self.readValue() as! [Any?]) + case 134: return TrackingSourceWire.fromList(self.readValue() as! [Any?]) default: return super.readValue(ofType: type) @@ -444,12 +578,15 @@ private class PersonalizationApiPigeonCodecWriter: FlutterStandardWriter { } else if let value = value as? ProfileParamsWire { super.writeByte(131) super.writeValue(value.toList()) - } else if let value = value as? TrackingItemWire { + } else if let value = value as? ManageSubscriptionParamsWire { super.writeByte(132) super.writeValue(value.toList()) - } else if let value = value as? TrackingSourceWire { + } else if let value = value as? TrackingItemWire { super.writeByte(133) super.writeValue(value.toList()) + } else if let value = value as? TrackingSourceWire { + super.writeByte(134) + super.writeValue(value.toList()) } else { super.writeValue(value) } @@ -480,6 +617,7 @@ protocol PersonalizationHostApi { /// [customFieldsJson] is JSON object string or null (maps to native custom fields map). func trackEvent(event: String, time: Int64?, category: String?, label: String?, value: Int64?, customFieldsJson: String?, shopId: String?, completion: @escaping (Result) -> Void) func setProfile(params: ProfileParamsWire, shopId: String?, completion: @escaping (Result) -> Void) + func manageSubscription(params: ManageSubscriptionParamsWire, shopId: String?, completion: @escaping (Result) -> Void) /// Returns the recommendation block as a JSON string. /// [paramsJson] is a JSON object string with optional filter parameters. /// Dart layer parses the result into [RecommendationResponse]. @@ -646,6 +784,24 @@ class PersonalizationHostApiSetup { } else { setProfileChannel.setMessageHandler(nil) } + let manageSubscriptionChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationHostApi.manageSubscription\(channelSuffix)", binaryMessenger: binaryMessenger, codec: codec) + if let api = api { + manageSubscriptionChannel.setMessageHandler { message, reply in + let args = message as! [Any?] + let paramsArg = args[0] as! ManageSubscriptionParamsWire + let shopIdArg: String? = nilOrValue(args[1]) + api.manageSubscription(params: paramsArg, shopId: shopIdArg) { result in + switch result { + case .success: + reply(wrapResult(nil)) + case .failure(let error): + reply(wrapError(error)) + } + } + } + } else { + manageSubscriptionChannel.setMessageHandler(nil) + } /// Returns the recommendation block as a JSON string. /// [paramsJson] is a JSON object string with optional filter parameters. /// Dart layer parses the result into [RecommendationResponse]. diff --git a/ios/rees46_sdk.podspec b/ios/rees46_sdk.podspec index 4949ea5..01211c0 100644 --- a/ios/rees46_sdk.podspec +++ b/ios/rees46_sdk.podspec @@ -14,7 +14,7 @@ Flutter plugin wrapper around REES46 native SDK. s.source = { :path => '.' } s.source_files = 'Classes/**/*' s.dependency 'Flutter' - s.dependency 'REES46', '3.33.0' + s.dependency 'REES46', '3.35.0' s.platform = :ios, '13.0' # Flutter.framework does not contain a i386 slice. diff --git a/lib/rees46_sdk.dart b/lib/rees46_sdk.dart index 6cd497a..c08b3ea 100644 --- a/lib/rees46_sdk.dart +++ b/lib/rees46_sdk.dart @@ -16,6 +16,7 @@ export 'src/products/products_list_response.dart'; export 'src/search/search_params.dart'; export 'src/search/search_response.dart'; export 'src/sdk_init_config.dart'; +export 'src/subscriptions/manage_subscription_params.dart'; export 'src/tracking/purchase_line_item.dart'; export 'src/tracking/tracking_api.dart'; export 'src/tracking/tracking_models.dart'; diff --git a/lib/src/personalization_sdk.dart b/lib/src/personalization_sdk.dart index 04b57ef..c2a823d 100644 --- a/lib/src/personalization_sdk.dart +++ b/lib/src/personalization_sdk.dart @@ -18,6 +18,7 @@ import 'products/products_list_response.dart'; import 'search/search_params.dart'; import 'search/search_response.dart'; import 'sdk_init_config.dart'; +import 'subscriptions/manage_subscription_params.dart'; import 'tracking/purchase_line_item.dart'; import 'tracking/tracking_api.dart'; @@ -97,6 +98,12 @@ class PersonalizationSdk { return _api.setProfile(params.toWire(), shopId); } + /// Subscribes or unsubscribes the client per channel and mailing type, see + /// [ManageSubscriptionParams]. + Future manageSubscription(ManageSubscriptionParams params) { + return _api.manageSubscription(params.toWire(), shopId); + } + Future getSid() { return _api.getSid(shopId); } diff --git a/lib/src/pigeon/personalization_api.g.dart b/lib/src/pigeon/personalization_api.g.dart index f5a1867..c37d9ad 100644 --- a/lib/src/pigeon/personalization_api.g.dart +++ b/lib/src/pigeon/personalization_api.g.dart @@ -321,6 +321,179 @@ class ProfileParamsWire { ; } +/// Wire format for `subscriptions/manage`: contacts that identify the client and one flag per +/// channel and mailing type. `true` subscribes, `false` unsubscribes, `null` leaves it unchanged. +class ManageSubscriptionParamsWire { + ManageSubscriptionParamsWire({ + this.email, + this.phone, + this.externalId, + this.loyaltyId, + this.telegramId, + this.emailBulk, + this.emailChain, + this.emailTransactional, + this.smsBulk, + this.smsChain, + this.smsTransactional, + this.webPushBulk, + this.webPushChain, + this.webPushTransactional, + this.mobilePushBulk, + this.mobilePushChain, + this.mobilePushTransactional, + this.telegramBulk, + this.telegramChain, + this.telegramTransactional, + this.whatsappBulk, + this.whatsappChain, + this.whatsappTransactional, + this.maxBulk, + this.maxChain, + this.maxTransactional, + this.walletBulk, + }); + + String? email; + + String? phone; + + String? externalId; + + String? loyaltyId; + + String? telegramId; + + bool? emailBulk; + + bool? emailChain; + + bool? emailTransactional; + + bool? smsBulk; + + bool? smsChain; + + bool? smsTransactional; + + bool? webPushBulk; + + bool? webPushChain; + + bool? webPushTransactional; + + bool? mobilePushBulk; + + bool? mobilePushChain; + + bool? mobilePushTransactional; + + bool? telegramBulk; + + bool? telegramChain; + + bool? telegramTransactional; + + bool? whatsappBulk; + + bool? whatsappChain; + + bool? whatsappTransactional; + + bool? maxBulk; + + bool? maxChain; + + bool? maxTransactional; + + bool? walletBulk; + + List _toList() { + return [ + email, + phone, + externalId, + loyaltyId, + telegramId, + emailBulk, + emailChain, + emailTransactional, + smsBulk, + smsChain, + smsTransactional, + webPushBulk, + webPushChain, + webPushTransactional, + mobilePushBulk, + mobilePushChain, + mobilePushTransactional, + telegramBulk, + telegramChain, + telegramTransactional, + whatsappBulk, + whatsappChain, + whatsappTransactional, + maxBulk, + maxChain, + maxTransactional, + walletBulk, + ]; + } + + Object encode() { + return _toList(); } + + static ManageSubscriptionParamsWire decode(Object result) { + result as List; + return ManageSubscriptionParamsWire( + email: result[0] as String?, + phone: result[1] as String?, + externalId: result[2] as String?, + loyaltyId: result[3] as String?, + telegramId: result[4] as String?, + emailBulk: result[5] as bool?, + emailChain: result[6] as bool?, + emailTransactional: result[7] as bool?, + smsBulk: result[8] as bool?, + smsChain: result[9] as bool?, + smsTransactional: result[10] as bool?, + webPushBulk: result[11] as bool?, + webPushChain: result[12] as bool?, + webPushTransactional: result[13] as bool?, + mobilePushBulk: result[14] as bool?, + mobilePushChain: result[15] as bool?, + mobilePushTransactional: result[16] as bool?, + telegramBulk: result[17] as bool?, + telegramChain: result[18] as bool?, + telegramTransactional: result[19] as bool?, + whatsappBulk: result[20] as bool?, + whatsappChain: result[21] as bool?, + whatsappTransactional: result[22] as bool?, + maxBulk: result[23] as bool?, + maxChain: result[24] as bool?, + maxTransactional: result[25] as bool?, + walletBulk: result[26] as bool?, + ); + } + + @override + // ignore: avoid_equals_and_hash_code_on_mutable_classes + bool operator ==(Object other) { + if (other is! ManageSubscriptionParamsWire || other.runtimeType != runtimeType) { + return false; + } + if (identical(this, other)) { + return true; + } + return _deepEquals(encode(), other.encode()); + } + + @override + // ignore: avoid_equals_and_hash_code_on_mutable_classes + int get hashCode => Object.hashAll(_toList()) +; +} + /// Wire format for one product line in a tracking event (maps to native `TrackingItem`). /// /// [quantity] is the domain name for the line quantity; native sends it as `amount`. @@ -448,12 +621,15 @@ class _PigeonCodec extends StandardMessageCodec { } else if (value is ProfileParamsWire) { buffer.putUint8(131); writeValue(buffer, value.encode()); - } else if (value is TrackingItemWire) { + } else if (value is ManageSubscriptionParamsWire) { buffer.putUint8(132); writeValue(buffer, value.encode()); - } else if (value is TrackingSourceWire) { + } else if (value is TrackingItemWire) { buffer.putUint8(133); writeValue(buffer, value.encode()); + } else if (value is TrackingSourceWire) { + buffer.putUint8(134); + writeValue(buffer, value.encode()); } else { super.writeValue(buffer, value); } @@ -469,8 +645,10 @@ class _PigeonCodec extends StandardMessageCodec { case 131: return ProfileParamsWire.decode(readValue(buffer)!); case 132: - return TrackingItemWire.decode(readValue(buffer)!); + return ManageSubscriptionParamsWire.decode(readValue(buffer)!); case 133: + return TrackingItemWire.decode(readValue(buffer)!); + case 134: return TrackingSourceWire.decode(readValue(buffer)!); default: return super.readValueOfType(type, buffer); @@ -613,6 +791,29 @@ class PersonalizationHostApi { } } + Future manageSubscription(ManageSubscriptionParamsWire params, String? shopId) async { + final String pigeonVar_channelName = 'dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationHostApi.manageSubscription$pigeonVar_messageChannelSuffix'; + final BasicMessageChannel pigeonVar_channel = BasicMessageChannel( + pigeonVar_channelName, + pigeonChannelCodec, + binaryMessenger: pigeonVar_binaryMessenger, + ); + final Future pigeonVar_sendFuture = pigeonVar_channel.send([params, shopId]); + final List? pigeonVar_replyList = + await pigeonVar_sendFuture as List?; + if (pigeonVar_replyList == null) { + throw _createConnectionError(pigeonVar_channelName); + } else if (pigeonVar_replyList.length > 1) { + throw PlatformException( + code: pigeonVar_replyList[0]! as String, + message: pigeonVar_replyList[1] as String?, + details: pigeonVar_replyList[2], + ); + } else { + return; + } + } + /// Returns the recommendation block as a JSON string. /// [paramsJson] is a JSON object string with optional filter parameters. /// Dart layer parses the result into [RecommendationResponse]. diff --git a/lib/src/subscriptions/manage_subscription_params.dart b/lib/src/subscriptions/manage_subscription_params.dart new file mode 100644 index 0000000..08a07b1 --- /dev/null +++ b/lib/src/subscriptions/manage_subscription_params.dart @@ -0,0 +1,98 @@ +import '../pigeon/personalization_api.g.dart' as pigeon; + +/// Changes to a client's subscriptions for [PersonalizationSdk.manageSubscription]. +/// +/// [email], [phone], [externalId], [loyaltyId] and [telegramId] identify the client; the device is +/// always sent. Each flag is a channel and mailing type: `true` subscribes, `false` unsubscribes, +/// `null` keeps the current status. Wallet has the bulk type only. +class ManageSubscriptionParams { + final String? email; + final String? phone; + final String? externalId; + final String? loyaltyId; + final String? telegramId; + final bool? emailBulk; + final bool? emailChain; + final bool? emailTransactional; + final bool? smsBulk; + final bool? smsChain; + final bool? smsTransactional; + final bool? webPushBulk; + final bool? webPushChain; + final bool? webPushTransactional; + final bool? mobilePushBulk; + final bool? mobilePushChain; + final bool? mobilePushTransactional; + final bool? telegramBulk; + final bool? telegramChain; + final bool? telegramTransactional; + final bool? whatsappBulk; + final bool? whatsappChain; + final bool? whatsappTransactional; + final bool? maxBulk; + final bool? maxChain; + final bool? maxTransactional; + final bool? walletBulk; + + const ManageSubscriptionParams({ + this.email, + this.phone, + this.externalId, + this.loyaltyId, + this.telegramId, + this.emailBulk, + this.emailChain, + this.emailTransactional, + this.smsBulk, + this.smsChain, + this.smsTransactional, + this.webPushBulk, + this.webPushChain, + this.webPushTransactional, + this.mobilePushBulk, + this.mobilePushChain, + this.mobilePushTransactional, + this.telegramBulk, + this.telegramChain, + this.telegramTransactional, + this.whatsappBulk, + this.whatsappChain, + this.whatsappTransactional, + this.maxBulk, + this.maxChain, + this.maxTransactional, + this.walletBulk, + }); + + pigeon.ManageSubscriptionParamsWire toWire() { + return pigeon.ManageSubscriptionParamsWire( + email: email, + phone: phone, + externalId: externalId, + loyaltyId: loyaltyId, + telegramId: telegramId, + emailBulk: emailBulk, + emailChain: emailChain, + emailTransactional: emailTransactional, + smsBulk: smsBulk, + smsChain: smsChain, + smsTransactional: smsTransactional, + webPushBulk: webPushBulk, + webPushChain: webPushChain, + webPushTransactional: webPushTransactional, + mobilePushBulk: mobilePushBulk, + mobilePushChain: mobilePushChain, + mobilePushTransactional: mobilePushTransactional, + telegramBulk: telegramBulk, + telegramChain: telegramChain, + telegramTransactional: telegramTransactional, + whatsappBulk: whatsappBulk, + whatsappChain: whatsappChain, + whatsappTransactional: whatsappTransactional, + maxBulk: maxBulk, + maxChain: maxChain, + maxTransactional: maxTransactional, + walletBulk: walletBulk, + ); + } +} diff --git a/pigeons/personalization_api.dart b/pigeons/personalization_api.dart index a7c73a5..9fa53ff 100644 --- a/pigeons/personalization_api.dart +++ b/pigeons/personalization_api.dart @@ -109,6 +109,68 @@ class ProfileParamsWire { }); } +/// Wire format for `subscriptions/manage`: contacts that identify the client and one flag per +/// channel and mailing type. `true` subscribes, `false` unsubscribes, `null` leaves it unchanged. +class ManageSubscriptionParamsWire { + final String? email; + final String? phone; + final String? externalId; + final String? loyaltyId; + final String? telegramId; + final bool? emailBulk; + final bool? emailChain; + final bool? emailTransactional; + final bool? smsBulk; + final bool? smsChain; + final bool? smsTransactional; + final bool? webPushBulk; + final bool? webPushChain; + final bool? webPushTransactional; + final bool? mobilePushBulk; + final bool? mobilePushChain; + final bool? mobilePushTransactional; + final bool? telegramBulk; + final bool? telegramChain; + final bool? telegramTransactional; + final bool? whatsappBulk; + final bool? whatsappChain; + final bool? whatsappTransactional; + final bool? maxBulk; + final bool? maxChain; + final bool? maxTransactional; + final bool? walletBulk; + + const ManageSubscriptionParamsWire({ + this.email, + this.phone, + this.externalId, + this.loyaltyId, + this.telegramId, + this.emailBulk, + this.emailChain, + this.emailTransactional, + this.smsBulk, + this.smsChain, + this.smsTransactional, + this.webPushBulk, + this.webPushChain, + this.webPushTransactional, + this.mobilePushBulk, + this.mobilePushChain, + this.mobilePushTransactional, + this.telegramBulk, + this.telegramChain, + this.telegramTransactional, + this.whatsappBulk, + this.whatsappChain, + this.whatsappTransactional, + this.maxBulk, + this.maxChain, + this.maxTransactional, + this.walletBulk, + }); +} + /// Wire format for one product line in a tracking event (maps to native `TrackingItem`). /// /// [quantity] is the domain name for the line quantity; native sends it as `amount`. @@ -168,6 +230,9 @@ abstract class PersonalizationHostApi { @async void setProfile(ProfileParamsWire params, String? shopId); + @async + void manageSubscription(ManageSubscriptionParamsWire params, String? shopId); + /// Returns the recommendation block as a JSON string. /// [paramsJson] is a JSON object string with optional filter parameters. /// Dart layer parses the result into [RecommendationResponse]. diff --git a/test/manage_subscription_test.dart b/test/manage_subscription_test.dart new file mode 100644 index 0000000..3b48b40 --- /dev/null +++ b/test/manage_subscription_test.dart @@ -0,0 +1,126 @@ +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:rees46_sdk/rees46_sdk.dart'; +import 'package:rees46_sdk/src/pigeon/personalization_api.g.dart' as pigeon; + +const _manageSubscriptionChannel = + 'dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationHostApi.manageSubscription'; + +// Push channels registered by PersonalizationFlutterApi.setUp in the SDK ctor. +const _pushChannels = [ + 'dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationFlutterApi.onPushReceived', + 'dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationFlutterApi.onPushDelivered', + 'dev.flutter.pigeon.personalization_flutter_sdk.PersonalizationFlutterApi.onPushClicked', +]; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + const codec = pigeon.PersonalizationHostApi.pigeonChannelCodec; + final messenger = + TestDefaultBinaryMessengerBinding.instance.defaultBinaryMessenger; + + late List sentArgs; + + setUp(() { + for (final channel in _pushChannels) { + messenger.setMockMessageHandler( + channel, + (_) async => codec.encodeMessage([]), + ); + } + messenger.setMockMessageHandler(_manageSubscriptionChannel, ( + ByteData? message, + ) async { + sentArgs = codec.decodeMessage(message) as List; + return codec.encodeMessage([]); + }); + }); + + tearDown(() { + for (final channel in [..._pushChannels, _manageSubscriptionChannel]) { + messenger.setMockMessageHandler(channel, null); + } + }); + + pigeon.ManageSubscriptionParamsWire sentWire() => + sentArgs[0] as pigeon.ManageSubscriptionParamsWire; + + test( + 'contacts and Telegram, WhatsApp, Max, Wallet flags reach the bridge', + () async { + await PersonalizationSdk().manageSubscription( + const ManageSubscriptionParams( + phone: '+79990000000', + externalId: 'ext-1', + loyaltyId: 'loy-1', + telegramId: 'tg-1', + telegramBulk: true, + telegramChain: false, + telegramTransactional: true, + whatsappBulk: false, + whatsappChain: true, + whatsappTransactional: false, + maxBulk: true, + maxChain: false, + maxTransactional: true, + walletBulk: false, + ), + ); + + final wire = sentWire(); + expect(wire.phone, '+79990000000'); + expect(wire.externalId, 'ext-1'); + expect(wire.loyaltyId, 'loy-1'); + expect(wire.telegramId, 'tg-1'); + expect( + [wire.telegramBulk, wire.telegramChain, wire.telegramTransactional], + [true, false, true], + ); + expect( + [wire.whatsappBulk, wire.whatsappChain, wire.whatsappTransactional], + [false, true, false], + ); + expect( + [wire.maxBulk, wire.maxChain, wire.maxTransactional], + [true, false, true], + ); + expect(wire.walletBulk, false); + }, + ); + + test( + 'email, SMS and push flags reach the bridge, untouched ones stay null', + () async { + await PersonalizationSdk().manageSubscription( + const ManageSubscriptionParams( + email: 'user@example.com', + emailBulk: true, + smsChain: false, + webPushTransactional: true, + mobilePushBulk: false, + ), + ); + + final wire = sentWire(); + expect(wire.email, 'user@example.com'); + expect(wire.emailBulk, true); + expect(wire.smsChain, false); + expect(wire.webPushTransactional, true); + expect(wire.mobilePushBulk, false); + expect(wire.phone, isNull); + expect(wire.emailChain, isNull); + expect(wire.telegramBulk, isNull); + expect(wire.walletBulk, isNull); + }, + ); + + test('a handle bound to a shop sends its shop id', () async { + await PersonalizationSdk( + shopId: 'shop-b', + ).manageSubscription(const ManageSubscriptionParams(walletBulk: true)); + + expect(sentArgs[1], 'shop-b'); + expect(sentWire().walletBulk, true); + }); +}