be-components 7.4.7 → 7.5.1

package/lib/module/BetRouter/types/api-contracts.js

@@ -0,0 +1,770 @@
+// API Contracts - All API endpoints with their request/response types
+// This is the SINGLE SOURCE OF TRUTH for API types
+// Copy the entire src/types folder to your client project
+
+// Auto-linking types
+
+// Base response types
+
+// API Contracts Definition
+export const ApiContracts = {
+  // ========== Opportunities Routes ==========
+  'POST /opportunities/opportunity/buy': {
+    auth: true,
+    body: {
+      buy_opportunity: {}
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /opportunities/open/me': {
+    auth: true,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /opportunities/past/me': {
+    auth: true,
+    query: {
+      from: 0,
+      // UNIX timestamp in milliseconds
+      to: 0,
+      // UNIX timestamp in milliseconds
+      offset: 0 // Pagination offset (0-based)
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /opportunities/reconcile': {
+    auth: false,
+    responses: {
+      200: {},
+      500: {}
+    }
+  },
+  // ========== Accounts Routes ==========
+  'POST /accounts/join': {
+    auth: true,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /accounts/leave': {
+    auth: true,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /accounts/me': {
+    auth: true,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /accounts/partners/me': {
+    auth: true,
+    query: {
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /accounts/partner/connect': {
+    auth: true,
+    body: {
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /accounts/partner/disconnect': {
+    auth: true,
+    body: {
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /accounts/partner/credentials/update': {
+    auth: true,
+    body: {
+      partner_id: '',
+      credentials: {}
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /accounts/partner/credentials/test': {
+    auth: true,
+    body: {
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /accounts/balance/update': {
+    auth: true,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /accounts/balance/me': {
+    auth: true,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  // ========== Partners Routes ==========
+  'GET /partners': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'POST /partners/load': {
+    auth: true,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  // ========== Leagues Routes ==========
+  'GET /leagues': {
+    auth: false,
+    query: {
+      status: ''
+    },
+    responses: {
+      200: {}
+    }
+  },
+  'GET /leagues/open': {
+    auth: false,
+    query: {
+      partner_ids: '' // Comma-separated partner IDs to filter by
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /leagues/link': {
+    auth: false,
+    body: {
+      raw_league_ids: '',
+      // Support both single string and array
+      router_league_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /leagues/load': {
+    auth: false,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /leagues/:router_league_id/available-raw/:partner_id': {
+    auth: false,
+    params: {
+      router_league_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /leagues/load-raw': {
+    auth: false,
+    body: {
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  // ========== Contests Routes ==========
+  'GET /contests/router': {
+    auth: false,
+    query: {
+      status: ''
+    },
+    responses: {
+      200: {}
+    }
+  },
+  'GET /contests/partner': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'GET /contests/auto-fill': {
+    auth: false,
+    responses: {
+      200: {},
+      500: {}
+    }
+  },
+  'GET /contests/open/:router_league_id': {
+    auth: false,
+    params: {
+      router_league_id: ''
+    },
+    query: {
+      status: 'open',
+      // Filter by status. Default: 'open'
+      offset: 0 // Pagination offset (only used with status='closed'). Max 100 results per page
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /contests/:router_contest_id': {
+    auth: false,
+    params: {
+      router_contest_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /contests/link': {
+    auth: false,
+    body: {
+      raw_contest_ids: [],
+      router_contest_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /contests/load': {
+    auth: false,
+    body: {
+      router_league_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /contests/load-raw': {
+    auth: false,
+    body: {
+      partner_id: '',
+      router_league_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /contests/check-status': {
+    auth: false,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'PATCH /contests/router/:router_contest_id': {
+    auth: false,
+    params: {
+      router_contest_id: ''
+    },
+    body: {},
+    responses: {
+      200: {},
+      400: {},
+      404: {}
+    },
+    notes: 'When setting auto_fill=false, all market_contests for this contest will also be disabled. When setting auto_fill=true, only the contest level is updated.'
+  },
+  'GET /contests/:router_contest_id/available-raw/:partner_id': {
+    auth: false,
+    params: {
+      router_contest_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  // ========== Participants Routes ==========
+  'GET /participants/router': {
+    auth: false,
+    query: {
+      router_league_id: '',
+      participant_type: '',
+      status: ''
+    },
+    responses: {
+      200: {}
+    }
+  },
+  'GET /participants/raw': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'GET /participants/partner': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'POST /participants/load': {
+    auth: false,
+    body: {
+      router_league_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /participants/load-raw': {
+    auth: false,
+    body: {
+      partner_id: '',
+      router_league_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /participants/link': {
+    auth: false,
+    body: {
+      raw_participant_ids: [],
+      router_participant_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /participants/:router_participant_id/available-raw/:partner_id/:router_league_id': {
+    auth: false,
+    params: {
+      router_participant_id: '',
+      partner_id: '',
+      router_league_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  // ========== Markets Routes ==========
+  'GET /markets/router': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'GET /markets/variables': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'GET /markets/sides': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'GET /markets/partner': {
+    auth: false,
+    responses: {
+      200: {}
+    }
+  },
+  'GET /markets/supported/:router_contest_id': {
+    auth: false,
+    params: {
+      router_contest_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /markets/available-to-support/:router_contest_id': {
+    auth: false,
+    params: {
+      router_contest_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /markets/supported': {
+    auth: false,
+    body: {
+      router_contest_id: '',
+      router_market_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'DELETE /markets/supported/:market_contest_id': {
+    auth: false,
+    params: {
+      market_contest_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /markets/:router_contest_id/:router_market_id/linking-data/:partner_id': {
+    auth: false,
+    params: {
+      router_contest_id: '',
+      router_market_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /markets/:router_contest_id/:router_market_id/variables-and-raw/:partner_id': {
+    auth: false,
+    params: {
+      router_contest_id: '',
+      router_market_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /markets/:router_contest_id/:router_market_id/available-raw/:partner_id': {
+    auth: false,
+    params: {
+      router_contest_id: '',
+      router_market_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /markets/load-raw': {
+    auth: false,
+    body: {
+      partner_id: '',
+      router_contest_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'GET /markets/raw/:router_contest_id': {
+    auth: false,
+    params: {
+      router_contest_id: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /markets/load': {
+    auth: false,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /markets/link': {
+    auth: false,
+    body: {
+      raw_market_id: '',
+      router_market_id: '',
+      market_side_id: '',
+      partner_participant_id: '',
+      timeframe_id: '',
+      variable: 0,
+      variable_type: '',
+      price_key: ''
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /markets/add-variable': {
+    auth: false,
+    body: {
+      router_contest_id: '',
+      router_market_id: '',
+      partner_id: '',
+      variable: 0
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'PATCH /markets/supported/:market_contest_id': {
+    auth: false,
+    params: {
+      market_contest_id: ''
+    },
+    body: {},
+    responses: {
+      200: {},
+      400: {},
+      404: {}
+    }
+  },
+  // ========== Liquidity Routes ==========
+  'GET /liquidity/contest/:router_contest_id': {
+    auth: false,
+    params: {
+      router_contest_id: ''
+    },
+    query: {
+      partner_ids: '',
+      // CSV of partner IDs (e.g., "partner1,partner2")
+      include_opportunities: '' // 'true' to include opportunities in response (default: false)
+    },
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  'POST /liquidity/generate-all': {
+    auth: false,
+    responses: {
+      200: {},
+      400: {}
+    }
+  },
+  // ========== Auto-Linking Routes ==========
+  'POST /autolinking/contests': {
+    auth: false,
+    body: {
+      router_league_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      500: {}
+    }
+  },
+  'POST /autolinking/participants': {
+    auth: false,
+    body: {
+      router_league_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      500: {}
+    }
+  },
+  'POST /autolinking/markets': {
+    auth: false,
+    body: {
+      router_league_id: '',
+      router_market_id: '',
+      partner_id: ''
+    },
+    responses: {
+      200: {},
+      500: {}
+    }
+  },
+  // ========== Config Routes ==========
+  'GET /config': {
+    auth: false,
+    responses: {
+      200: {},
+      500: {}
+    }
+  },
+  'GET /config/:config': {
+    auth: false,
+    params: {
+      config: ''
+    },
+    responses: {
+      200: {},
+      404: {},
+      500: {}
+    }
+  },
+  'GET /config/:config/value': {
+    auth: false,
+    params: {
+      config: ''
+    },
+    responses: {
+      200: {},
+      404: {},
+      500: {}
+    }
+  },
+  'POST /config': {
+    auth: false,
+    body: {
+      config: '',
+      value: '',
+      config_format: 'string'
+    },
+    responses: {
+      201: {},
+      400: {},
+      409: {},
+      500: {}
+    }
+  },
+  'PUT /config/:config': {
+    auth: false,
+    params: {
+      config: ''
+    },
+    body: {
+      value: '',
+      config_format: ''
+    },
+    responses: {
+      200: {},
+      400: {},
+      404: {},
+      500: {}
+    }
+  },
+  'DELETE /config/:config': {
+    auth: false,
+    params: {
+      config: ''
+    },
+    responses: {
+      200: {},
+      404: {},
+      500: {}
+    }
+  },
+  // ========== Jobs Routes ==========
+  'POST /jobs/create': {
+    auth: true,
+    body: {
+      job_key: '',
+      name: '',
+      description: '',
+      frequency: 0,
+      frequency_type: 'seconds'
+    },
+    responses: {
+      201: {},
+      400: {}
+    }
+  },
+  'PUT /jobs/update': {
+    auth: true,
+    body: {},
+    responses: {
+      200: {},
+      400: {},
+      404: {}
+    }
+  },
+  'POST /jobs/queue': {
+    auth: true,
+    body: {
+      job_key: ''
+    },
+    responses: {
+      200: {},
+      400: {},
+      404: {}
+    }
+  },
+  'GET /jobs': {
+    auth: true,
+    responses: {
+      200: {},
+      500: {}
+    }
+  },
+  'GET /jobs/:job_key': {
+    auth: true,
+    params: {
+      job_key: ''
+    },
+    responses: {
+      200: {},
+      404: {},
+      500: {}
+    }
+  },
+  'DELETE /jobs/:router_job_id': {
+    auth: true,
+    params: {
+      router_job_id: ''
+    },
+    responses: {
+      200: {},
+      404: {},
+      500: {}
+    }
+  },
+  'GET /jobs/statuses/recent': {
+    auth: true,
+    query: {
+      limit: 0,
+      // Default: 50
+      offset: 0 // Default: 0
+    },
+    responses: {
+      200: {},
+      500: {}
+    }
+  }
+};
+
+// Type helpers to extract types from contracts
+//# sourceMappingURL=api-contracts.js.map