Merge pull request #133 from topcoder-platform/engagements

Updates to allow Task managers to create payments -> dev

Author: jmgasper

.circleci/config.yml

@@ -74,6 +74,7 @@ workflows:
                       branches:
                           only:
                               - dev
+                              - engagements
             - 'build-prod':
                   context: org-global
                   filters:

README.md

@@ -311,6 +311,7 @@ The API uses role-based access control with the following roles:
 - `User` - Regular authenticated users (withdrawals, view own data)
 - `PaymentAdmin` - Full administrative access
 - `PaymentEditor` - Edit payments and winnings
+- `TaskManager` - Create and manage engagement winnings
 - `PaymentViewer` - Read-only access to payment data
 - `M2M` - Machine-to-machine service access
 

docs/ARCHITECTURE.md

@@ -107,7 +107,7 @@ Controllers handle HTTP requests and route them to appropriate services:
 
 - User winnings CRUD operations
 - View personal winnings history
-- Requires: `User` role
+- Requires: `User` role for member endpoints; create winnings requires `PaymentAdmin`, `PaymentEditor`, or `TaskManager` roles
 
 **WithdrawalController** (`/v5/finance/withdraw`)
 
@@ -217,6 +217,7 @@ Controllers handle HTTP requests and route them to appropriate services:
 - `RolesGuard` - Role-based access control
 - `TokenValidatorMiddleware` - Token parsing and extraction
 - Supports both user JWT and M2M tokens
+- Roles include `User`, `PaymentAdmin`, `PaymentEditor`, `PaymentViewer`, and `TaskManager`
 
 **Request Context**
 

prisma/schema.prisma

@@ -312,6 +312,7 @@ enum winnings_category {
   CONTENT_CREATION_PAYMENT
   DIGITAL_RUN_V2_PAYMENT_TAXABLE
   DIGITAL_RUN_V2_TOP_PERFORMERS_PAYMENT_TAXABLE
+  ENGAGEMENT_PAYMENT
   CONTEST_CHECKPOINT_PAYMENT
   CONTEST_PAYMENT
   MARATHON_MATCH_NON_TAXABLE_PAYMENT
@@ -329,5 +330,6 @@ enum winnings_category {
 enum winnings_type {
   PAYMENT
   REWARD
+  ENGAGEMENT
   POINTS
 }

src/api/winnings/winnings.controller.ts

@@ -30,10 +30,11 @@ export class WinningsController {
 
   @Post()
   @AllowedM2mScope(M2mScope.CreatePayments)
-  @Roles(Role.PaymentAdmin, Role.PaymentEditor)
+  @Roles(Role.PaymentAdmin, Role.PaymentEditor, Role.TaskManager)
   @ApiOperation({
     summary: 'Create winning with payments.',
-    description: 'User must have "create:payments" scope to access.',
+    description:
+      'User must have "create:payments" scope or Payment Admin, Payment Editor, or Task Manager role to access.',
   })
   @ApiBody({
     description: 'Winning request body',

src/core/auth/auth.constants.ts

@@ -2,6 +2,7 @@ export enum Role {
   PaymentAdmin = 'Payment Admin',
   PaymentEditor = 'Payment Editor',
   PaymentViewer = 'Payment Viewer',
+  TaskManager = 'Task Manager',
   User = 'Topcoder User',
 }
 

src/dto/winning.dto.ts

@@ -20,6 +20,7 @@ import {
 
 export enum WinningsType {
   PAYMENT = 'PAYMENT',
+  ENGAGEMENT = 'ENGAGEMENT',
   POINTS = 'POINTS',
 }
 
@@ -85,6 +86,7 @@ export enum WinningsCategory {
   CONTENT_CREATION_PAYMENT = 'CONTENT_CREATION_PAYMENT',
   DIGITAL_RUN_V2_PAYMENT_TAXABLE = 'DIGITAL_RUN_V2_PAYMENT_TAXABLE',
   DIGITAL_RUN_V2_TOP_PERFORMERS_PAYMENT_TAXABLE = 'DIGITAL_RUN_V2_TOP_PERFORMERS_PAYMENT_TAXABLE',
+  ENGAGEMENT_PAYMENT = 'ENGAGEMENT_PAYMENT',
   CONTEST_CHECKPOINT_PAYMENT = 'CONTEST_CHECKPOINT_PAYMENT',
   CONTEST_PAYMENT = 'CONTEST_PAYMENT',
   MARATHON_MATCH_NON_TAXABLE_PAYMENT = 'MARATHON_MATCH_NON_TAXABLE_PAYMENT',