@chotot/ct-logic-uni-rev-premium-v1 1.286.0

package/listing_tier.proto

@@ -0,0 +1,228 @@
+syntax = "proto3";
+package ct_logic_uni_rev_premium.v1;
+
+option go_package = "github.com/carousell/ct-grpc-go/pkg/ct-logic-uni-rev-premium;pb";
+
+import "validate/validate.proto";
+import "google/protobuf/timestamp.proto";
+
+enum BenefitType {
+  BENEFIT_TYPE_UNSPECIFIED = 0;
+  BENEFIT_TYPE_COMMUNICATION_VIA_ZALO = 1;
+  BENEFIT_TYPE_BLOCK_OTHER_LISTINGS = 2;
+  BENEFIT_TYPE_SHARE_CROSS_PLATFORM = 3;
+  BENEFIT_TYPE_STICKY_AD = 4;
+  BENEFIT_TYPE_SDA = 5;
+  BENEFIT_TYPE_NEW_AD = 6;
+}
+
+message GetActiveBenefitsByListingTierRequest {
+  int64 ad_id = 1;
+}
+
+message GetActiveBenefitsByListingTierResponse {
+  repeated ActiveBenefit benefits = 1;
+}
+
+message ActiveBenefit {
+  BenefitType type = 1;
+}
+
+message ApplyListingTierOnPosRequest {
+  int64 ad_id = 1 [(validate.rules).int64.gt = 0];
+  int64 account_id = 2 [(validate.rules).int64.gt = 0];
+  ApplyListingTierOnPosMetadata metadata = 3;
+}
+
+message ApplyListingTierOnPosMetadata {
+  string tier_price_id = 1;
+  optional string subscription_id = 2;
+  optional string voucher_id = 3;
+  string listing_fee_type = 4 [(validate.rules).string = {
+    in: [
+      "paid_listing_fee_entitlement",
+      "free_listing_fee_voucher",
+      "free_listing_fee_entitlement",
+      "subscription_quota"
+    ]
+  }];
+  string tier_code = 5;
+  int64 duration = 6;
+}
+
+message ApplyListingTierOnPosResponse {
+  string next_step = 1; // "checkout" or "pos", checkout if listing tier is not free & pos if listing tier is free or from membership
+}
+
+message ApplyListingTierWithSubscriptionRequest {
+  int64 ad_id = 1 [(validate.rules).int64.gt = 0];
+  int64 account_id = 2 [(validate.rules).int64.gt = 0];
+  ApplyListingTierWithSubscriptionMetadata metadata = 3;
+}
+
+message ApplyListingTierWithSubscriptionMetadata {
+  string tier_code = 1;
+  int64 duration = 2;
+  int64 subscription_package_unit_delivery_id = 3;
+}
+
+message ApplyListingTierWithSubscriptionResponse {}
+
+message GetTierOptionsForPosRequest {
+  optional string listing_tier_pos_action = 1 [(validate.rules).string = {
+      in: [
+        "upgrade",
+        "extend"
+      ]
+    }];
+  int64 ad_id = 2;
+  int64 account_id = 3;
+}
+
+message GetTierOptionsForPosResponse {
+  repeated TierOption tier_options = 1;
+  repeated PosAdInfo ad_info = 2;
+}
+
+message PosAdInfo {
+  string title = 1;
+  string description = 2;
+  string price_text = 3;
+  string display_mode = 4;
+  repeated string image_urls = 5;
+  int64 big_category_id = 6;
+  int64 sub_category_id = 7;
+  repeated ServiceDeliveryInfo service_delivery_infos = 8;
+}
+
+message BannerInfo {
+  // Possible values: "promote", "info"
+  string type = 1;
+  string icon_url = 2;
+  string text = 3;
+  string next_action = 4;
+}
+
+message TierOption {
+  string tier_price_id       = 1;
+
+  // Possible values: "casual", "professional", "elite"
+  string tier_code           = 2;
+
+  int64 duration            = 3;
+  int64 original_price      = 4;
+  int64 discounted_price    = 5;
+  int64 discount_percentage = 6;
+  string listing_fee_type    = 7;
+  bool is_trial_eligible = 8;
+  bool is_default_selected = 9;
+  BannerInfo banner_info = 10;
+  oneof metadata {
+    MetadataListingFeeTypeSubscription subscription = 11;
+    MetadataListingFeeTypeVoucher voucher = 12;
+  }
+}
+
+message GetTierOfAdRequest {
+  int64 ad_id = 1 [(validate.rules).int64.gt = 0];
+  int64 account_id = 2 [(validate.rules).int64.gt = 0];
+}
+
+message GetTierOfAdResponse {
+  string tier_code = 1;
+  int64 duration = 2;
+  google.protobuf.Timestamp started_at = 3;
+  google.protobuf.Timestamp expires_at = 4;
+  bool can_upgrade = 5;
+}
+
+message CheckSKFeatureEnableRequest {
+  int64 account_id = 1;
+  optional int64 category_id = 2;
+  optional int64 ad_id = 3;
+}
+message CheckSKFeatureEnableResponse {
+  bool listing_tier_enabled = 1;
+  bool package_tier_enabled = 2;
+}
+
+message UpdateServiceStatusRequest {
+    string operation = 1 [(validate.rules).string = {
+        in: [
+        "deliver",
+        "cancel"
+        ]
+    }];
+    string transaction_id = 2 [(validate.rules).string.min_len = 1];
+    string service_type = 3 [(validate.rules).string = {
+        in: [
+        "newad",
+        "sticky_ad",
+        "special_display",
+        "auto_bump",
+        "communication_via_zalo",
+        "share_ad_cross_platform",
+        "block_other_listings"
+        ]
+    }];
+    
+    // To track the delivery in the external system
+    // Provide only if the operation is "deliver"
+    optional string ref_delivery_id = 4;
+
+    string status = 5 [(validate.rules).string = {
+      in: [
+        "success",
+        "failed"
+      ]
+    }];
+
+    // Failure reason/note if any
+    string note = 6;
+}
+
+message UpdateServiceStatusResponse {}
+
+message GetTierInfoOfAdsRequest {
+    repeated int64 ad_ids = 1 [(validate.rules).repeated.min_items = 1];
+    int64 account_id = 2 [(validate.rules).int64.gt = 0];
+}
+
+message GetTierInfoOfAdsResponse {
+    map<int64, TierInfo> data = 1;
+}
+
+message TierInfo {
+  string tier_code = 1;
+  int64 duration = 2;
+  google.protobuf.Timestamp started_at = 3;
+  google.protobuf.Timestamp expires_at = 4;
+  bool can_upgrade = 5;
+}
+
+message GetAlacarteServicesRequest {
+  int64 ad_id = 1 [(validate.rules).int64.gt = 0];
+}
+
+message GetAlacarteServicesResponse {
+  string current_tier_code = 1;
+  repeated ServicePermission services = 2;
+}
+
+message ServicePermission {
+    string service_type = 1;
+    bool is_locked = 2;
+}
+
+message MetadataListingFeeTypeVoucher {
+  string voucher_id = 1;
+}
+
+message MetadataListingFeeTypeSubscription {
+  string subscription_id = 1;
+}
+
+message ServiceDeliveryInfo {
+  string service_type = 1;
+  string meta_data = 2;
+}