@devvit/protos 0.12.1-next-2025-09-08-20-55-43-6ce1b439e.0 → 0.12.1-next-2025-09-09-13-45-18-0f0a506a2.0

package/schema/.snootobuf/deps/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/ledger.proto

@@ -0,0 +1,254 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.paypayments.v1;
+
+import "google/protobuf/timestamp.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-payments/payments-api/api/xpaymentsplatform/paypaymentspb/v1;paypaymentspb";
+
+message PutGoldPurchaseRequest {
+  // Idempotency key, unique identifier of the transaction (eg. order_id)
+  string transaction_id = 1;
+  // t2_ user ID of buyer
+  string user_id = 2;
+  // Fiat payment amount, in 1/100 units
+  int64 local_currency_amount = 3;
+  string local_currency = 4;
+  // GOLD product listing USD price, in cents.
+  // Required to calculate GOLD unit price in USD at the time of purchase, for accounting
+  int64 listing_price_usd = 5;
+  PaymentProvider payment_provider = 6;
+  // Payment provider order ID
+  string external_order_id = 7;
+  // Amount of GOLD purchased
+  int64 gold_amount = 8;
+  Environment environment = 9;
+}
+
+message PutGoldPurchaseResponse {
+  // Updated spendable balance
+  int64 spendable_gold = 1;
+}
+
+message PutGoldSpendingRequest {
+  // Idempotency key, unique identifier of the transaction (eg. order_id)
+  string transaction_id = 1;
+  // t2_ user ID of spender
+  string user_id = 2;
+  // t2_ user ID of GOLD receiver
+  string receiver_id = 3;
+  // Amount of GOLD awarded
+  int64 gold_amount = 4;
+  Environment environment = 5;
+}
+
+message PutGoldSpendingResponse {
+  // Updated spendable balance of spender
+  int64 spender_spendable_gold = 1;
+  // Updated earned balance of receiver
+  int64 receiver_earned_gold = 2;
+}
+
+message PutPayoutRequest {
+  // Idempotency key, unique identifier of payout operation
+  string transaction_id = 1;
+  // t2_ user ID
+  string user_id = 2;
+
+  // Payout parameters
+  int64 base_payout_amount_usd = 3;
+  int64 gold_balance_delta = 4;
+  int64 karma = 5;
+  int64 payout_percent = 6;
+  int64 fee = 7;
+  int64 final_payout_amount_usd = 8;
+  optional string local_payout_currency = 9;
+  optional int64 local_payout_amount = 10;
+  google.protobuf.Timestamp cutoff_time = 11;
+  repeated string payout_transactions = 12;
+
+  string stripe_bank_id = 14;
+  string stripe_account_id = 15;
+  string stripe_transfer_id = 16;
+  string stripe_payout_id = 17;
+  string stripe_error_reason = 18;
+
+  Environment environment = 13;
+
+  PayoutContext payout_context = 50;
+  // For cases where the fiat payout goes to a separate account from
+  // the gold payout, e.g. for Dev Platform
+  // - Gold payout -> app account
+  // - Fiat payout -> developer account
+  string with_separate_fiat_user_id = 51;
+}
+
+message PutPayoutResponse {
+  // Updated earned balance
+  int64 earned_gold = 1;
+}
+
+message PutPayoutFiatRequest {
+  // Idempotency key, unique identifier of payout operation
+  string transaction_id = 1;
+  // t2_ user ID
+  string user_id = 2;
+
+  // Payout parameters
+  string local_payout_currency = 3;
+  int64 local_payout_amount = 4;
+
+  Environment environment = 5;
+
+  // Stripe metadata
+  string stripe_bank_id = 6;
+  string stripe_account_id = 7;
+  string stripe_transfer_id = 8;
+  string stripe_payout_id = 9;
+  string stripe_error_reason = 10;
+
+  PayoutContext payout_context = 30;
+}
+
+message PutPayoutFiatResponse {}
+
+message RevertTransactionRequest {
+  // Idempotency key, unique identifier of refund operation
+  string transaction_id = 1;
+  // ID of original transaction which should be refunded
+  string original_transaction_id = 2;
+  // t2_ user ID of original transaction creator (for ownership verification)
+  string user_id = 3;
+  string reason = 4;
+  Environment environment = 5;
+  bool cover_payouts = 6;
+}
+
+message RevertTransactionResponse {
+  // Transaction IDs of reverted spendings which were not covered
+  // with the remaining user's balance, so the corresponding goods
+  // should be reverted, including the original_transaction_id if
+  // it was a spending
+  repeated string reverted_transaction_ids = 1;
+}
+
+message GetGoldBalanceRequest {
+  // t2_ user ID
+  string user_id = 1;
+  Environment environment = 2;
+}
+
+message GetGoldBalanceResponse {
+  int64 earned_gold = 1;
+  int64 earned_gold_devvit = 10;
+  int64 spendable_gold = 2;
+}
+
+message MigrateEarnedGoldBalanceRequest {
+  repeated MigrationRequest migration_requests = 1;
+}
+
+message MigrationRequest {
+  // Idempotency key, unique identifier of the transaction
+  string transaction_id = 1;
+  // t2_ user ID of the balance owner
+  string user_id = 2;
+  // Amount of earned GOLD to migrate
+  // = total amount of scaled (aka new) Gold
+  int64 earned_gold_amount = 3;
+  // USD cost of the migrated GOLD, in cents
+  // = total USD cost of all purchases accumulated in gold_amount
+  int64 usd_cost = 4;
+  // Timestamp to store this historical balance at
+  // Might be a fixed point in the past or a timestamp of the last
+  // awarding transaction in the aggregate
+  google.protobuf.Timestamp timestamp = 5;
+  Environment environment = 6;
+}
+
+message MigrateEarnedGoldBalanceResponse {
+  // Updated earned balance
+  map<string, int64> earned_gold = 1;
+}
+
+enum PayoutContext {
+  PAYOUT_CONTEXT_UNSPECIFIED = 0;
+  AWARDS = 1;
+  DEVVIT = 2;
+}
+
+message PayoutCandidatesRequest {
+  int64 balance_cutoff = 1;
+  google.protobuf.Timestamp time_cutoff = 2;
+  Environment environment = 3;
+  PayoutContext payout_context = 4;
+}
+
+message PayoutCandidatesResponse {
+  repeated string user_ids = 1;
+  map<string, int64> remaining_balances_by_user_ids = 2;
+}
+
+message NonPaidOutTransactionIdsRequest {
+  repeated string user_ids = 1;
+  google.protobuf.Timestamp time_cutoff = 2;
+  Environment environment = 3;
+}
+
+message UserTransactions {
+  string user_id = 1;
+  repeated string transaction_ids = 2;
+  int64 sum_gold = 3;
+}
+
+message NonPaidOutTransactionIdsResponse {
+  repeated UserTransactions transaction_ids_by_user_id = 1;
+}
+
+enum PaymentProvider {
+  PAYMENT_PROVIDER_UNSPECIFIED = 0;
+  STRIPE = 1;
+  PAYPAL = 2;
+  GOOGLE_INAPP = 3;
+  APPLE_INAPP = 4;
+  REDDIT_GOLD = 5;
+}
+
+enum Environment {
+  ENVIRONMENT_UNSPECIFIED = 0;
+  PRODUCTION = 1;
+  SANDBOX = 2;
+}
+
+service LedgerService {
+  // PutGoldPurchase stores GOLD pack purchase in Ledger
+  rpc PutGoldPurchase(PutGoldPurchaseRequest) returns (PutGoldPurchaseResponse) {}
+
+  // PutGoldSpending stores GOLD spending in Ledger
+  rpc PutGoldSpending(PutGoldSpendingRequest) returns (PutGoldSpendingResponse) {}
+
+  // PutPayout stores Earned GOLD payout in Ledger
+  rpc PutPayout(PutPayoutRequest) returns (PutPayoutResponse) {}
+
+  // PutPayoutFiat stores fiat payout in Ledger
+  rpc PutPayoutFiat(PutPayoutFiatRequest) returns (PutPayoutFiatResponse) {}
+
+  // RevertTransaction stores purchase or spending refund in Ledger rolling
+  // back all the consequentive spendings.
+  // Tries to use user's remaining balance to cover rolled back spendings.
+  // Transaction IDs for uncovered spendings are returned to roll back the
+  // corresponding goods, except if were already paid out
+  rpc RevertTransaction(RevertTransactionRequest) returns (RevertTransactionResponse) {}
+
+  // GetGoldBalance returns user's spendable and earned Gold balances
+  rpc GetGoldBalance(GetGoldBalanceRequest) returns (GetGoldBalanceResponse) {}
+
+  // MigrateEarnedGoldBalance migrates historical gold balance
+  rpc MigrateEarnedGoldBalance(MigrateEarnedGoldBalanceRequest) returns (MigrateEarnedGoldBalanceResponse) {}
+
+  // PayoutCandidates returns user IDs eligible for payout
+  rpc PayoutCandidates(PayoutCandidatesRequest) returns (PayoutCandidatesResponse) {}
+
+  // NonPaidOutTransactionIds returns transaction IDs that have not been paid out by user ID
+  rpc NonPaidOutTransactionIds(NonPaidOutTransactionIdsRequest) returns (NonPaidOutTransactionIdsResponse) {}
+}

package/schema/.snootobuf/deps/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/payments_data_compliance.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.paypayments.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/paypayments/v1/paypayments.proto";
+import "reddit/xpaymentsplatform/payproducts/v1/payproducts.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-payments/payments-api/api/xpaymentsplatform/paypaymentspb/v1;paypaymentspb";
+
+message DeleteUsersDataRequest {
+  string requester_id = 1;
+  repeated string user_ids = 2;
+}
+
+message DeleteUsersDataResponse {
+  repeated string user_ids = 1;
+}
+
+message GetUsersPurchasesRequest {
+  repeated string user_ids = 1;
+  google.protobuf.Timestamp start_from = 2;
+  google.protobuf.Timestamp end_at = 3;
+}
+
+message GetUsersPurchasesResponse {
+  repeated Purchase purchases = 1;
+}
+
+message Purchase {
+  string buyer_id = 1;
+  reddit.xpaymentsplatform.payproducts.v1.PaymentProvider provider = 2;
+  string external_payment_id = 3;
+  reddit.xpaymentsplatform.payproducts.v1.ProductType product_type = 4;
+  google.protobuf.Timestamp created_at = 5;
+  reddit.xpaymentsplatform.payproducts.v1.ProductPrice price = 6;
+  reddit.xpaymentsplatform.paypayments.v1.PaymentUnitStatus status = 7;
+}
+
+service DataComplianceService {
+  rpc DeleteUsersData(DeleteUsersDataRequest) returns (DeleteUsersDataResponse) {}
+  rpc GetUsersPurchases(GetUsersPurchasesRequest) returns (GetUsersPurchasesResponse) {}
+}

package/schema/.snootobuf/deps/.snootobuf/deps/reddit/xpaymentsplatform/paypayments/v1/paypayments.proto

@@ -0,0 +1,293 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.paypayments.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/paycommon/v1/order_status_reason.proto";
+import "reddit/xpaymentsplatform/payproducts/v1/payproducts.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-payments/payments-api/api/xpaymentsplatform/paypaymentspb/v1;paypaymentspb";
+
+message CreatePaymentEventRequest {
+  reddit.xpaymentsplatform.payproducts.v1.Environment environment = 1;
+  string order_id = 2;
+  string buyer_id = 3;
+  repeated PaymentUnit units = 4;
+  ClientInfo client_info = 5;
+}
+
+message PaymentUnit {
+  PaymentMode mode = 1;
+  reddit.xpaymentsplatform.payproducts.v1.PaymentProvider provider = 2;
+  string seller_id = 3;
+  reddit.xpaymentsplatform.payproducts.v1.ProductPrice checkout_price = 4;
+  reddit.xpaymentsplatform.payproducts.v1.Product product = 5;
+}
+
+message ClientInfo {
+  string app_name = 1;
+  string app_version = 2;
+  string request_ip = 3;
+  string country_code = 4;
+  string subdivision_code = 5;
+  string city_code = 6;
+}
+
+message CreatePaymentEventResponse {
+  string order_id = 1;
+  PaymentEventStatus status = 2;
+  repeated PaymentUnitResponse units = 3;
+}
+
+message PaymentUnitResponse {
+  PaymentMode mode = 1;
+  reddit.xpaymentsplatform.payproducts.v1.PaymentProvider provider = 2;
+  PaymentAction action = 3;
+}
+
+message PaymentAction {
+  PaymentUnitStatus status = 1;
+  string client_token = 2;
+}
+
+message CreatePaymentRefundRequest {
+  string order_id = 1;
+  RefundReason old_refund_reason = 2 [deprecated = true]; // replaced by field #5
+
+  // One of the below fields must be present
+  string initiator_user_id = 3; // The user who initiated the refund request, if present.
+  string initiator_service_id = 4; // The service that initiated the refund request, if present.
+  reddit.xpaymentsplatform.paycommon.v1.StatusReason reason = 5;
+  bool synchronous = 10; // If true, the refund will be processed synchronously. If false, the refund will be processed asynchronously.
+}
+
+message CreatePaymentRefundResponse {}
+
+message GetGoldBalancesRequest {
+  reddit.xpaymentsplatform.payproducts.v1.Environment environment = 1;
+  string user_id = 2;
+  bool include_earned_gold = 3;
+  bool include_earned_gold_devvit = 20;
+  bool include_spendable_gold = 4;
+  bool include_earned_gold_transactions = 5;
+  bool include_earned_gold_devvit_transactions = 21;
+  bool include_spendable_gold_transactions = 6;
+}
+
+message GetGoldBalancesResponse {
+  GoldBalance earned_gold = 1;
+  GoldBalance earned_gold_devvit = 20;
+  GoldBalance spendable_gold = 2;
+}
+
+message GoldBalance {
+  int32 available = 1;
+  int32 total = 2;
+  GoldTransactionsConnection transactions_connection = 3;
+}
+
+message GoldTransactionsConnection {
+  repeated GoldTransaction transactions = 1;
+  PageInfo page_info = 2;
+}
+
+message GoldTransaction {
+  string transaction_id = 1; // order_id
+  string product_id = 2; // Required to support atomic checkout. Not required to be populated at MVP
+  reddit.xpaymentsplatform.payproducts.v1.ProductPrice checkout_price = 3;
+  string from_user_id = 4; // If empty, user was removed from the system
+  string to_user_id = 5; // If empty, user was removed from the system
+  google.protobuf.Timestamp date = 6;
+}
+
+// Required to support pagination of GoldTransactions.
+// Pagination will not be required at MVP.
+message PageInfo {
+  string start_cursor = 1; // if empty, start from the most recent transaction
+  int32 page_size = 2;
+  bool has_next_page = 3;
+}
+
+message AcknowledgeOrderDeliveryRequest {
+  string order_id = 1;
+  string package_name = 2;
+  string product_id = 3;
+  string purchase_token = 4;
+  reddit.xpaymentsplatform.payproducts.v1.Environment environment = 5;
+}
+
+message AcknowledgeOrderDeliveryResponse {}
+
+message AcknowledgeRecurringPaymentRequest {
+  string order_id = 1;
+  reddit.xpaymentsplatform.payproducts.v1.Environment environment = 2;
+}
+
+message AcknowledgeRecurringPaymentResponse {}
+
+message ProcessPaymentNotificationRequest {
+  reddit.xpaymentsplatform.payproducts.v1.Environment environment = 1;
+  string order_id = 2;
+  // Maps to payment_events.external_payment_id for one-time purchases and to recurring_payments.external_id for recurring payments
+  string external_payment_id = 3;
+  payproducts.v1.PaymentProvider payment_provider = 4;
+  PaymentNotificationType notification_type = 5;
+  payproducts.v1.ProductPrice price = 6; // The price paid by the buyer, it must be the localised price.
+  google.protobuf.Timestamp notification_date = 7; // The date and time of the payment notification, as show inside the payment provider's system.
+  string external_product_id = 8; // The product id for the payment
+  RecurringPaymentState recurring_payment = 9;
+  string external_payment_token = 10; // Provider-specific data required to manage payment
+  // Leaving some space in case we find other mandatory fields to add
+
+  string raw_notification = 50; // JSON string of the raw notification. Stored for debugging purposes.
+  GoogleInAppPurchaseNotification google_in_app_purchase_notification = 51;
+}
+
+message RecurringPaymentState {
+  google.protobuf.Timestamp starts_at = 1;
+  google.protobuf.Timestamp trial_ends_at = 2;
+  google.protobuf.Timestamp next_renewal_at = 3;
+  google.protobuf.Timestamp grace_ends_at = 4;
+  google.protobuf.Timestamp ends_at = 5;
+  string renewal_payment_id = 6; // Maps to payment_events.external_payment_id for recurring payments
+}
+
+message GoogleInAppPurchaseNotification {
+  string package_name = 1; // Android app's package name
+  string purchase_token = 2; // unique identifier that can be used to acknowledge the android in-app purchase
+}
+
+message ProcessPaymentNotificationResponse {}
+
+message GetUserProfilesRequest {
+  repeated string user_ids = 1;
+}
+
+message UserProfileList {
+  repeated UserProfile user_profiles = 1;
+}
+
+message UserProfile {
+  reddit.xpaymentsplatform.payproducts.v1.Environment environment = 1;
+  StripeProfile stripe_profile = 2;
+}
+
+message StripeProfile {
+  string stripe_account_id = 1;
+}
+
+message GetUserProfilesResponse {
+  map<string, UserProfileList> user_profiles = 1;
+}
+
+enum RefundReason {
+  option deprecated = true; // Use pay-common's StatusReason instead
+  REFUND_REASON_UNSPECIFIED = 0;
+
+  REFUND_REASON_DUPLICATED = 1;
+  REFUND_REASON_FRAUDULENT = 2;
+  REFUND_REASON_CHARGEBACK = 3;
+  REFUND_REASON_REQUESTED_BY_USER = 4;
+  REFUND_REASON_REQUESTED_BY_REDDIT_ADMIN = 5;
+  REFUND_REASON_REVERTED = 6;
+}
+
+// Indicates where the payment will be executed
+enum PaymentMode {
+  PAYMENT_MODE_UNSPECIFIED = 0;
+
+  PAYMENT_MODE_CLIENT_SIDE = 1;
+  PAYMENT_MODE_CLIENT_SIDE_REDIRECT = 2;
+  PAYMENT_MODE_SERVER_SIDE = 3;
+}
+
+enum PaymentEventStatus {
+  PAYMENT_EVENT_STATUS_UNSPECIFIED = 0;
+
+  PAYMENT_EVENT_STATUS_NEW = 1;
+  PAYMENT_EVENT_STATUS_SUCCEEDED = 2;
+  PAYMENT_EVENT_STATUS_FAILED = 3;
+
+  PAYMENT_EVENT_STATUS_REVERTED_CREATED = 4;
+  PAYMENT_EVENT_STATUS_REVERTED_COMPLETED = 5;
+  PAYMENT_EVENT_STATUS_REVERTED_FAILED = 6;
+
+  PAYMENT_EVENT_STATUS_ACKNOWLEDGED = 7;
+}
+
+enum PaymentUnitStatus {
+  PAYMENT_UNIT_STATUS_UNSPECIFIED = 0;
+
+  PAYMENT_UNIT_STATUS_NEW = 1;
+  PAYMENT_UNIT_STATUS_ACTION_REQUIRED = 2;
+  PAYMENT_UNIT_STATUS_SUCCEEDED = 3;
+  PAYMENT_UNIT_STATUS_FAILED = 4;
+
+  PAYMENT_UNIT_STATUS_REVERTED_CREATED = 5;
+  PAYMENT_UNIT_STATUS_REVERTED_COMPLETED = 6;
+  PAYMENT_UNIT_STATUS_REVERTED_FAILED = 7;
+}
+
+enum PaymentNotificationType {
+  PAYMENT_NOTIFICATION_TYPE_UNSPECIFIED = 0;
+
+  PAYMENT_NOTIFICATION_TYPE_SUCCEEDED = 1;
+  PAYMENT_NOTIFICATION_TYPE_FAILED = 2;
+  PAYMENT_NOTIFICATION_TYPE_REFUNDED = 3;
+  PAYMENT_NOTIFICATION_TYPE_DISPUTE = 4;
+  PAYMENT_NOTIFICATION_TYPE_CANCELED = 5;
+}
+
+message CancelRecurringPaymentRequest {
+  string order_id = 1;
+  string buyer_id = 2;
+  reddit.xpaymentsplatform.payproducts.v1.Environment environment = 3;
+}
+
+message CancelRecurringPaymentResponse {}
+
+message ChangePaymentMethodRequest {
+  string user_id = 1;
+  string order_id = 2;
+  payproducts.v1.Environment environment = 3;
+  ClientInfo client_info = 4;
+  optional string success_url = 5;
+  optional string cancel_url = 6;
+}
+
+message ChangePaymentMethodResponse {
+  payproducts.v1.PaymentProvider payment_provider = 1;
+  string session_id = 2;
+}
+
+message TransferRecurringPaymentRequest {
+  string order_id = 1;
+  payproducts.v1.Environment environment = 2;
+  string from_user_id = 3;
+  string to_user_id = 4;
+}
+
+message TransferRecurringPaymentResponse {}
+
+service PayPaymentsService {
+  rpc AcknowledgeOrderDelivery(AcknowledgeOrderDeliveryRequest) returns (AcknowledgeOrderDeliveryResponse) {}
+
+  rpc AcknowledgeRecurringPayment(AcknowledgeRecurringPaymentRequest) returns (AcknowledgeRecurringPaymentResponse) {}
+
+  rpc CreatePaymentEvent(CreatePaymentEventRequest) returns (CreatePaymentEventResponse) {}
+
+  rpc CreatePaymentRefund(CreatePaymentRefundRequest) returns (CreatePaymentRefundResponse) {}
+
+  rpc GetGoldBalances(GetGoldBalancesRequest) returns (GetGoldBalancesResponse) {}
+
+  rpc ProcessPaymentNotification(ProcessPaymentNotificationRequest) returns (ProcessPaymentNotificationResponse) {}
+
+  rpc GetUserProfiles(GetUserProfilesRequest) returns (GetUserProfilesResponse) {}
+
+  // CancelRecurringPayment cancels a recurring payment.
+  rpc CancelRecurringPayment(CancelRecurringPaymentRequest) returns (CancelRecurringPaymentResponse) {}
+  // ChangePaymentMethod changes the payment method for an order.
+  rpc ChangePaymentMethod(ChangePaymentMethodRequest) returns (ChangePaymentMethodResponse) {}
+  // TransferRecurringPayment transfers a recurring payment between users.
+  rpc TransferRecurringPayment(TransferRecurringPaymentRequest) returns (TransferRecurringPaymentResponse) {}
+}