diff --git a/engine/openapi.yml b/engine/openapi.yml new file mode 100644 index 0000000..ac23bb9 --- /dev/null +++ b/engine/openapi.yml @@ -0,0 +1,251 @@ +openapi: 3.0.3 +info: + title: Event Manager API + description: The documentation for Event Manager API + version: 1.0.0 + contact: + name: API Support + email: support@example.com + license: + name: MIT + url: https://opensource.org/licenses/MIT + +servers: + - url: http://localhost:5000 + description: Local development server + - url: http://www.simbrellang.net:5000 + description: Remote Temporary development server + - url: https://event-core.simbrellang.net + description: Remote development server + +paths: + /health: + get: + summary: Returns a health message + responses: + 200: + description: A successful response + /status-call: + post: + summary: Perform a status call + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + requestId: + type: string + example: "R02802" + countryCode: + type: string + example: "NGR" + transactionId: + type: string + example: "Tr201712RK9232P115" + debtId: + type: string + example: "173021" + transactionType: + type: string + example: "Disbursement" + customerId: + type: string + example: "CN621868" + responses: + 200: + description: A successful response + /sms: + post: + summary: Send a SMS + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + text: + type: string + example: "This is a test message for SMS request method." + dest: + type: string + example: "+2348039409144" + unicode: + type: boolean + example: false + responses: + 200: + description: A successful response + /bulk-sms: + post: + summary: Send a bulk SMS + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + properties: + text: + type: string + example: "This is a test message for SMS request method." + dest: + type: string + example: "+2348039409144" + unicode: + type: boolean + example: true + responses: + 200: + description: A successful response + /autocall/refresh-verify-disbursement: + get: + summary: Refresh the disbursement to verify + responses: + 200: + description: A successful response + /autocall/refresh-disbursement: + get: + summary: Refresh the disbursement + responses: + 200: + description: A successful response + /autocall/refresh-verify-collection: + get: + summary: Refresh the disbursement to verify + responses: + 200: + description: A successful response + /autocall/refresh-collection: + get: + summary: Refresh the disbursement + responses: + 200: + description: A successful response + /autocall/payment-callback: + get: + summary: The Payment callback + responses: + 200: + description: A successful response + /autocall/penal-charge: + post: + summary: Penal Charge Request + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + type: object + properties: + transactionId: + type: string + example: "T004" + fbnTransactionId: + type: string + example: "Tr201712RK9232P115" + debtId: + type: string + example: "273194670" + customerId: + type: string + example: "CN621868" + accountId: + type: string + example: "2017821799" + penalCharge: + type: number + example: "1.2" + lienAmount: + type: number + example: "101.2" + countryId: + type: string + example: "01" + comment: + type: string + example: "Testing PenalCharge" + responses: + 200: + description: A successful response + /autocall/analytic-salary-detect: + post: + summary: Salary Detect Endpoint + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + customerId: + type: string + example: "CN621868" + accountId: + type: string + example: "OP621868" + status: + type: string + salaryAmount: + type: number + example: 200000 + salaryDate: + type: string + example: "2025-01-01" + responses: + 200: + description: A successful response + + /autocall/report: + get: + summary: Generate and send a report + responses: + 200: + description: A successful response + /autocall/overdue-loans: + get: + summary: Get all overdue loans + responses: + 200: + description: A successful response + /autocall/direct/loan: + post: + summary: Direct call for loan disbursement + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + transactionId: + type: string + example: "TXN123456" + responses: + 200: + description: A successful response + /autocall/direct/repayment: + post: + summary: Direct call for loan repayment + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + transactionId: + type: string + example: "TXN123456" + + responses: + 200: + description: A successful response + + \ No newline at end of file