protobuf-platform 1.2.556 → 1.2.557

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "protobuf-platform",
-  "version": "1.2.556",
+  "version": "1.2.557",
   "description": "Protobuf structures",
   "main": "index.js",
   "scripts": {

package/user/user.proto

@@ -176,6 +176,19 @@ service User {
     rpc getUserLastPlayedGames(PaginationRequest) returns (UserGameIdsResponse);
     rpc getUserFavouriteGameIdsByGameIds(UserGameIdsFilterRequest) returns (UserGameIdsFilterResponse);
     rpc getUserLastPlayedGameIdsByGameIds(UserGameIdsFilterRequest) returns (UserGameIdsFilterResponse);
+    //Responsible Gaming
+    // Creates a new policy version for the resolved replacement scope; not a generic upsert by user_id + policy_type.
+    rpc setResponsibleGamingPolicy(SetResponsibleGamingPolicyRequest) returns (ResponsibleGamingPolicyItem);
+    // Disables the concrete policy identified by policy_id.
+    rpc disableResponsibleGamingPolicy(DisableResponsibleGamingPolicyRequest) returns (ResponsibleGamingPolicyItem);
+    rpc readResponsibleGamingOverview(ReadResponsibleGamingOverviewRequest) returns (ResponsibleGamingOverviewResponse);
+    rpc readResponsibleGamingPolicyHistory(ReadResponsibleGamingPolicyHistoryRequest) returns (ReadResponsibleGamingPolicyHistoryResponse);
+    rpc evaluateResponsibleGamingDecision(EvaluateResponsibleGamingDecisionRequest) returns (EvaluateResponsibleGamingDecisionResponse);
+    rpc reserveResponsibleGamingDeposit(ReserveResponsibleGamingDepositRequest) returns (ReserveResponsibleGamingDepositResponse);
+    rpc finalizeResponsibleGamingDepositReservation(FinalizeResponsibleGamingDepositReservationRequest) returns (FinalizeResponsibleGamingDepositReservationResponse);
+    rpc reserveResponsibleGamingLossExposure(ReserveResponsibleGamingLossExposureRequest) returns (ReserveResponsibleGamingLossExposureResponse);
+    rpc finalizeResponsibleGamingLossExposure(FinalizeResponsibleGamingLossExposureRequest) returns (FinalizeResponsibleGamingLossExposureResponse);
+    rpc updateResponsibleGamingTimeUsage(UpdateResponsibleGamingTimeUsageRequest) returns (UpdateResponsibleGamingTimeUsageResponse);
 }
 //Technical
 message PingRequest { string ping = 1; }
@@ -1922,4 +1935,410 @@ message UserGameIdsFilterRequest {
 
 message UserGameIdsFilterResponse {
   repeated int32 game_ids = 1;
+}
+//Responsible Gaming
+//
+// Policy replacement scope (identity):
+// - DEPOSIT_LIMIT, LOSS_LIMIT, TIME_LIMIT: user_id + policy_type + recurring_period.
+//   Different recurring_period values coexist independently for the same user
+//   (e.g. DEPOSIT_LIMIT/DAY, DEPOSIT_LIMIT/WEEK, DEPOSIT_LIMIT/MONTH).
+//   Updating one period replaces/versions only that scope; other periods are unaffected.
+// - COOLING_OFF, SELF_EXCLUSION: user_id + policy_type (one active scope per type per user).
+//   Duration enums configure the policy version; they are not a coexistence dimension.
+//
+// Version lifecycle per scope: created_at, effective_at, ended_at, deleted_at.
+// A future effective_at represents a delayed/pending version; no separate ACTIVE/PENDING state.
+enum ResponsibleGamingPolicyType {
+    RESPONSIBLE_GAMING_POLICY_TYPE_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_POLICY_TYPE_DEPOSIT_LIMIT = 1;
+    RESPONSIBLE_GAMING_POLICY_TYPE_LOSS_LIMIT = 2;
+    RESPONSIBLE_GAMING_POLICY_TYPE_TIME_LIMIT = 3;
+    RESPONSIBLE_GAMING_POLICY_TYPE_COOLING_OFF = 4;
+    RESPONSIBLE_GAMING_POLICY_TYPE_SELF_EXCLUSION = 5;
+}
+// Identity dimension for DEPOSIT_LIMIT, LOSS_LIMIT, and TIME_LIMIT replacement scope.
+enum ResponsibleGamingRecurringPeriod {
+    RESPONSIBLE_GAMING_RECURRING_PERIOD_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_RECURRING_PERIOD_DAY = 1;
+    RESPONSIBLE_GAMING_RECURRING_PERIOD_WEEK = 2;
+    RESPONSIBLE_GAMING_RECURRING_PERIOD_MONTH = 3;
+}
+// Policy-version configuration for COOLING_OFF; not part of replacement scope identity.
+enum ResponsibleGamingCoolingOffDuration {
+    RESPONSIBLE_GAMING_COOLING_OFF_DURATION_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_COOLING_OFF_DURATION_24_HOURS = 1;
+    RESPONSIBLE_GAMING_COOLING_OFF_DURATION_7_DAYS = 2;
+    RESPONSIBLE_GAMING_COOLING_OFF_DURATION_1_MONTH = 3;
+    RESPONSIBLE_GAMING_COOLING_OFF_DURATION_3_MONTHS = 4;
+}
+// Policy-version configuration for SELF_EXCLUSION; not part of replacement scope identity.
+enum ResponsibleGamingSelfExclusionDuration {
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_7_DAYS = 1;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_1_MONTH = 2;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_3_MONTHS = 3;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_6_MONTHS = 4;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_9_MONTHS = 5;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_12_MONTHS = 6;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_1_YEAR = 7;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_2_YEARS = 8;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_3_YEARS = 9;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_4_YEARS = 10;
+    RESPONSIBLE_GAMING_SELF_EXCLUSION_DURATION_5_YEARS = 11;
+}
+enum ResponsibleGamingOperation {
+    RESPONSIBLE_GAMING_OPERATION_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_OPERATION_LOGIN = 1;
+    RESPONSIBLE_GAMING_OPERATION_DEPOSIT = 2;
+    RESPONSIBLE_GAMING_OPERATION_GAME_LAUNCH = 3;
+    RESPONSIBLE_GAMING_OPERATION_STAKE = 4;
+    RESPONSIBLE_GAMING_OPERATION_BONUS_ACTIVATION = 5;
+    RESPONSIBLE_GAMING_OPERATION_PROMO_CODE_ACTIVATION = 6;
+    RESPONSIBLE_GAMING_OPERATION_FREE_SPIN_ACTIVATION = 7;
+    RESPONSIBLE_GAMING_OPERATION_TOURNAMENT_JOIN = 8;
+    RESPONSIBLE_GAMING_OPERATION_WITHDRAWAL = 9;
+    RESPONSIBLE_GAMING_OPERATION_SETTLEMENT = 10;
+    RESPONSIBLE_GAMING_OPERATION_WIN_CREDIT = 11;
+    RESPONSIBLE_GAMING_OPERATION_REFUND = 12;
+}
+// Derived view of a policy version within its replacement scope; not a separate state machine.
+enum ResponsibleGamingPolicyRecordStatus {
+    RESPONSIBLE_GAMING_POLICY_RECORD_STATUS_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_POLICY_RECORD_STATUS_CURRENT = 1; // Effective now for its scope (effective_at <= now, not ended/deleted).
+    RESPONSIBLE_GAMING_POLICY_RECORD_STATUS_FUTURE = 2; // Delayed/pending version (effective_at > now).
+    RESPONSIBLE_GAMING_POLICY_RECORD_STATUS_ENDED = 3;
+    RESPONSIBLE_GAMING_POLICY_RECORD_STATUS_DELETED = 4;
+}
+enum ResponsibleGamingDepositReservationStatus {
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_STATUS_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_STATUS_RESERVED = 1;
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_STATUS_COMMITTED = 2;
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_STATUS_RELEASED = 3;
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_STATUS_RECONCILED = 4;
+}
+enum ResponsibleGamingDepositReservationOutcome {
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_OUTCOME_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_OUTCOME_RELEASE = 1;
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_OUTCOME_COMMIT = 2;
+    RESPONSIBLE_GAMING_DEPOSIT_RESERVATION_OUTCOME_RECONCILE = 3;
+}
+enum ResponsibleGamingLossExposureStatus {
+    RESPONSIBLE_GAMING_LOSS_EXPOSURE_STATUS_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_LOSS_EXPOSURE_STATUS_OPEN = 1;
+    RESPONSIBLE_GAMING_LOSS_EXPOSURE_STATUS_COMMITTED = 2;
+    RESPONSIBLE_GAMING_LOSS_EXPOSURE_STATUS_RELEASED = 3;
+}
+enum ResponsibleGamingLossExposureOutcome {
+    RESPONSIBLE_GAMING_LOSS_EXPOSURE_OUTCOME_UNSPECIFIED = 0;
+    RESPONSIBLE_GAMING_LOSS_EXPOSURE_OUTCOME_RELEASE = 1;
+    RESPONSIBLE_GAMING_LOSS_EXPOSURE_OUTCOME_COMMIT = 2;
+}
+// One versioned policy record. Scope identity: user_id + policy_type (+ recurring_period for limit types).
+message ResponsibleGamingPolicyItem {
+    string policy_id = 1;
+    int32 user_id = 2;
+    ResponsibleGamingPolicyType policy_type = 3;
+    optional ResponsibleGamingRecurringPeriod recurring_period = 4; // Required for limit types; part of replacement scope.
+    optional ResponsibleGamingCoolingOffDuration cooling_off_duration = 5; // Version config for COOLING_OFF only.
+    optional ResponsibleGamingSelfExclusionDuration self_exclusion_duration = 6; // Version config for SELF_EXCLUSION only.
+    optional int64 amount_minor = 7;
+    optional string currency = 8;
+    optional int32 currency_scale = 9;
+    optional int64 time_limit_seconds = 10;
+    optional string created_at = 11;
+    optional string effective_at = 12; // Future value denotes a delayed/pending version for this scope.
+    optional string ended_at = 13;
+    optional string deleted_at = 14;
+    optional string predecessor_policy_id = 15; // Prior version within the same replacement scope.
+    optional string replaced_by_policy_id = 16; // Successor version within the same replacement scope.
+}
+// Creates a new version for the scope resolved from user_id, policy_type, and (for limit types) recurring_period.
+message SetResponsibleGamingPolicyRequest {
+    int32 user_id = 1;
+    ResponsibleGamingPolicyType policy_type = 2;
+    optional ResponsibleGamingRecurringPeriod recurring_period = 3;
+    optional ResponsibleGamingCoolingOffDuration cooling_off_duration = 4;
+    optional ResponsibleGamingSelfExclusionDuration self_exclusion_duration = 5;
+    optional int64 amount_minor = 6;
+    optional string currency = 7;
+    optional int32 currency_scale = 8;
+    optional int64 time_limit_seconds = 9;
+    optional string effective_at = 10;
+}
+// Disables the policy version identified by policy_id (not by replacement scope).
+message DisableResponsibleGamingPolicyRequest {
+    int32 user_id = 1;
+    string policy_id = 2;
+    optional string ended_at = 3;
+}
+message ReadResponsibleGamingOverviewRequest {
+    int32 user_id = 1;
+    optional string currency = 2;
+    optional int32 currency_scale = 3;
+}
+message ResponsibleGamingDepositLimitOverview {
+    bool configured = 1;
+    optional ResponsibleGamingPolicyItem current_policy = 2;
+    optional ResponsibleGamingPolicyItem pending_policy = 3;
+    optional string current_window_start = 4;
+    optional string current_window_end = 5;
+    optional int64 used_minor = 6;
+    optional int64 reserved_minor = 7;
+    optional int64 remaining_minor = 8;
+    bool limit_reached = 9;
+}
+message ResponsibleGamingLossLimitOverview {
+    bool configured = 1;
+    optional ResponsibleGamingPolicyItem current_policy = 2;
+    optional ResponsibleGamingPolicyItem pending_policy = 3;
+    optional string current_window_start = 4;
+    optional string current_window_end = 5;
+    optional int64 stakes_minor = 6;
+    optional int64 wins_minor = 7;
+    optional int64 refunds_minor = 8;
+    optional int64 net_loss_minor = 9;
+    optional int64 reserved_exposure_minor = 10;
+    optional int64 effective_risk_minor = 11;
+    optional int64 remaining_stake_minor = 12;
+    bool limit_reached = 13;
+}
+message ResponsibleGamingTimeLimitOverview {
+    bool configured = 1;
+    optional ResponsibleGamingPolicyItem current_policy = 2;
+    optional ResponsibleGamingPolicyItem pending_policy = 3;
+    optional string current_window_start = 4;
+    optional string current_window_end = 5;
+    optional int64 used_seconds = 6;
+    optional int64 remaining_seconds = 7;
+    bool active_gameplay_session = 8;
+    optional string active_session_id = 9;
+    optional string last_activity_at = 10;
+    bool limit_reached = 11;
+}
+message ResponsibleGamingCoolingOffOverview {
+    bool active = 1;
+    bool configured = 2;
+    optional ResponsibleGamingPolicyItem current_policy = 3;
+    optional string effective_at = 4;
+    optional string expires_at = 5;
+    optional int64 remaining_seconds = 6;
+}
+message ResponsibleGamingSelfExclusionOverview {
+    bool active = 1;
+    bool blocking = 2;
+    optional ResponsibleGamingPolicyItem current_policy = 3;
+    optional string effective_at = 4;
+    optional string minimum_end_at = 5;
+    bool minimum_period_ended = 6;
+    bool reactivation_required = 7;
+}
+message ResponsibleGamingOverviewResponse {
+    int32 user_id = 1;
+    ResponsibleGamingDepositLimitOverview deposit_limit = 2;
+    ResponsibleGamingLossLimitOverview loss_limit = 3;
+    ResponsibleGamingTimeLimitOverview time_limit = 4;
+    ResponsibleGamingCoolingOffOverview cooling_off = 5;
+    ResponsibleGamingSelfExclusionOverview self_exclusion = 6;
+}
+message ReadResponsibleGamingPolicyHistoryRequest {
+    int32 user_id = 1;
+    optional ResponsibleGamingPolicyType policy_type = 2;
+    optional int32 limit = 3;
+    optional int32 offset = 4;
+}
+message ResponsibleGamingPolicyHistoryRecord {
+    ResponsibleGamingPolicyItem policy = 1;
+    ResponsibleGamingPolicyRecordStatus record_status = 2;
+    optional int32 version = 3;
+}
+message ReadResponsibleGamingPolicyHistoryResponse {
+    repeated ResponsibleGamingPolicyHistoryRecord items = 1;
+    optional int32 total_items = 2;
+}
+message ResponsibleGamingDepositLimitDecisionDetail {
+    bool configured = 1;
+    bool limit_reached = 2;
+    optional int64 used_minor = 3;
+    optional int64 reserved_minor = 4;
+    optional int64 remaining_minor = 5;
+    optional int64 requested_amount_minor = 6;
+    optional string current_window_start = 7;
+    optional string current_window_end = 8;
+}
+message ResponsibleGamingLossLimitDecisionDetail {
+    bool configured = 1;
+    bool limit_reached = 2;
+    optional int64 stakes_minor = 3;
+    optional int64 wins_minor = 4;
+    optional int64 refunds_minor = 5;
+    optional int64 net_loss_minor = 6;
+    optional int64 reserved_exposure_minor = 7;
+    optional int64 effective_risk_minor = 8;
+    optional int64 remaining_stake_minor = 9;
+    optional int64 requested_stake_minor = 10;
+    optional string current_window_start = 11;
+    optional string current_window_end = 12;
+}
+message ResponsibleGamingTimeLimitDecisionDetail {
+    bool configured = 1;
+    bool limit_reached = 2;
+    optional int64 used_seconds = 3;
+    optional int64 remaining_seconds = 4;
+    optional int64 delta_seconds = 5;
+    bool active_gameplay_session = 6;
+    optional string active_session_id = 7;
+    optional string last_activity_at = 8;
+    optional string current_window_start = 9;
+    optional string current_window_end = 10;
+}
+message ResponsibleGamingCoolingOffDecisionDetail {
+    bool active = 1;
+    bool configured = 2;
+    optional string effective_at = 3;
+    optional string expires_at = 4;
+    optional int64 remaining_seconds = 5;
+}
+message ResponsibleGamingSelfExclusionDecisionDetail {
+    bool active = 1;
+    bool blocking = 2;
+    optional string effective_at = 3;
+    optional string minimum_end_at = 4;
+    bool minimum_period_ended = 5;
+    bool reactivation_required = 6;
+}
+message ResponsibleGamingDecisionDetails {
+    optional ResponsibleGamingDepositLimitDecisionDetail deposit_limit = 1;
+    optional ResponsibleGamingLossLimitDecisionDetail loss_limit = 2;
+    optional ResponsibleGamingTimeLimitDecisionDetail time_limit = 3;
+    optional ResponsibleGamingCoolingOffDecisionDetail cooling_off = 4;
+    optional ResponsibleGamingSelfExclusionDecisionDetail self_exclusion = 5;
+}
+message EvaluateResponsibleGamingDecisionRequest {
+    int32 user_id = 1;
+    ResponsibleGamingOperation operation = 2;
+    optional string decision_at = 3;
+    optional string currency = 4;
+    optional int32 currency_scale = 5;
+    optional int64 requested_amount_minor = 6;
+    optional string operation_key = 7;
+    optional string session_id = 8;
+    optional string provider_transaction_id = 9;
+    optional string round_id = 10;
+    optional string balance_type = 11;
+}
+message EvaluateResponsibleGamingDecisionResponse {
+    bool allowed = 1;
+    optional string reason_key = 2;
+    optional ResponsibleGamingPolicyType blocking_policy_type = 3;
+    optional string blocking_policy_id = 4;
+    optional string decision_at = 5;
+    optional ResponsibleGamingDecisionDetails details = 6;
+}
+message ReserveResponsibleGamingDepositRequest {
+    int32 user_id = 1;
+    string operation_key = 2;
+    int64 requested_amount_minor = 3;
+    string currency = 4;
+    int32 currency_scale = 5;
+    optional string policy_id = 6;
+    optional string reservation_at = 7;
+}
+message ReserveResponsibleGamingDepositResponse {
+    bool allowed = 1;
+    optional string reason_key = 2;
+    optional string reservation_id = 3;
+    optional string policy_id = 4;
+    optional int64 requested_amount_minor = 5;
+    optional int64 reserved_amount_minor = 6;
+    optional string currency = 7;
+    optional int32 currency_scale = 8;
+    ResponsibleGamingDepositReservationStatus status = 9;
+    optional string operation_key = 10;
+    optional ResponsibleGamingDecisionDetails decision_details = 11;
+}
+message FinalizeResponsibleGamingDepositReservationRequest {
+    int32 user_id = 1;
+    string operation_key = 2;
+    optional string reservation_id = 3;
+    ResponsibleGamingDepositReservationOutcome outcome = 4;
+    optional int64 actual_amount_minor = 5;
+    optional string finalized_at = 6;
+}
+message FinalizeResponsibleGamingDepositReservationResponse {
+    string reservation_id = 1;
+    ResponsibleGamingDepositReservationStatus status = 2;
+    optional int64 requested_amount_minor = 3;
+    optional int64 committed_amount_minor = 4;
+    optional string currency = 5;
+    optional int32 currency_scale = 6;
+    string operation_key = 7;
+    optional string policy_id = 8;
+}
+message ReserveResponsibleGamingLossExposureRequest {
+    int32 user_id = 1;
+    string operation_key = 2;
+    int64 requested_stake_minor = 3;
+    string currency = 4;
+    int32 currency_scale = 5;
+    optional string session_id = 6;
+    optional string round_id = 7;
+    optional string provider_transaction_id = 8;
+    optional string balance_type = 9;
+    optional string reservation_at = 10;
+}
+message ReserveResponsibleGamingLossExposureResponse {
+    bool allowed = 1;
+    optional string reason_key = 2;
+    optional string exposure_id = 3;
+    optional string policy_id = 4;
+    optional int64 requested_stake_minor = 5;
+    optional int64 net_loss_minor = 6;
+    optional int64 reserved_exposure_minor = 7;
+    optional int64 remaining_stake_minor = 8;
+    optional string currency = 9;
+    optional int32 currency_scale = 10;
+    ResponsibleGamingLossExposureStatus status = 11;
+    optional string operation_key = 12;
+    optional ResponsibleGamingDecisionDetails decision_details = 13;
+}
+message FinalizeResponsibleGamingLossExposureRequest {
+    int32 user_id = 1;
+    string operation_key = 2;
+    optional string exposure_id = 3;
+    ResponsibleGamingLossExposureOutcome outcome = 4;
+    optional int64 actual_stake_minor = 5;
+    optional int64 net_loss_delta_minor = 6;
+    optional string finalized_at = 7;
+}
+message FinalizeResponsibleGamingLossExposureResponse {
+    string exposure_id = 1;
+    ResponsibleGamingLossExposureStatus status = 2;
+    optional int64 requested_stake_minor = 3;
+    optional int64 committed_stake_minor = 4;
+    optional int64 net_loss_minor = 5;
+    optional int64 reserved_exposure_minor = 6;
+    optional int64 remaining_stake_minor = 7;
+    optional string currency = 8;
+    optional int32 currency_scale = 9;
+    string operation_key = 10;
+    optional string policy_id = 11;
+}
+message UpdateResponsibleGamingTimeUsageRequest {
+    int32 user_id = 1;
+    string session_id = 2;
+    optional string policy_id = 3;
+    optional string window_start = 4;
+    optional string last_activity_at = 5;
+    optional int64 delta_seconds = 6;
+    optional string activity_at = 7;
+}
+message UpdateResponsibleGamingTimeUsageResponse {
+    optional string session_id = 1;
+    optional string policy_id = 2;
+    optional string window_start = 3;
+    optional string window_end = 4;
+    optional int64 used_seconds = 5;
+    optional int64 remaining_seconds = 6;
+    optional string last_activity_at = 7;
+    bool limit_reached = 8;
 }