@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/paygatewaypsps/v1/paygatewaypsps.proto

@@ -0,0 +1,304 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.paygatewaypsps.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/payorders/v1/order.proto";
+import "reddit/xpaymentsplatform/payproducts/v1/currencies.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-gateway-psps/gateway-api/api/xpaymentsplatform/paygatewaypspspb/v1;paygatewaypspspb";
+
+message AcknowledgeDeliveryRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string package_name = 3;
+  string product_id = 4;
+  string purchase_token = 5;
+}
+
+message AcknowledgeDeliveryResponse {}
+
+message CreateProfileRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string email = 3;
+  string metadata = 4; // JSON to attach to the profile TODO: currently unused
+}
+
+message CreateProfileResponse {
+  string profile_id = 1;
+}
+
+message CreateClientTokenRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_unit_id = 3; // idempotency key
+  int64 price = 4;
+  string statement_descriptor = 5;
+  PaymentProfile profile = 6;
+  string metadata = 7; // JSON to attach to the receipt
+  reddit.xpaymentsplatform.payproducts.v1.Currency currency = 8;
+}
+
+message PaymentProfile {
+  string email = 1;
+  string provider_id = 2;
+}
+
+message CreateClientTokenResponse {
+  string payment_id = 1;
+  string token = 2;
+  PaymentStatus status = 3;
+}
+
+message GetPaymentStatusRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_id = 3;
+  string package_name = 4;
+  string product_id = 5;
+  string purchase_token = 6;
+}
+
+message GetPaymentStatusResponse {
+  PaymentStatus status = 1;
+}
+
+message RefundRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_id = 3;
+}
+
+message RefundResponse {
+  string refund_id = 1;
+  RefundStatus status = 2;
+}
+
+message GetProductPurchaseRequest {
+  PaymentProvider provider = 1;
+  // This field is deprecated as Google purchase environment is determined by the purchase type
+  // This field will be ignored if set
+  Environment environment = 2 [deprecated = true];
+
+  string package_name = 3;
+  string product_id = 4;
+  string purchase_token = 5;
+}
+
+message GetProductPurchaseResponse {
+  string order_id = 1; // external order_id
+  PaymentStatus purchase_state = 2;
+  google.protobuf.Timestamp purchase_time = 3;
+  AcknowledgementState acknowledgement_state = 4;
+  string purchase_token = 5;
+  string product_id = 6;
+  string region_code = 7; // ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted
+  string obfuscated_external_account_id = 8; // contains the internal order_id
+  Environment environment = 9;
+}
+
+message GetProductRequest {
+  PaymentProvider provider = 1;
+  // Google doesn't support environment in the product request and doesn't return on either, so this field is obsolete
+  // This field will be ignored if set
+  Environment environment = 2 [deprecated = true];
+
+  string package_name = 3;
+  string product_id = 4;
+}
+
+message GetProductResponse {
+  string product_id = 1;
+  string price = 2; // Price in 1/million of the currency base unit, represented as a string
+  reddit.xpaymentsplatform.payproducts.v1.Currency currency = 3;
+}
+
+message GetStripeChargeRequest {
+  string charge_id = 1;
+  Environment environment = 2;
+}
+
+message GetStripeChargeResponse {
+  string risk_level = 1;
+  int64 risk_score = 2;
+  string rule_id = 3;
+}
+
+message CreateRecurringPaymentRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_id = 3; // idempotency key
+  string external_product_id = 4;
+  string product_description = 5;
+  PaymentProfile profile = 6;
+  string metadata = 7; // JSON
+}
+
+message CreateRecurringPaymentResponse {
+  string recurring_payment_id = 1;
+  string initial_payment_id = 2;
+  string client_token = 3;
+  PaymentStatus status = 4;
+}
+
+message GetRecurringPaymentStatusRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string recurring_payment_id = 3;
+  string package_name = 4;
+}
+
+message GetRecurringPaymentStatusResponse {
+  string recurring_payment_id = 1;
+  RecurringPaymentState state = 2;
+  AcknowledgementState acknowledgement_state = 3;
+  string purchase_token = 4; // Provider-specific data for managing the recurring payment
+  string external_product_id = 5;
+  string region_code = 6; // ISO 3166-1 alpha-2 billing region code of the user at the time the product was granted
+  string order_id = 7;
+  Environment environment = 8;
+  google.protobuf.Timestamp starts_at = 9;
+  google.protobuf.Timestamp trial_ends_at = 10;
+  google.protobuf.Timestamp next_renewal_at = 11;
+  google.protobuf.Timestamp grace_ends_at = 12;
+  google.protobuf.Timestamp ends_at = 13;
+  string latest_payment_id = 14;
+  string latest_payment_price = 15; // Price in 1/million of the currency base unit, represented as a string
+  reddit.xpaymentsplatform.payproducts.v1.Currency latest_payment_currency = 16;
+  string metadata = 17; // JSON
+}
+
+message FinalizeDevvitOrderRequest {
+  reddit.xpaymentsplatform.payorders.v1.Order order = 1;
+}
+
+message FinalizeDevvitOrderResponse {
+  oneof result {
+    // the product has been acknowledged and delivered
+    bool acknowledged = 1;
+    // the reason for rejecting product delivery
+    string rejection_reason = 2;
+  }
+}
+
+message ExchangeRate {
+  string currency_name = 1;
+  int64 currency_rate = 2;
+}
+
+message GetExchangeRatesRequest {
+  string base_currency = 1;
+  repeated string target_currencies = 2;
+}
+
+message GetExchangeRatesResponse {
+  string base_currency = 1;
+  repeated ExchangeRate rates = 2;
+}
+
+message CancelRecurringPaymentRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string payment_id = 3;
+}
+
+message CancelRecurringPaymentResponse {}
+
+message ChangePaymentMethodRequest {
+  string user_id = 1;
+  string recurring_payment_id = 2;
+  PaymentProvider payment_provider = 3;
+  Environment environment = 4;
+  optional string success_url = 5;
+  optional string cancel_url = 6;
+}
+
+message ChangePaymentMethodResponse {
+  string payment_token = 1;
+}
+
+message AcknowledgeRecurringPaymentRequest {
+  PaymentProvider provider = 1;
+  Environment environment = 2;
+
+  string recurring_payment_id = 3;
+  string purchase_token = 4; // Provider-specific data (from GetRecurringPaymentStatusResponse) for managing the recurring payment
+}
+
+message AcknowledgeRecurringPaymentResponse {}
+
+enum PaymentProvider {
+  PAYMENT_PROVIDER_UNSPECIFIED = 0;
+  PAYMENT_PROVIDER_GOOGLE = 1;
+  PAYMENT_PROVIDER_STRIPE = 2;
+}
+
+enum Environment {
+  ENVIRONMENT_UNSPECIFIED = 0;
+  ENVIRONMENT_SANDBOX = 1;
+  ENVIRONMENT_PRODUCTION = 2;
+}
+
+enum PaymentStatus {
+  PAYMENT_STATUS_UNSPECIFIED = 0;
+  PAYMENT_STATUS_SUCCESS = 1;
+  PAYMENT_STATUS_CANCELED = 2;
+  PAYMENT_STATUS_PROCESSING = 3;
+  PAYMENT_STATUS_REQUIRES_PAYMENT_METHOD = 4;
+}
+
+enum RefundStatus {
+  REFUND_STATUS_UNSPECIFIED = 0;
+  REFUND_STATUS_PENDING = 1;
+  REFUND_STATUS_REQUIRES_ACTION = 2;
+  REFUND_STATUS_SUCCEEDED = 3;
+  REFUND_STATUS_FAILED = 4;
+  REFUND_STATUS_CANCELED = 5;
+}
+
+enum AcknowledgementState {
+  ACKNOWLEDGEMENT_STATE_UNSPECIFIED = 0;
+  ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED = 1;
+  ACKNOWLEDGEMENT_STATE_UNACKNOWLEDGED = 2;
+}
+
+enum RecurringPaymentState {
+  RECURRING_PAYMENT_STATE_UNSPECIFIED = 0;
+  RECURRING_PAYMENT_STATE_PENDING = 1;
+  RECURRING_PAYMENT_STATE_ACTIVE = 2;
+  RECURRING_PAYMENT_STATE_CANCELED = 3;
+  RECURRING_PAYMENT_STATE_TERMINATED = 4;
+  RECURRING_PAYMENT_STATE_FAILED = 5;
+}
+
+service PayGatewayPSPsService {
+  rpc AcknowledgeDelivery(AcknowledgeDeliveryRequest) returns (AcknowledgeDeliveryResponse) {}
+  rpc CreateClientToken(CreateClientTokenRequest) returns (CreateClientTokenResponse) {}
+  rpc CreateProfile(CreateProfileRequest) returns (CreateProfileResponse) {}
+  rpc CreateRecurringPayment(CreateRecurringPaymentRequest) returns (CreateRecurringPaymentResponse) {}
+
+  // Once the order is in status PAID Devvit will decide the next status "REVERTED" or "DELIVERED"
+  rpc FinalizeDevvitOrder(FinalizeDevvitOrderRequest) returns (FinalizeDevvitOrderResponse) {}
+  rpc GetPaymentStatus(GetPaymentStatusRequest) returns (GetPaymentStatusResponse) {}
+  rpc GetRecurringPaymentStatus(GetRecurringPaymentStatusRequest) returns (GetRecurringPaymentStatusResponse) {}
+  rpc GetProduct(GetProductRequest) returns (GetProductResponse) {}
+  rpc GetProductPurchase(GetProductPurchaseRequest) returns (GetProductPurchaseResponse) {}
+  rpc GetStripeCharge(GetStripeChargeRequest) returns (GetStripeChargeResponse) {}
+  rpc Refund(RefundRequest) returns (RefundResponse) {}
+
+  rpc GetExchangeRates(GetExchangeRatesRequest) returns (GetExchangeRatesResponse) {}
+  // CancelRecurringPayment cancels a recurring payment.
+  rpc CancelRecurringPayment(CancelRecurringPaymentRequest) returns (CancelRecurringPaymentResponse) {}
+  // ChangePaymentMethod changes the payment method for a recurring payment.
+  rpc ChangePaymentMethod(ChangePaymentMethodRequest) returns (ChangePaymentMethodResponse) {}
+  rpc AcknowledgeRecurringPayment(AcknowledgeRecurringPaymentRequest) returns (AcknowledgeRecurringPaymentResponse) {}
+}

package/schema/.snootobuf/deps/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/events.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payorders.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/payorders/v1/order.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-orders/orders-api/api/xpaymentsplatform/payorderspb/v1;payorderspb";
+
+// OrderStatusUpdateEvent is a notification about updated order status
+message OrderStatusUpdateEvent {
+  Order order = 1;
+  OrderStatus previous_status = 2;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/reddit/xpaymentsplatform/payorders/v1/order.proto

@@ -0,0 +1,80 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payorders.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/paycommon/v1/order_status_reason.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-orders/orders-api/api/xpaymentsplatform/payorderspb/v1;payorderspb";
+
+enum OrderStatus {
+  ORDER_STATUS_UNSPECIFIED = 0;
+
+  NEW = 1;
+  CREATED = 2;
+  PAID = 3;
+  DELIVERED = 4; // One-time purchase delivered or subscription expired after being active.
+  CANCELED = 5; // [Before payment] Reddit decides to cancel a checkout before it was paid.
+  REVERTED = 6; // [After payment] Refund, chargeback.
+  ACTIVE = 7; // [Subscriptions only] Subscription is active.
+}
+
+enum StatusReason {
+  option deprecated = true; // Use pay-common's StatusReason instead
+  STATUS_REASON_UNSPECIFIED = 0;
+
+  REFUND_REDDIT_ADMIN = 1;
+  REFUND_PAYMENT_PLATFORM_INTERNAL = 2;
+  REFUND_PRODUCT_OWNER = 3;
+
+  CHARGEBACK = 4;
+
+  EXPIRED_INTERNAL_ERROR = 5;
+  EXPIRED_NOT_PAID = 6;
+  EXPIRED_NOT_DELIVERED = 7;
+
+  ECON_BLOCKER_VALIDATION_FAILED = 8;
+}
+
+enum OrderType {
+  ORDER_TYPE_UNSPECIFIED = 0;
+  ONE_TIME = 1;
+  SUBSCRIPTION = 2;
+}
+
+message Order {
+  string id = 1;
+  OrderStatus status = 2;
+  OrderType type = 12;
+  google.protobuf.Timestamp created_at = 3;
+  google.protobuf.Timestamp updated_at = 4;
+
+  repeated CartItem cart_items = 5;
+
+  CheckoutAction checkout_action = 6; // Each order has only one checkout possible
+  optional StatusReason old_status_reason = 7 [deprecated = true]; // Set only if status == CANCELED or REVERTED
+  optional reddit.xpaymentsplatform.paycommon.v1.StatusReason status_reason = 13; // Set only if status == CANCELED or REVERTED
+
+  reddit.xpaymentsplatform.payproducts.v1.Environment env = 8;
+  string seller_id = 9;
+  string buyer_id = 10;
+  map<string, string> metadata = 11;
+}
+
+message CheckoutAction {
+  reddit.xpaymentsplatform.paypayments.v1.PaymentMode mode = 1;
+  reddit.xpaymentsplatform.payproducts.v1.PaymentProvider payment_provider = 2;
+  string client_token = 3;
+}
+
+message ProductCheckoutMetadata {
+  bool is_anonymous = 1; // If the true, buyer info can't be shown to the seller.
+  string raw_client_metadata = 100; // The raw metadata sent by the client. Payment Platform will not interpret it.
+}
+
+message CartItem {
+  reddit.xpaymentsplatform.payproducts.v1.Product product = 1;
+  ProductCheckoutMetadata product_checkout_metadata = 2;
+}

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

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payorders.v1;
+
+option go_package = "github.snooguts.net/reddit/reddit-service-pay-orders/orders-api/api/xpaymentsplatform/payorderspb/v1;payorderspb";
+
+message DeleteUsersDataRequest {
+  string requester_id = 1;
+  repeated string user_ids = 2;
+}
+
+message DeleteUsersDataResponse {
+  repeated string user_ids = 1;
+}
+
+service DataComplianceService {
+  rpc DeleteUsersData(DeleteUsersDataRequest) returns (DeleteUsersDataResponse) {}
+}

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

@@ -0,0 +1,168 @@
+syntax = "proto3";
+
+package reddit.xpaymentsplatform.payorders.v1;
+
+import "google/protobuf/timestamp.proto";
+import "reddit/xpaymentsplatform/paycommon/v1/order_status_reason.proto";
+import "reddit/xpaymentsplatform/payorders/v1/order.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-orders/orders-api/api/xpaymentsplatform/payorderspb/v1;payorderspb";
+
+message GetOrderRequest {
+  string order_id = 1;
+}
+
+message GetOrderResponse {
+  Order order = 1;
+}
+
+message GetOrdersRequest {
+  repeated string order_ids = 1; // the order ids filter
+  string seller_id = 2; // t2_id of the app account
+  string buyer_id = 3; // t2_id of the buyer
+  google.protobuf.Timestamp created_at_start = 4; // the start of the time range
+  google.protobuf.Timestamp created_at_end = 5; // the end of the time range
+  OrderStatus status = 6; // the status filter of the order
+  map<string, string> checkout_metadata = 7; // the metadata filter of the order
+  reddit.xpaymentsplatform.payproducts.v1.Environment env = 8; // the environment filter of the order
+  PageInfo page_info = 20;
+}
+
+message GetOrdersResponse {
+  repeated Order orders = 1;
+  PageInfo next_page = 2;
+}
+
+// Required to support pagination of GetOrders.
+message PageInfo {
+  string start_cursor = 1; // if empty, start from the most recent transaction
+  int32 page_size = 2;
+  bool has_next_page = 3;
+}
+
+message CreateOrderRequest {
+  // Optional ID for a new order if client wants to use its own,
+  // otherwise new UUID will be generated and lower-case string representation will
+  // be used as an order ID.
+  // If order with provided ID already exists, check if:
+  // - buyerID is present, and it matches the one in the order
+  // - products are present, and they match the ones in the order
+  // return the stored order if all checks are positive. == Implementation of Order Idempotency
+  string order_id = 1;
+
+  string buyer_id = 2; // t2_Id
+
+  // It can only be [NEW, PAID]
+  // [NEW]: a new order is being created. It will require a payment
+  // [PAID]: a new order is being created. It will not require a payment
+  OrderStatus status = 3;
+
+  repeated CartItem cart_items = 4;
+
+  reddit.xpaymentsplatform.payproducts.v1.Environment env = 5;
+  // [P3] The order will expire at the given time
+  // required google.protobuf.Timestamp expiresAt = 4;
+
+  // User-scoped (buyer_id) idempotency key to provide instead of order_id if
+  // client wants to get server-generated order ID.
+  string reference_id = 6;
+}
+
+message MigrateOrdersRequest {
+  repeated MigrationOrder orders = 1;
+}
+
+message MigrationOrder {
+  string order_id = 1;
+  string buyer_id = 2;
+  OrderStatus status = 3;
+  repeated CartItem cart_items = 4;
+  reddit.xpaymentsplatform.payproducts.v1.Environment env = 5;
+  string reference_id = 6;
+  google.protobuf.Timestamp created_at = 7;
+}
+
+message MigrateOrdersResponse {}
+
+message CreateOrderResponse {
+  Order order = 1;
+}
+
+message UpdateOrderRequest {
+  string order_id = 1;
+
+  // The new status of the order. Check the state machine for allowed transitions
+  OrderStatus status = 2;
+
+  // Type of the order determined during the checkout. Can be set only for NEW orders
+  OrderType type = 6;
+
+  CheckoutAction checkout_action = 3;
+  optional StatusReason old_reason = 4;
+  optional reddit.xpaymentsplatform.paycommon.v1.StatusReason reason = 7;
+  repeated CartItem cart_items = 5;
+
+  RecurringState recurring_state = 8;
+}
+
+message RecurringState {
+  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;
+}
+
+message UpdateOrderResponse {
+  Order order = 1;
+}
+
+message AcknowledgeOrderDeliveryRequest {
+  string order_id = 1;
+}
+
+message AcknowledgeOrderDeliveryResponse {}
+
+message GetOrdersByUserRequest {
+  string user_id = 1;
+  optional int32 limit = 2;
+  bool is_seller = 3;
+}
+
+message GetOrdersByUserResponse {
+  repeated Order orders = 1;
+}
+
+message TransferOrderRequest {
+  string order_id = 1;
+  payproducts.v1.Environment environment = 2;
+  string from_user_id = 3;
+  string to_user_id = 4;
+}
+
+message TransferOrderResponse {
+  Order order = 1;
+}
+
+service PayOrdersService {
+  // Same as public APIs
+  rpc GetOrder(GetOrderRequest) returns (GetOrderResponse) {}
+
+  rpc GetOrders(GetOrdersRequest) returns (GetOrdersResponse) {}
+
+  rpc CreateOrder(CreateOrderRequest) returns (CreateOrderResponse) {}
+
+  rpc MigrateOrders(MigrateOrdersRequest) returns (MigrateOrdersResponse) {}
+
+  // The update will be executed only if the update complies with the state machine
+  rpc UpdateOrder(UpdateOrderRequest) returns (UpdateOrderResponse) {}
+
+  rpc AcknowledgeOrderDelivery(AcknowledgeOrderDeliveryRequest) returns (AcknowledgeOrderDeliveryResponse) {}
+
+  // should only be used by admin panel
+  rpc GetOrdersByUser(GetOrdersByUserRequest) returns (GetOrdersByUserResponse) {}
+  // TransferOrder transfers an order between users.
+  rpc TransferOrder(TransferOrderRequest) returns (TransferOrderResponse) {}
+}

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

@@ -0,0 +1,44 @@
+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 GetUserDataRequest {
+  string user_id = 1;
+}
+
+message Account {
+  string id = 1;
+  string owner_id = 2;
+  string currency = 3;
+  int64 balance = 4;
+  repeated Transaction transactions = 5;
+  google.protobuf.Timestamp created_at = 6;
+}
+
+message Transaction {
+  string order_id = 1;
+  string product_id = 2;
+  string product_type = 3;
+  string currency = 4;
+  int64 amount = 5;
+  reddit.xpaymentsplatform.paypayments.v1.PaymentUnitStatus status = 6;
+  reddit.xpaymentsplatform.payproducts.v1.PaymentProvider provider = 7;
+  string from_user_id = 8;
+  string to_user_id = 9;
+  string external_payment_id = 10;
+  google.protobuf.Timestamp timestamp = 11;
+}
+
+message GetUserDataResponse {
+  repeated Account accounts = 1;
+}
+
+service AdminService {
+  rpc GetUserData(GetUserDataRequest) returns (GetUserDataResponse) {}
+}