{ "openapi": "3.0.0", "info": { "title": "lchs-backend", "version": "0.0.1", "description": "lchs-backend", "contact": { "name": "Virendra Singh", "email": "vsingh1@bechtel.com" } }, "paths": { "/aboutUs/count": { "get": { "x-controller-name": "AboutUsController", "x-operation-name": "count", "tags": [ "AboutUsController" ], "responses": { "200": { "description": "AboutUs model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AboutUs.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "AboutUsController.count" } }, "/aboutUs/{id}": { "post": { "x-controller-name": "AboutUsController", "x-operation-name": "updateByIdPost", "tags": [ "AboutUsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AboutUs POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AboutUsController.updateByIdPost" }, "put": { "x-controller-name": "AboutUsController", "x-operation-name": "replaceById", "tags": [ "AboutUsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AboutUs PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AboutUs" } } }, "x-parameter-index": 1 }, "operationId": "AboutUsController.replaceById" }, "patch": { "x-controller-name": "AboutUsController", "x-operation-name": "updateById", "tags": [ "AboutUsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AboutUs PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AboutUsController.updateById" }, "get": { "x-controller-name": "AboutUsController", "x-operation-name": "findById", "tags": [ "AboutUsController" ], "responses": { "200": { "description": "AboutUs model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AboutUs.Filter" } } } } ], "operationId": "AboutUsController.findById" }, "delete": { "x-controller-name": "AboutUsController", "x-operation-name": "deleteById", "tags": [ "AboutUsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AboutUs DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AboutUsController.deleteById" } }, "/aboutUs": { "post": { "x-controller-name": "AboutUsController", "x-operation-name": "create", "tags": [ "AboutUsController" ], "responses": { "200": { "description": "AboutUs model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AboutUs" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AboutUsController.create" }, "get": { "x-controller-name": "AboutUsController", "x-operation-name": "find", "tags": [ "AboutUsController" ], "responses": { "200": { "description": "Array of AboutUs model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AboutUsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AboutUs.Filter1" } } } } ], "operationId": "AboutUsController.find" } }, "/additionalpayout/bulk": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "createAdditionalPayoutsBulk", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create multiple additional (ad hoc) payouts in one submit" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "entries" ], "properties": { "entries": { "type": "array", "items": { "type": "object", "required": [ "userId", "payoutTitle", "payoutAmount", "startDate", "endDate" ], "properties": { "userId": { "type": "number" }, "userName": { "type": "string" }, "payoutTitle": { "type": "string" }, "payoutAmount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "status": { "type": "boolean" } } } } } } } } }, "operationId": "PayoutController.createAdditionalPayoutsBulk" } }, "/additionalpayout/{id}/status": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateAdditionalPayoutStatus", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Toggle active/inactive status" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateAdditionalPayoutStatus" } }, "/additionalpayout/{id}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateAdditionalPayout", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update an additional (ad hoc) payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateAdditionalPayout" }, "delete": { "x-controller-name": "PayoutController", "x-operation-name": "deleteAdditionalPayout", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete an additional (ad hoc) payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.deleteAdditionalPayout" } }, "/additionalpayout": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "createAdditionalPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create an additional (ad hoc) payout" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "payoutTitle", "payoutAmount", "startDate", "endDate" ], "properties": { "userId": { "type": "number" }, "userName": { "type": "string" }, "payoutTitle": { "type": "string" }, "payoutAmount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "status": { "type": "boolean" } } } } } }, "operationId": "PayoutController.createAdditionalPayout" }, "get": { "x-controller-name": "PayoutController", "x-operation-name": "findAdditionalPayouts", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List additional (ad hoc) payouts" } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.findAdditionalPayouts" } }, "/admin/capacities/bulk": { "post": { "x-controller-name": "CapacityController", "x-operation-name": "bulkUpdate", "tags": [ "CapacityController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "User capacities updated in bulk" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "updates" ], "properties": { "updates": { "type": "array", "items": { "type": "object", "required": [ "id", "capacity" ] } } } } } } }, "operationId": "CapacityController.bulkUpdate" } }, "/admin/capacities/{userId}": { "patch": { "x-controller-name": "CapacityController", "x-operation-name": "update", "tags": [ "CapacityController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "User capacity updated" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "capacity" ], "properties": { "capacity": { "type": "integer", "minimum": 0 } } } } }, "x-parameter-index": 1 }, "operationId": "CapacityController.update" } }, "/admin/capacities": { "get": { "x-controller-name": "CapacityController", "x-operation-name": "find", "tags": [ "CapacityController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "User capacity rows" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "operationId": "CapacityController.find" } }, "/admin/staff/count": { "get": { "x-controller-name": "StaffController", "x-operation-name": "count", "tags": [ "StaffController" ], "responses": { "200": { "description": "User model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "StaffController.count" } }, "/admin/staff/prototype": { "get": { "x-controller-name": "StaffController", "x-operation-name": "findAll", "tags": [ "StaffController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Array of all enriched staff instances" } } } } }, "parameters": [ { "name": "roleId", "in": "query", "schema": { "type": "number" } }, { "name": "reportinghnId", "in": "query", "schema": { "type": "string" } }, { "name": "includeInactive", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "StaffController.findAll" } }, "/admin/staff/{id}": { "put": { "x-controller-name": "StaffController", "x-operation-name": "replaceById", "tags": [ "StaffController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "User PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "x-parameter-index": 1 }, "operationId": "StaffController.replaceById" }, "patch": { "x-controller-name": "StaffController", "x-operation-name": "updateById", "tags": [ "StaffController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "User PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "StaffController.updateById" }, "get": { "x-controller-name": "StaffController", "x-operation-name": "findById", "tags": [ "StaffController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Enriched staff instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "StaffController.findById" }, "delete": { "x-controller-name": "StaffController", "x-operation-name": "deleteById", "tags": [ "StaffController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "User DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "StaffController.deleteById" } }, "/admin/staff": { "post": { "x-controller-name": "StaffController", "x-operation-name": "create", "tags": [ "StaffController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "User model instance" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "StaffController.create" }, "get": { "x-controller-name": "StaffController", "x-operation-name": "find", "tags": [ "StaffController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Array of enriched staff instances" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "searchbar", "in": "query", "schema": { "type": "string" } }, { "name": "roleId", "in": "query", "schema": { "type": "number" } }, { "name": "role", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "boolean" } }, { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "nextToken", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "roleName", "in": "query", "schema": { "type": "string" } } ], "operationId": "StaffController.find" } }, "/approve-requested-nutritionist": { "put": { "x-controller-name": "TransferNutritionistController", "x-operation-name": "approveRequestedNutritionist", "tags": [ "TransferNutritionistController" ], "responses": { "200": { "description": "Select final nutritionist from candidates and approve transfer", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "transferId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "transferId", "nutritionistId", "userId" ], "properties": { "transferId": { "type": "number" }, "nutritionistId": { "type": "number" }, "userId": { "type": "number" } } } } } }, "operationId": "TransferNutritionistController.approveRequestedNutritionist" } }, "/areaOfConcern/count": { "get": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "count", "tags": [ "AreaOfConcernController" ], "responses": { "200": { "description": "AreaOfConcern model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AreaOfConcern.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "AreaOfConcernController.count" } }, "/areaOfConcern/{id}": { "post": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "updateByIdPost", "tags": [ "AreaOfConcernController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AreaOfConcern POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AreaOfConcernController.updateByIdPost" }, "put": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "replaceById", "tags": [ "AreaOfConcernController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AreaOfConcern PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaOfConcern" } } }, "x-parameter-index": 1 }, "operationId": "AreaOfConcernController.replaceById" }, "patch": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "updateById", "tags": [ "AreaOfConcernController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AreaOfConcern PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AreaOfConcernController.updateById" }, "get": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "findById", "tags": [ "AreaOfConcernController" ], "responses": { "200": { "description": "AreaOfConcern model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaOfConcern.Filter" } } } } ], "operationId": "AreaOfConcernController.findById" }, "delete": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "deleteById", "tags": [ "AreaOfConcernController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AreaOfConcern DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AreaOfConcernController.deleteById" } }, "/areaOfConcern": { "post": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "create", "tags": [ "AreaOfConcernController" ], "responses": { "200": { "description": "AreaOfConcern model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaOfConcern" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AreaOfConcernController.create" }, "get": { "x-controller-name": "AreaOfConcernController", "x-operation-name": "find", "tags": [ "AreaOfConcernController" ], "responses": { "200": { "description": "Array of AreaOfConcern model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AreaOfConcernWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaOfConcern.Filter1" } } } } ], "operationId": "AreaOfConcernController.find" } }, "/assessment-categories/{id}": { "patch": { "x-controller-name": "AssessmentCategoryController", "x-operation-name": "updateById", "tags": [ "AssessmentCategoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AssessmentCategory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AssessmentCategoryController.updateById" }, "get": { "x-controller-name": "AssessmentCategoryController", "x-operation-name": "findById", "tags": [ "AssessmentCategoryController" ], "responses": { "200": { "description": "AssessmentCategory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentCategory" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AssessmentCategoryController.findById" }, "delete": { "x-controller-name": "AssessmentCategoryController", "x-operation-name": "deleteById", "tags": [ "AssessmentCategoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AssessmentCategory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AssessmentCategoryController.deleteById" } }, "/assessment-categories": { "post": { "x-controller-name": "AssessmentCategoryController", "x-operation-name": "create", "tags": [ "AssessmentCategoryController" ], "responses": { "200": { "description": "AssessmentCategory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentCategory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AssessmentCategoryController.create" }, "get": { "x-controller-name": "AssessmentCategoryController", "x-operation-name": "find", "tags": [ "AssessmentCategoryController" ], "responses": { "200": { "description": "Array of AssessmentCategory instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssessmentCategory" } } } } } }, "parameters": [ { "name": "activeOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } } ], "operationId": "AssessmentCategoryController.find" } }, "/assessment-questions/{id}": { "patch": { "x-controller-name": "AssessmentQuestionController", "x-operation-name": "updateById", "tags": [ "AssessmentQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AssessmentQuestion PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AssessmentQuestionController.updateById" }, "get": { "x-controller-name": "AssessmentQuestionController", "x-operation-name": "findById", "tags": [ "AssessmentQuestionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "AssessmentQuestion model instance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AssessmentQuestionController.findById" }, "delete": { "x-controller-name": "AssessmentQuestionController", "x-operation-name": "deleteById", "tags": [ "AssessmentQuestionController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "AssessmentQuestion DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AssessmentQuestionController.deleteById" } }, "/assessment-questions": { "post": { "x-controller-name": "AssessmentQuestionController", "x-operation-name": "create", "tags": [ "AssessmentQuestionController" ], "responses": { "200": { "description": "AssessmentQuestion model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentQuestion" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AssessmentQuestionController.create" }, "get": { "x-controller-name": "AssessmentQuestionController", "x-operation-name": "find", "tags": [ "AssessmentQuestionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Array of AssessmentQuestion instances" } } } } }, "parameters": [ { "name": "categoryId", "in": "query", "schema": { "type": "string" } }, { "name": "activeOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } } ], "operationId": "AssessmentQuestionController.find" } }, "/assessments/assessmentId/{assessmentId}": { "get": { "x-controller-name": "AssessmentController", "x-operation-name": "findByAssessmentId", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Enriched Assessment instance" } } } } }, "parameters": [ { "name": "assessmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AssessmentController.findByAssessmentId" } }, "/assessments/{id}/report": { "post": { "x-controller-name": "AssessmentController", "x-operation-name": "uploadReport", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Uploaded assessment report; returns the enriched assessment with a viewable preSignedUrl" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "AssessmentController.uploadReport" } }, "/assessments/{id}/useranswer": { "post": { "x-controller-name": "AssessmentController", "x-operation-name": "getQuestionsForAssessment", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Questions to answer for this assessment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AssessmentController.getQuestionsForAssessment" }, "put": { "x-controller-name": "AssessmentController", "x-operation-name": "submitAnswers", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Submitted answers for this assessment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AssessmentController.submitAnswers" } }, "/assessments/{subId}": { "post": { "x-controller-name": "AssessmentController", "x-operation-name": "createForSubId", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "Assessment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Assessment" } } } } }, "parameters": [ { "name": "subId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AssessmentController.createForSubId" }, "get": { "x-controller-name": "AssessmentController", "x-operation-name": "findBySubId", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Array of enriched Assessment instances for a user" } } } } }, "parameters": [ { "name": "subId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "assessmentType", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "AssessmentController.findBySubId" } }, "/assessments/{id}": { "patch": { "x-controller-name": "AssessmentController", "x-operation-name": "updateById", "tags": [ "AssessmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Assessment PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AssessmentController.updateById" }, "delete": { "x-controller-name": "AssessmentController", "x-operation-name": "deleteById", "tags": [ "AssessmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Assessment DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AssessmentController.deleteById" } }, "/assessments/{assessmentId}": { "get": { "x-controller-name": "AssessmentController", "x-operation-name": "findById", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Enriched Assessment instance" } } } } }, "parameters": [ { "name": "assessmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AssessmentController.findById" } }, "/assessments": { "post": { "x-controller-name": "AssessmentController", "x-operation-name": "create", "tags": [ "AssessmentController" ], "responses": { "200": { "description": "Assessment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Assessment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AssessmentController.create" } }, "/assign-new-nutritionist/{id}": { "post": { "x-controller-name": "TransferNutritionistController", "x-operation-name": "assignNewNutritionist", "tags": [ "TransferNutritionistController" ], "responses": { "200": { "description": "Assign new nutritionist to program (completes transfer — updates ProgramAssign, LeadMaster, AuditLog)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "transferId": { "type": "number" }, "programId": { "type": "number" }, "oldNtId": { "type": "number" }, "newNtId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "newNutritionistId", "userId" ], "properties": { "newNutritionistId": { "type": "number" }, "userId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "TransferNutritionistController.assignNewNutritionist" } }, "/assignment-workload/nutritionists": { "get": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "getNutritionistWorkload", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionists with live active-client count and capacity" } } } } }, "operationId": "ProgramAssignmentController.getNutritionistWorkload" } }, "/auth/change-password": { "post": { "x-controller-name": "AuthController", "x-operation-name": "changePassword", "tags": [ "AuthController" ], "responses": { "204": { "description": "Password changed successfully" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "oldPassword", "newPassword" ], "properties": { "oldPassword": { "type": "string" }, "newPassword": { "type": "string", "minLength": 8 } } } } } }, "operationId": "AuthController.changePassword" } }, "/auth/forgot-password": { "post": { "x-controller-name": "AuthController", "x-operation-name": "forgotPassword", "tags": [ "AuthController" ], "responses": { "200": { "description": "Password reset email sent", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "X-Frontend-Url", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } } } } } }, "operationId": "AuthController.forgotPassword" } }, "/auth/login": { "post": { "x-controller-name": "AuthController", "x-operation-name": "login", "tags": [ "AuthController" ], "responses": { "200": { "description": "User login", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "user": { "type": "object", "properties": { "userId": { "type": "number" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "role": { "type": "number" }, "roleName": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "X-App-Name", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "description": "Email address or username" }, "password": { "type": "string" } } } } } }, "operationId": "AuthController.login" } }, "/auth/register": { "post": { "x-controller-name": "AuthController", "x-operation-name": "register", "tags": [ "AuthController" ], "responses": { "200": { "description": "User registration", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "user": { "type": "object", "properties": { "userId": { "type": "number" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "role": { "type": "number" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8 }, "name": { "type": "string" }, "username": { "type": "string", "description": "Defaults to email if not provided" }, "gender": { "type": "string", "enum": [ "Male", "Female", "Other", "Not Mentioned" ] }, "roleId": { "type": "number", "description": "Must reference a valid role_master.id" } } } } } }, "operationId": "AuthController.register" } }, "/auth/reset-password": { "post": { "x-controller-name": "AuthController", "x-operation-name": "resetPassword", "tags": [ "AuthController" ], "responses": { "200": { "description": "Password reset successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token", "newPassword" ], "properties": { "token": { "type": "string" }, "newPassword": { "type": "string", "minLength": 8 } } } } } }, "operationId": "AuthController.resetPassword" } }, "/auth/send-otp": { "post": { "x-controller-name": "AuthController", "x-operation-name": "sendOtp", "tags": [ "AuthController" ], "responses": { "200": { "description": "OTP sent to the given phone number (CUSTOMER app login/signup)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "isNewUser": { "type": "boolean" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string" } } } } } }, "operationId": "AuthController.sendOtp" } }, "/auth/verify-otp": { "post": { "x-controller-name": "AuthController", "x-operation-name": "verifyOtp", "tags": [ "AuthController" ], "responses": { "200": { "description": "Verify OTP and issue a JWT for the CUSTOMER app", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "isNewUser": { "type": "boolean" }, "user": { "type": "object", "additionalProperties": true } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "phone", "otp" ], "properties": { "phone": { "type": "string" }, "otp": { "type": "string" } } } } } }, "operationId": "AuthController.verifyOtp" } }, "/auth/verify-reset-token": { "post": { "x-controller-name": "AuthController", "x-operation-name": "verifyResetToken", "tags": [ "AuthController" ], "responses": { "200": { "description": "Token verification result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "email": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string" } } } } } }, "operationId": "AuthController.verifyResetToken" } }, "/auth/whoami": { "get": { "x-controller-name": "AuthController", "x-operation-name": "whoAmI", "tags": [ "AuthController" ], "responses": { "200": { "description": "Current user profile", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "number" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "role": { "type": "number" }, "roleName": { "type": "string" }, "profilePic": { "type": "string" } } } } } } }, "parameters": [ { "name": "X-App-Name", "in": "header", "schema": { "type": "string" } } ], "operationId": "AuthController.whoAmI" } }, "/blog-payment": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getBlogPayment", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Global default blog payout amount" } } } } }, "operationId": "PayoutController.getBlogPayment" } }, "/blogpayout/{id}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateBlogPayout", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update a blog payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateBlogPayout" }, "delete": { "x-controller-name": "PayoutController", "x-operation-name": "deleteBlogPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Delete a blog payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.deleteBlogPayout" } }, "/blogpayout": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "createBlogPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a blog payout" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "blogDate" ], "properties": { "userId": { "type": "number" }, "userName": { "type": "string" }, "blogTitle": { "type": "string" }, "blogUrl": { "type": "string" }, "blogDate": { "type": "string" }, "payoutAmount": { "type": "number", "description": "Optional; defaults to blog_payment setting" } } } } } }, "operationId": "PayoutController.createBlogPayout" }, "get": { "x-controller-name": "PayoutController", "x-operation-name": "listBlogPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List blog payouts" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.listBlogPayout" } }, "/body-measurement-logs/{clientId}/latest": { "get": { "x-controller-name": "BodyMeasurementController", "x-operation-name": "getLatestByClient", "tags": [ "BodyMeasurementController" ], "responses": { "200": { "description": "Latest body measurement log for client", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BodyMeasurementController.getLatestByClient" } }, "/body-measurement-logs/{clientId}": { "post": { "x-controller-name": "BodyMeasurementController", "x-operation-name": "create", "tags": [ "BodyMeasurementController" ], "responses": { "200": { "description": "Create body measurement log", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "BodyMeasurementController.create" }, "get": { "x-controller-name": "BodyMeasurementController", "x-operation-name": "getByClient", "tags": [ "BodyMeasurementController" ], "responses": { "200": { "description": "Body measurement logs for client", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BodyMeasurementController.getByClient" } }, "/body-weight-logs/{clientId}/latest": { "get": { "x-controller-name": "BodyWeightController", "x-operation-name": "getLatestByClient", "tags": [ "BodyWeightController" ], "responses": { "200": { "description": "Latest body weight log for client", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BodyWeightController.getLatestByClient" } }, "/body-weight-logs/{clientId}": { "post": { "x-controller-name": "BodyWeightController", "x-operation-name": "create", "tags": [ "BodyWeightController" ], "responses": { "200": { "description": "Create body weight log", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "BodyWeightController.create" }, "get": { "x-controller-name": "BodyWeightController", "x-operation-name": "getByClient", "tags": [ "BodyWeightController" ], "responses": { "200": { "description": "Body weight logs for client", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BodyWeightController.getByClient" } }, "/breakdown": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getPayoutBreakdown", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Payout breakdown" } } } } }, "parameters": [ { "name": "payoutId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.getPayoutBreakdown" } }, "/bulk-hold/nutritionist/eligible-programs": { "get": { "x-controller-name": "BulkOperationsController", "x-operation-name": "getNutritionistBulkHoldEligiblePrograms", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "Programs a nutritionist bulk hold would apply to", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "holdStartDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "BulkOperationsController.getNutritionistBulkHoldEligiblePrograms" } }, "/bulk-hold/nutritionist/{id}/abort": { "post": { "x-controller-name": "BulkOperationsController", "x-operation-name": "abortNutritionistBulkHold", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "Abort an approved nutritionist bulk hold and reverse applied schedule shifts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionistBulkHoldRequest" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "approverComment": { "type": "string" }, "resumeDate": { "type": "string", "description": "YYYY-MM-DD — reverse the hold only from this date onward" } } } } }, "x-parameter-index": 1 }, "operationId": "BulkOperationsController.abortNutritionistBulkHold" } }, "/bulk-hold/nutritionist/{id}/approve": { "put": { "x-controller-name": "BulkOperationsController", "x-operation-name": "approveNutritionistBulkHold", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "Approve or reject nutritionist bulk hold request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionistBulkHoldRequest" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "approved", "reject" ] }, "approverComment": { "type": "string" }, "approverName": { "type": "string" }, "approvedById": { "type": "number" } }, "required": [ "status" ] } } }, "x-parameter-index": 1 }, "operationId": "BulkOperationsController.approveNutritionistBulkHold" } }, "/bulk-hold/nutritionist": { "post": { "x-controller-name": "BulkOperationsController", "x-operation-name": "createNutritionistBulkHold", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "Create nutritionist bulk hold request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NutritionistBulkHoldRequest" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "BulkOperationsController.createNutritionistBulkHold" }, "get": { "x-controller-name": "BulkOperationsController", "x-operation-name": "findNutritionistBulkHolds", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "List nutritionist bulk hold requests", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NutritionistBulkHoldRequest" } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "BulkOperationsController.findNutritionistBulkHolds" } }, "/bulk-hold/organization/{id}/abort": { "post": { "x-controller-name": "BulkOperationsController", "x-operation-name": "abortOrganizationHold", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "Abort an organisation hold (reverses an applied one in the background)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BulkOperationsController.abortOrganizationHold" } }, "/bulk-hold/organization/{id}/programs": { "get": { "x-controller-name": "BulkOperationsController", "x-operation-name": "getOrganizationHoldPrograms", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "Get programs affected by organization hold", "content": { "application/json": { "schema": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/LukeHolidayHoldRequest" }, "totalPrograms": { "type": "number" }, "holds": { "type": "array", "items": { "$ref": "#/components/schemas/LukeHolidayHold" } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BulkOperationsController.getOrganizationHoldPrograms" } }, "/bulk-hold/organization": { "post": { "x-controller-name": "BulkOperationsController", "x-operation-name": "createOrganizationHold", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "Create organization-wide holiday hold", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LukeHolidayHoldRequest" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "BulkOperationsController.createOrganizationHold" }, "get": { "x-controller-name": "BulkOperationsController", "x-operation-name": "findOrganizationHolds", "tags": [ "BulkOperationsController" ], "responses": { "200": { "description": "List organization holiday hold requests", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LukeHolidayHoldRequest" } } } } } }, "parameters": [ { "name": "requesterId", "in": "query", "schema": { "type": "number" } }, { "name": "isActive", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "BulkOperationsController.findOrganizationHolds" } }, "/businessUnit": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getBusinessUnits", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Business units" } } } } }, "operationId": "AdminSupportController.getBusinessUnits" } }, "/call-logs/edit-permission": { "get": { "x-controller-name": "EventController", "x-operation-name": "getCallLogEditPermission", "tags": [ "EventController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Whether the caller holds the Edit Call Logs permission" } } } } }, "operationId": "EventController.getCallLogEditPermission" } }, "/category": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getCategories", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Assessment categories" } } } } }, "operationId": "AdminSupportController.getCategories" } }, "/childConfiguration/count": { "get": { "x-controller-name": "ConfigurationController", "x-operation-name": "countChildConfigs", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "ChildConfiguration model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "operationId": "ConfigurationController.countChildConfigs" } }, "/childConfiguration/{id}": { "post": { "x-controller-name": "ConfigurationController", "x-operation-name": "updateChildConfigByIdPost", "tags": [ "ConfigurationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ChildConfiguration POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ConfigurationController.updateChildConfigByIdPost" }, "patch": { "x-controller-name": "ConfigurationController", "x-operation-name": "updateChildConfigById", "tags": [ "ConfigurationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ChildConfiguration PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ConfigurationController.updateChildConfigById" }, "get": { "x-controller-name": "ConfigurationController", "x-operation-name": "findChildConfigById", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "Child configuration item", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ConfigurationController.findChildConfigById" }, "delete": { "x-controller-name": "ConfigurationController", "x-operation-name": "deleteChildConfigById", "tags": [ "ConfigurationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ChildConfiguration DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ConfigurationController.deleteChildConfigById" } }, "/childConfiguration": { "post": { "x-controller-name": "ConfigurationController", "x-operation-name": "createChildConfig", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "Created child configuration item", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "ConfigurationController.createChildConfig" }, "get": { "x-controller-name": "ConfigurationController", "x-operation-name": "findChildConfigs", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "Array of child configuration items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "masterConfigId", "in": "query", "schema": { "type": "number" } }, { "name": "categoryName", "in": "query", "schema": { "type": "string" } } ], "operationId": "ConfigurationController.findChildConfigs" } }, "/childfeedback/count": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "count", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "ProgramFeedback model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProgramFeedback.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FeedbackController.count" } }, "/childfeedback/escalation/list": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "getEscalationFeedbacks", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Feedbacks flagged for escalation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramFeedback" } } } } } }, "operationId": "FeedbackController.getEscalationFeedbacks" } }, "/childfeedback/filter-options/search": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "searchFilterOptions", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Matching values for one server-searched feedback list column filter", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "parameters": [ { "name": "column", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "operationId": "FeedbackController.searchFilterOptions" } }, "/childfeedback/filter-options": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "filterOptions", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Distinct values for the feedback list column filters", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "FeedbackController.filterOptions" } }, "/childfeedback/negative/list": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "getNegativeFeedbacks", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Negative feedbacks requiring action", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramFeedback" } } } } } }, "parameters": [ { "name": "actionPending", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "FeedbackController.getNegativeFeedbacks" } }, "/childfeedback/nps/score": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "calculateNPS", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Calculate NPS score", "content": { "application/json": { "schema": { "type": "object", "properties": { "npsScore": { "type": "number" }, "promoters": { "type": "number" }, "passives": { "type": "number" }, "detractors": { "type": "number" }, "totalResponses": { "type": "number" } } } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "FeedbackController.calculateNPS" } }, "/childfeedback/statistics/summary": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "getStatistics", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Feedback statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalFeedbacks": { "type": "number" }, "positive": { "type": "number" }, "negative": { "type": "number" }, "neutral": { "type": "number" }, "averageOverallRating": { "type": "number" }, "averageNPS": { "type": "number" }, "escalationRequired": { "type": "number" }, "actionPending": { "type": "number" } } } } } } }, "parameters": [ { "name": "nutritionistId", "in": "query", "schema": { "type": "number" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "FeedbackController.getStatistics" } }, "/childfeedback/submit": { "post": { "x-controller-name": "FeedbackController", "x-operation-name": "submitFeedback", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Client-submitted program feedback", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramFeedback" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "FeedbackController.submitFeedback" } }, "/childfeedback/testimonial/list": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "getTestimonialFeedbacks", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Feedbacks suitable for testimonials", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramFeedback" } } } } } }, "operationId": "FeedbackController.getTestimonialFeedbacks" } }, "/childfeedback/{feedbackId}": { "post": { "x-controller-name": "FeedbackController", "x-operation-name": "updateById", "tags": [ "FeedbackController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProgramFeedback update/review" } } } } }, "parameters": [ { "name": "feedbackId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "FeedbackController.updateById" }, "patch": { "x-controller-name": "FeedbackController", "x-operation-name": "updateByIdPatch", "tags": [ "FeedbackController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProgramFeedback PATCH success" } } } } }, "parameters": [ { "name": "feedbackId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "FeedbackController.updateByIdPatch" }, "get": { "x-controller-name": "FeedbackController", "x-operation-name": "findById", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "ProgramFeedback model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "feedbackId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "feedbackActionContext", "in": "query", "schema": { "type": "string" } } ], "operationId": "FeedbackController.findById" }, "delete": { "x-controller-name": "FeedbackController", "x-operation-name": "deleteById", "tags": [ "FeedbackController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProgramFeedback DELETE success" } } } } }, "parameters": [ { "name": "feedbackId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FeedbackController.deleteById" } }, "/childfeedback": { "post": { "x-controller-name": "FeedbackController", "x-operation-name": "create", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "ProgramFeedback model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramFeedback" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "FeedbackController.create" }, "get": { "x-controller-name": "FeedbackController", "x-operation-name": "find", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Array of ProgramFeedback model instances, or paginated object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "programId", "in": "query", "schema": { "type": "number" } }, { "name": "feedbackStatus", "in": "query", "schema": { "type": "string" } }, { "name": "tag", "in": "query", "schema": { "type": "string" } }, { "name": "clientId", "in": "query", "schema": { "type": "number" } }, { "name": "nutritionistId", "in": "query", "schema": { "type": "number" } }, { "name": "searchbar", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } }, { "name": "assignedNutritionistId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } }, { "name": "ufq", "in": "query", "schema": { "type": "number" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "feedbackActionContext", "in": "query", "schema": { "type": "string" } }, { "name": "resolutionStatus", "in": "query", "schema": { "type": "string" } } ], "operationId": "FeedbackController.find" } }, "/cities/{id}": { "patch": { "x-controller-name": "AdminReferenceController", "x-operation-name": "updateCity", "tags": [ "AdminReferenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "City PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AdminReferenceController.updateCity" }, "delete": { "x-controller-name": "AdminReferenceController", "x-operation-name": "deleteCity", "tags": [ "AdminReferenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "City DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdminReferenceController.deleteCity" } }, "/cities": { "post": { "x-controller-name": "AdminReferenceController", "x-operation-name": "createCity", "tags": [ "AdminReferenceController" ], "responses": { "200": { "description": "Created city", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AdminReferenceController.createCity" }, "get": { "x-controller-name": "AdminReferenceController", "x-operation-name": "findCities", "tags": [ "AdminReferenceController" ], "responses": { "200": { "description": "City list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/City.Filter" } } } } ], "operationId": "AdminReferenceController.findCities" } }, "/client-bank-details/{clientId}": { "put": { "x-controller-name": "ClientBankDetailsController", "x-operation-name": "saveForClient", "tags": [ "ClientBankDetailsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Created or updated bank details of one client" } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ClientBankDetailsController.saveForClient" }, "get": { "x-controller-name": "ClientBankDetailsController", "x-operation-name": "findByClient", "tags": [ "ClientBankDetailsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Bank details of one client (data is null if none)" } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ClientBankDetailsController.findByClient" } }, "/client-email-preferences/{id}/toggle": { "put": { "x-controller-name": "ClientEmailPreferenceController", "x-operation-name": "toggle", "tags": [ "ClientEmailPreferenceController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Updated client email preference" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ClientEmailPreferenceController.toggle" } }, "/client-email-preferences": { "get": { "x-controller-name": "ClientEmailPreferenceController", "x-operation-name": "list", "tags": [ "ClientEmailPreferenceController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Client email preferences" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "want_to_receive_email", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "per_page", "in": "query", "schema": { "type": "number" } } ], "operationId": "ClientEmailPreferenceController.list" } }, "/client-escalation/{id}/details": { "get": { "x-controller-name": "EscalationController", "x-operation-name": "getEscalationDetails", "tags": [ "EscalationController" ], "responses": { "200": { "description": "Get all details/messages for an escalation", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "escalationId": { "type": "number" }, "details": { "type": "array" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EscalationController.getEscalationDetails" } }, "/client-escalation/{id}": { "put": { "x-controller-name": "EscalationController", "x-operation-name": "actionEscalation", "tags": [ "EscalationController" ], "responses": { "200": { "description": "Take action on an escalation (resolve, transfer, refund, extend, handhold)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "escalationId": { "type": "number" }, "detailId": { "type": "number" }, "action": { "type": "string" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "action", "actionSummary", "userId" ], "properties": { "action": { "type": "string", "description": "CONTINUE_AS_IS_WITH_HANDHOLDING, REFUND, TRANSFER_PROGRAM, TRANSFER_NUTRITIONIST, EXTEND_PROGRAM" }, "actionSummary": { "type": "string" }, "userId": { "type": "number" }, "roleId": { "type": "number" }, "tag": { "type": "string" }, "newNutritionistId": { "type": "number" }, "selectedStaffMember": { "type": "number" }, "transferToClientId": { "type": "number" }, "selectedUser": { "type": "number" }, "lastCoachingDate": { "type": "string" }, "coachingDaysRemaining": { "type": "number" }, "remainingDays": { "type": "number" }, "classification": { "type": "string" }, "gapAnalysisTags": { "type": "array", "items": { "type": "string", "enum": [ "KNOWLEDGE_GAP", "SKILL_GAP", "ATTITUDE_ISSUE", "SOFT_SKILL_TRAINING", "SOP_ADHERENCE" ] }, "description": "KNOWLEDGE_GAP, SKILL_GAP, ATTITUDE_ISSUE, SOFT_SKILL_TRAINING, SOP_ADHERENCE (multi-select)" }, "gapAnalysisComment": { "type": "string" }, "hasMonetaryImpact": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "EscalationController.actionEscalation" } }, "/client-escalation": { "post": { "x-controller-name": "EscalationController", "x-operation-name": "createEscalation", "tags": [ "EscalationController" ], "responses": { "200": { "description": "Create a client escalation and place program on Escalation Hold", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "escalationId": { "type": "number" }, "detailId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId", "clientId", "escalationRaisedDate", "summary" ], "properties": { "programId": { "type": "number" }, "clientId": { "type": "number" }, "escalationRaisedDate": { "type": "string", "description": "YYYY-MM-DD" }, "summary": { "type": "string" }, "source": { "type": "string" }, "createdByUserId": { "type": "number" } } } } } }, "operationId": "EscalationController.createEscalation" } }, "/close-program/file/upload": { "post": { "x-controller-name": "ProgramController", "x-operation-name": "uploadCloseProgramFile", "tags": [ "ProgramController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Upload a close-program attachment using backend S3 credentials" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "ProgramController.uploadCloseProgramFile" } }, "/close-program": { "post": { "x-controller-name": "ProgramController", "x-operation-name": "closeProgram", "tags": [ "ProgramController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Close program success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "ProgramController.closeProgram" } }, "/communicationChannel/{id}": { "patch": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "updateCommunicationChannel", "tags": [ "LeadMasterDataController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CommunicationChannel PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadMasterDataController.updateCommunicationChannel" }, "delete": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "deleteCommunicationChannel", "tags": [ "LeadMasterDataController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CommunicationChannel DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadMasterDataController.deleteCommunicationChannel" } }, "/communicationChannel": { "post": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "createCommunicationChannel", "tags": [ "LeadMasterDataController" ], "responses": { "200": { "description": "CommunicationChannel model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationChannel" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadMasterDataController.createCommunicationChannel" }, "get": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "findCommunicationChannels", "tags": [ "LeadMasterDataController" ], "responses": { "200": { "description": "Array of CommunicationChannel model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationChannelWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationChannel.Filter" } } } } ], "operationId": "LeadMasterDataController.findCommunicationChannels" } }, "/consultpayout/{id}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateConsultPayoutRecord", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update a consult payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateConsultPayoutRecord" }, "delete": { "x-controller-name": "PayoutController", "x-operation-name": "deleteConsultPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Delete a consult payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.deleteConsultPayout" } }, "/consultpayout": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "createConsultPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create (or update, if program+user already has a row) a consult payout" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "month", "year", "payoutAmount" ], "properties": { "userId": { "type": "number" }, "userName": { "type": "string" }, "month": { "type": "number" }, "year": { "type": "number" }, "programId": { "type": "number" }, "programName": { "type": "string" }, "consultDate": { "type": "string" }, "payoutAmount": { "type": "number" } } } } } }, "operationId": "PayoutController.createConsultPayout" }, "get": { "x-controller-name": "PayoutController", "x-operation-name": "listConsultPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List consult payout rows" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.listConsultPayout" } }, "/consultpayouts/{id}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateConsultPayout", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Approve or reject a consult payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateConsultPayout" } }, "/consultpayouts": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "listConsultPayouts", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Consult payout management list" } } } } }, "parameters": [ { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.listConsultPayouts" } }, "/corporate/{id}/assessment/statistics": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "corporateAssessmentStatistics", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Corporate assessment statistics" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "AdminSupportController.corporateAssessmentStatistics" } }, "/corporate/{id}/question": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "saveCorporateQuestions", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Attach corporate questions" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "AdminSupportController.saveCorporateQuestions" } }, "/corporate/{id}": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "updateCorporate", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update corporate" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "AdminSupportController.updateCorporate" }, "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getCorporateById", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Corporate details" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AdminSupportController.getCorporateById" } }, "/corporate": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "createCorporate", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create corporate" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdminSupportController.createCorporate" }, "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getCorporates", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Corporate list" } } } } }, "parameters": [ { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "cq", "in": "query", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "AdminSupportController.getCorporates" } }, "/countries/{id}": { "patch": { "x-controller-name": "AdminReferenceController", "x-operation-name": "updateCountry", "tags": [ "AdminReferenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Country PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AdminReferenceController.updateCountry" }, "delete": { "x-controller-name": "AdminReferenceController", "x-operation-name": "deleteCountry", "tags": [ "AdminReferenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Country DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdminReferenceController.deleteCountry" } }, "/countries": { "post": { "x-controller-name": "AdminReferenceController", "x-operation-name": "createCountry", "tags": [ "AdminReferenceController" ], "responses": { "200": { "description": "Created country", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Country" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AdminReferenceController.createCountry" }, "get": { "x-controller-name": "AdminReferenceController", "x-operation-name": "findCountries", "tags": [ "AdminReferenceController" ], "responses": { "200": { "description": "Country list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Country.Filter" } } } } ], "operationId": "AdminReferenceController.findCountries" } }, "/cron/referral-bonus-payout/approve": { "post": { "x-controller-name": "ReferralController", "x-operation-name": "approveReferralBonusPayout", "tags": [ "ReferralController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Approve pending referral payout records. Secured by X-Cron-Secret." } } } } }, "parameters": [ { "name": "X-Cron-Secret", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "month", "year" ], "properties": { "month": { "type": "number", "description": "Month (1-12)" }, "year": { "type": "number", "description": "Year (e.g. 2026)" }, "payoutIds": { "type": "array", "items": { "type": "number" }, "description": "Optional payout_referral_bonus ids. If omitted, approves all pending records for the month." }, "approvedByUserId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "ReferralController.approveReferralBonusPayout" } }, "/cron/referral-bonus-payout/report": { "get": { "x-controller-name": "ReferralController", "x-operation-name": "referralBonusPayoutReport", "tags": [ "ReferralController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Draft referral payout report grouped by nutritionist. Secured by X-Cron-Secret." } } } } }, "parameters": [ { "name": "X-Cron-Secret", "in": "header", "schema": { "type": "string" } }, { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "ReferralController.referralBonusPayoutReport" } }, "/cron/referral-bonus-payout": { "post": { "x-controller-name": "ReferralController", "x-operation-name": "calculateReferralBonusPayout", "tags": [ "ReferralController" ], "responses": { "200": { "description": "Calculate and create referral bonus payouts for a given month/year. Secured by cron secret header.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "month": { "type": "number" }, "year": { "type": "number" }, "recordsCreated": { "type": "number" }, "totalPayoutAmount": { "type": "number" }, "details": { "type": "array", "items": { "type": "object", "properties": { "leadId": { "type": "number" }, "nutritionistId": { "type": "number" }, "tier": { "type": "string" }, "classification": { "type": "string" }, "payoutAmount": { "type": "number" } } } } } } } } } }, "parameters": [ { "name": "X-Cron-Secret", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "month", "year" ], "properties": { "month": { "type": "number", "description": "Month (1-12)" }, "year": { "type": "number", "description": "Year (e.g. 2026)" } } } } }, "x-parameter-index": 1 }, "operationId": "ReferralController.calculateReferralBonusPayout" } }, "/cron/renewal-bonus-payout/approve": { "post": { "x-controller-name": "RenewalController", "x-operation-name": "approveRenewalBonusPayout", "tags": [ "RenewalController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Approve pending renewal payout records. Secured by X-Cron-Secret." } } } } }, "parameters": [ { "name": "X-Cron-Secret", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "month", "year" ], "properties": { "month": { "type": "number", "description": "Month (1-12)" }, "year": { "type": "number", "description": "Year (e.g. 2026)" }, "payoutIds": { "type": "array", "items": { "type": "number" }, "description": "Optional payout_renewal_bonus ids. If omitted, approves all pending records for the month." }, "approvedByUserId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "RenewalController.approveRenewalBonusPayout" } }, "/cron/renewal-bonus-payout/report": { "get": { "x-controller-name": "RenewalController", "x-operation-name": "renewalBonusPayoutReport", "tags": [ "RenewalController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Draft renewal payout report grouped by nutritionist. Secured by X-Cron-Secret." } } } } }, "parameters": [ { "name": "X-Cron-Secret", "in": "header", "schema": { "type": "string" } }, { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "RenewalController.renewalBonusPayoutReport" } }, "/cron/renewal-bonus-payout": { "post": { "x-controller-name": "RenewalController", "x-operation-name": "calculateRenewalBonusPayout", "tags": [ "RenewalController" ], "responses": { "200": { "description": "Calculate and create renewal bonus payouts for a given month/year. Secured by X-Cron-Secret header.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "month": { "type": "number" }, "year": { "type": "number" }, "recordsCreated": { "type": "number" }, "totalPayoutAmount": { "type": "number" }, "details": { "type": "array", "items": { "type": "object", "properties": { "leadId": { "type": "number" }, "nutritionistId": { "type": "number" }, "nutritionistName": { "type": "string" }, "programName": { "type": "string" }, "payoutAmount": { "type": "number" } } } } } } } } } }, "parameters": [ { "name": "X-Cron-Secret", "in": "header", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "month", "year" ], "properties": { "month": { "type": "number", "description": "Month (1-12)" }, "year": { "type": "number", "description": "Year (e.g. 2026)" } } } } }, "x-parameter-index": 1 }, "operationId": "RenewalController.calculateRenewalBonusPayout" } }, "/currencyTypes/count": { "get": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "count", "tags": [ "CurrencyTypeController" ], "responses": { "200": { "description": "CurrencyType model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CurrencyType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CurrencyTypeController.count" } }, "/currencyTypes/{id}": { "post": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "updateByIdPost", "tags": [ "CurrencyTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CurrencyType POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "CurrencyTypeController.updateByIdPost" }, "put": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "replaceById", "tags": [ "CurrencyTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CurrencyType PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyType" } } }, "x-parameter-index": 1 }, "operationId": "CurrencyTypeController.replaceById" }, "patch": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "updateById", "tags": [ "CurrencyTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CurrencyType PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "CurrencyTypeController.updateById" }, "get": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "findById", "tags": [ "CurrencyTypeController" ], "responses": { "200": { "description": "CurrencyType model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyType.Filter" } } } } ], "operationId": "CurrencyTypeController.findById" }, "delete": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "deleteById", "tags": [ "CurrencyTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CurrencyType DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CurrencyTypeController.deleteById" } }, "/currencyTypes": { "post": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "create", "tags": [ "CurrencyTypeController" ], "responses": { "200": { "description": "CurrencyType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "CurrencyTypeController.create" }, "get": { "x-controller-name": "CurrencyTypeController", "x-operation-name": "find", "tags": [ "CurrencyTypeController" ], "responses": { "200": { "description": "Array of CurrencyType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyType.Filter1" } } } } ], "operationId": "CurrencyTypeController.find" } }, "/dashboard/admin-summary": { "get": { "x-controller-name": "AdminDashboardController", "x-operation-name": "adminSummary", "tags": [ "AdminDashboardController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Admin dashboard counts, the same set the old dashboard showed. Clients are current state; program counts use the calendar period (this week from Monday, this month, this year). Calls and food plans only count active programs: upcoming = next 7 days, overdue = last 30 days." } } } } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } } ], "operationId": "AdminDashboardController.adminSummary" } }, "/department": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getDepartments", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Departments" } } } } }, "operationId": "AdminSupportController.getDepartments" } }, "/dosage": { "get": { "x-controller-name": "SupplementMasterController", "x-operation-name": "getDosageOptions", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get dosage options" } } } } }, "operationId": "SupplementMasterController.getDosageOptions" } }, "/email/outbox/run": { "post": { "x-controller-name": "EmailOutboxController", "x-operation-name": "runDueJobs", "tags": [ "EmailOutboxController" ], "responses": { "200": { "description": "Run due email outbox jobs", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "batchSize": { "type": "number" } } } } }, "required": false }, "operationId": "EmailOutboxController.runDueJobs" } }, "/email/send": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "sendEmail", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Send email" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdminSupportController.sendEmail" } }, "/email/template/generation": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "generateEmailTemplate", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Generate email template" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdminSupportController.generateEmailTemplate" } }, "/email-outbox/by-program/{programId}": { "get": { "x-controller-name": "EmailOutboxController", "x-operation-name": "getByProgram", "tags": [ "EmailOutboxController" ], "responses": { "200": { "description": "Get all emails sent/queued for a program", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "programId": { "type": "number" }, "emails": { "type": "array" } } } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailOutboxController.getByProgram" } }, "/email-signature/upload-image": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "uploadSignatureImage", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Uploads an image for use in the email signature builder, returns its public URL" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "EmailTemplateController.uploadSignatureImage" } }, "/email-signature": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "setSignature", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update the global email signature HTML" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string" } } } } } }, "operationId": "EmailTemplateController.setSignature" }, "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "getSignature", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Current global email signature HTML" } } } } }, "operationId": "EmailTemplateController.getSignature" } }, "/email-templates/catalog": { "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "catalog", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Context types and the variables each one offers" } } } } }, "parameters": [ { "name": "contextType", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailTemplateController.catalog" } }, "/email-templates/coverage": { "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "coverage", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Which template every active product resolves to for an event" } } } } }, "parameters": [ { "name": "triggerEvent", "in": "query", "schema": { "type": "string" } }, { "name": "leadSourceId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmailTemplateController.coverage" } }, "/email-templates/lint": { "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "lint", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Saved templates that fail validation" } } } } }, "operationId": "EmailTemplateController.lint" } }, "/email-templates/preview": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "previewDraft", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rendered subject/html for an unsaved template draft" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "EmailTemplateController.previewDraft" } }, "/email-templates/trigger-events": { "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "triggerEvents", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Events whose template is chosen by product group and lead source" } } } } }, "operationId": "EmailTemplateController.triggerEvents" } }, "/email-templates/validate": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "validate", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Validation result for a template draft" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "EmailTemplateController.validate" } }, "/email-templates/{id}/history": { "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "history", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "Prior versions of this template", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplateHistory" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailTemplateController.history" } }, "/email-templates/{id}/preview": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "preview", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rendered subject/html for this template using sample or supplied variables" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": true }, "subject": { "type": "string" }, "htmlBody": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "EmailTemplateController.preview" } }, "/email-templates/{id}/recipients/preview": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "previewRecipients", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Resolved To / CC / BCC for a program" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EmailTemplateController.previewRecipients" } }, "/email-templates/{id}/recipients": { "put": { "x-controller-name": "EmailTemplateController", "x-operation-name": "setRecipientRules", "tags": [ "EmailTemplateController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Recipient rules replaced" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EmailTemplateController.setRecipientRules" }, "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "recipientRules", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Recipient rules of a template" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailTemplateController.recipientRules" } }, "/email-templates/{id}/routing": { "put": { "x-controller-name": "EmailTemplateController", "x-operation-name": "setRouting", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Routing saved; returns overlap warnings" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EmailTemplateController.setRouting" }, "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "routing", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Trigger event, product groups and lead sources of a template" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailTemplateController.routing" } }, "/email-templates/{id}/test-send": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "testSend", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Sends a rendered test email to the selected recipient" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "string" }, "variables": { "type": "object", "additionalProperties": true }, "subject": { "type": "string" }, "htmlBody": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "EmailTemplateController.testSend" } }, "/email-templates/{id}/variables": { "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "variables", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Variables a template can use, grouped by section" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailTemplateController.variables" } }, "/email-templates/{id}": { "patch": { "x-controller-name": "EmailTemplateController", "x-operation-name": "updateById", "tags": [ "EmailTemplateController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "EmailTemplate PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EmailTemplateController.updateById" }, "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "findById", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "EmailTemplate model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplate" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailTemplateController.findById" }, "delete": { "x-controller-name": "EmailTemplateController", "x-operation-name": "deleteById", "tags": [ "EmailTemplateController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "EmailTemplate DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailTemplateController.deleteById" } }, "/email-templates": { "post": { "x-controller-name": "EmailTemplateController", "x-operation-name": "create", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "EmailTemplate model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailTemplate" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "EmailTemplateController.create" }, "get": { "x-controller-name": "EmailTemplateController", "x-operation-name": "find", "tags": [ "EmailTemplateController" ], "responses": { "200": { "description": "Array of EmailTemplate model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailTemplate" } } } } } }, "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailTemplateController.find" } }, "/end-feedback": { "post": { "x-controller-name": "FeedbackCrmController", "x-operation-name": "submitEndFeedback", "tags": [ "FeedbackCrmController" ], "responses": { "200": { "description": "Submit end-of-program feedback (public - no auth required)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "feedbackId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId", "clientId", "feedback" ], "properties": { "programId": { "type": "number" }, "clientId": { "type": "number" }, "feedback": { "type": "string" }, "overallRating": { "type": "number" }, "recommendationScale": { "type": "number" } } } } } }, "operationId": "FeedbackCrmController.submitEndFeedback" } }, "/event/analysis": { "get": { "x-controller-name": "EventController", "x-operation-name": "getEventsAnalysis", "tags": [ "EventController" ], "responses": { "200": { "description": "Get events analysis (upcoming/overdue consults and nutrition plans)", "content": { "application/json": { "schema": { "type": "object", "properties": { "upcomingConsults": { "type": "number" }, "overdueConsults": { "type": "number" }, "upcomingNutritionPlans": { "type": "number" }, "overdueNutritionPlans": { "type": "number" }, "overduePrograms": { "type": "number" } } } } } } }, "parameters": [ { "name": "assignNutriId", "in": "query", "schema": { "type": "number" } }, { "name": "month", "in": "query", "schema": { "type": "string" } } ], "operationId": "EventController.getEventsAnalysis" } }, "/event/belowTable": { "get": { "x-controller-name": "EventController", "x-operation-name": "getBelowTable", "tags": [ "EventController" ], "responses": { "200": { "description": "Program events below table", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "es", "in": "query", "schema": { "type": "number" } } ], "operationId": "EventController.getBelowTable" } }, "/event/file/{id}/upload": { "post": { "x-controller-name": "EventController", "x-operation-name": "uploadProgramFile", "tags": [ "EventController" ], "responses": { "200": { "description": "Upload a program food plan file to S3", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileUrl": { "type": "string" }, "objectKey": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "EventController.uploadProgramFile" } }, "/event/file/{id}": { "patch": { "x-controller-name": "EventController", "x-operation-name": "updateFileById", "tags": [ "EventController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Program file upload PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EventController.updateFileById" } }, "/event/food-plan/{id}/resubmit": { "post": { "x-controller-name": "EventController", "x-operation-name": "resubmitFoodPlan", "tags": [ "EventController" ], "responses": { "200": { "description": "Resubmit a rejected food plan for re-approval", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EventController.resubmitFoodPlan" } }, "/event/multiusereventlist": { "get": { "x-controller-name": "EventController", "x-operation-name": "getMultiUserEvents", "tags": [ "EventController" ], "responses": { "200": { "description": "Get events for multiple users or by date", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramCallLog" } } } } } }, "parameters": [ { "name": "assignNutriId", "in": "query", "schema": { "type": "number" } }, { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "eventTypes", "in": "query", "schema": { "type": "string" } }, { "name": "includeCalendarSources", "in": "query", "schema": { "type": "string" } }, { "name": "pendingOnly", "in": "query", "schema": { "type": "string" } }, { "name": "callType", "in": "query", "schema": { "type": "string" } }, { "name": "foodPlanType", "in": "query", "schema": { "type": "string" } }, { "name": "primaryNutritionistOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "programStatusScope", "in": "query", "schema": { "type": "string" } } ], "operationId": "EventController.getMultiUserEvents" } }, "/event/timeline/{progId}": { "get": { "x-controller-name": "EventController", "x-operation-name": "getTimeline", "tags": [ "EventController" ], "responses": { "200": { "description": "Get program timeline/events", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramCallLog" } } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EventController.getTimeline" } }, "/event/{subId}/multiusereventlist": { "get": { "x-controller-name": "EventController", "x-operation-name": "getUserEvents", "tags": [ "EventController" ], "responses": { "200": { "description": "Get user events", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramCallLog" } } } } } }, "parameters": [ { "name": "subId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "EventController.getUserEvents" } }, "/event/{progId}/roadmap/{fileUploadId}/skip": { "post": { "x-controller-name": "EventController", "x-operation-name": "skipRoadmap", "tags": [ "EventController" ], "responses": { "200": { "description": "Mark a pending Roadmap upload as skipped", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "fileUploadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EventController.skipRoadmap" } }, "/event/{progId}": { "post": { "x-controller-name": "EventController", "x-operation-name": "createEvent", "tags": [ "EventController" ], "responses": { "200": { "description": "Create or update program event", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramCallLog" } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EventController.createEvent" } }, "/event/{id}": { "put": { "x-controller-name": "EventController", "x-operation-name": "replaceById", "tags": [ "EventController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Event PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramCallLog" } } }, "x-parameter-index": 1 }, "operationId": "EventController.replaceById" }, "patch": { "x-controller-name": "EventController", "x-operation-name": "updateById", "tags": [ "EventController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Event PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "EventController.updateById" }, "delete": { "x-controller-name": "EventController", "x-operation-name": "deleteById", "tags": [ "EventController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Event DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EventController.deleteById" } }, "/event": { "post": { "x-controller-name": "EventController", "x-operation-name": "create", "tags": [ "EventController" ], "responses": { "200": { "description": "Create program event", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgramCallLog" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "operationId": "EventController.create" } }, "/exercise/count": { "get": { "x-controller-name": "ExerciseMasterController", "x-operation-name": "count", "tags": [ "ExerciseMasterController" ], "responses": { "200": { "description": "Exercise model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Exercise.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ExerciseMasterController.count" } }, "/exercise/{id}": { "post": { "x-controller-name": "ExerciseMasterController", "x-operation-name": "updateById", "tags": [ "ExerciseMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Exercise update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ExerciseMasterController.updateById" }, "patch": { "x-controller-name": "ExerciseMasterController", "x-operation-name": "updateByIdPatch", "tags": [ "ExerciseMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Exercise PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ExerciseMasterController.updateByIdPatch" }, "get": { "x-controller-name": "ExerciseMasterController", "x-operation-name": "findById", "tags": [ "ExerciseMasterController" ], "responses": { "200": { "description": "Exercise model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ExerciseMasterController.findById" }, "delete": { "x-controller-name": "ExerciseMasterController", "x-operation-name": "deleteById", "tags": [ "ExerciseMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Exercise DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ExerciseMasterController.deleteById" } }, "/exercise": { "post": { "x-controller-name": "ExerciseMasterController", "x-operation-name": "create", "tags": [ "ExerciseMasterController" ], "responses": { "200": { "description": "Exercise model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Exercise" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "ExerciseMasterController.create" }, "get": { "x-controller-name": "ExerciseMasterController", "x-operation-name": "find", "tags": [ "ExerciseMasterController" ], "responses": { "200": { "description": "Array of Exercise model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExerciseWithRelations" } } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "muscleGroup", "in": "query", "schema": { "type": "string" } }, { "name": "difficultyLevel", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "ExerciseMasterController.find" } }, "/feature-flags": { "get": { "x-controller-name": "FeatureFlagsController", "x-operation-name": "getFeatureFlags", "tags": [ "FeatureFlagsController" ], "responses": { "200": { "description": "Feature switches the frontends read at runtime", "content": { "application/json": { "schema": { "type": "object", "properties": { "nutritionAgentEnabled": { "type": "boolean" } } } } } } }, "operationId": "FeatureFlagsController.getFeatureFlags" } }, "/featureDuration": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getFeatureDuration", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Feature duration types" } } } } }, "operationId": "AdminSupportController.getFeatureDuration" } }, "/food-plan/file": { "get": { "x-controller-name": "MedicalReportController", "x-operation-name": "proxyFoodPlanFile", "tags": [ "MedicalReportController" ], "responses": { "200": { "description": "Proxy a food plan from S3 or the available legacy storage host", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "path", "in": "query", "schema": { "type": "string" } } ], "operationId": "MedicalReportController.proxyFoodPlanFile" } }, "/foodItem/count": { "get": { "x-controller-name": "NutritionMasterController", "x-operation-name": "count", "tags": [ "NutritionMasterController" ], "responses": { "200": { "description": "FoodItem model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FoodItem.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "NutritionMasterController.count" } }, "/foodItem/{id}": { "post": { "x-controller-name": "NutritionMasterController", "x-operation-name": "updateById", "tags": [ "NutritionMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FoodItem update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "NutritionMasterController.updateById" }, "patch": { "x-controller-name": "NutritionMasterController", "x-operation-name": "updateByIdPatch", "tags": [ "NutritionMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FoodItem PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "NutritionMasterController.updateByIdPatch" }, "get": { "x-controller-name": "NutritionMasterController", "x-operation-name": "findById", "tags": [ "NutritionMasterController" ], "responses": { "200": { "description": "FoodItem model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NutritionMasterController.findById" }, "delete": { "x-controller-name": "NutritionMasterController", "x-operation-name": "deleteById", "tags": [ "NutritionMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FoodItem DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NutritionMasterController.deleteById" } }, "/foodItem": { "post": { "x-controller-name": "NutritionMasterController", "x-operation-name": "create", "tags": [ "NutritionMasterController" ], "responses": { "200": { "description": "FoodItem model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FoodItem" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "NutritionMasterController.create" }, "get": { "x-controller-name": "NutritionMasterController", "x-operation-name": "find", "tags": [ "NutritionMasterController" ], "responses": { "200": { "description": "Array of FoodItem model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FoodItemWithRelations" } } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "dietPreference", "in": "query", "schema": { "type": "string" } }, { "name": "foodCategory", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "NutritionMasterController.find" } }, "/frequency": { "get": { "x-controller-name": "SupplementMasterController", "x-operation-name": "getFrequencyOptions", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get frequency options" } } } } }, "operationId": "SupplementMasterController.getFrequencyOptions" } }, "/generalAccess/{id}/regenerate": { "post": { "x-controller-name": "AdminReferenceController", "x-operation-name": "regenerateGeneralAccess", "tags": [ "AdminReferenceController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Regenerated API provider key" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdminReferenceController.regenerateGeneralAccess" } }, "/generalAccess/{id}": { "patch": { "x-controller-name": "AdminReferenceController", "x-operation-name": "updateGeneralAccess", "tags": [ "AdminReferenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "API provider PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "AdminReferenceController.updateGeneralAccess" }, "delete": { "x-controller-name": "AdminReferenceController", "x-operation-name": "deleteGeneralAccess", "tags": [ "AdminReferenceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "API provider DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdminReferenceController.deleteGeneralAccess" } }, "/generalAccess": { "post": { "x-controller-name": "AdminReferenceController", "x-operation-name": "createGeneralAccess", "tags": [ "AdminReferenceController" ], "responses": { "200": { "description": "Created API provider access key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralAccess" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "AdminReferenceController.createGeneralAccess" }, "get": { "x-controller-name": "AdminReferenceController", "x-operation-name": "findGeneralAccess", "tags": [ "AdminReferenceController" ], "responses": { "200": { "description": "API provider access-key list", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralAccessWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralAccess.Filter" } } } } ], "operationId": "AdminReferenceController.findGeneralAccess" } }, "/get-program-tag-users/{programId}": { "get": { "x-controller-name": "FeedbackController", "x-operation-name": "getProgramTagUsers", "tags": [ "FeedbackController" ], "responses": { "200": { "description": "Users available for program feedback tagging", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FeedbackController.getProgramTagUsers" } }, "/get-users-detail/{id}": { "get": { "x-controller-name": "NutritionistProfileController", "x-operation-name": "getUserDetail", "tags": [ "NutritionistProfileController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist profile details" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NutritionistProfileController.getUserDetail" } }, "/goals/{goalsId}": { "post": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "updateGoal", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Update goal/progress", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "goalsId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "ProgramDetailsSupportController.updateGoal" } }, "/goals": { "post": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "createGoal", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Create goal", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ProgramDetailsSupportController.createGoal" }, "get": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "getGoals", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Goals by program", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "gq", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProgramDetailsSupportController.getGoals" } }, "/healthInsight/{reportId}/blueprint": { "get": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "getHealthInsightBlueprint", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Health insight blueprint", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "reportId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProgramDetailsSupportController.getHealthInsightBlueprint" } }, "/healthInsight": { "get": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "getHealthInsight", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Health insight biomarker data", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "hiq", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProgramDetailsSupportController.getHealthInsight" } }, "/hnReview": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "hnReview", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "HN Review data" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.hnReview" } }, "/hold-freeze-program/cancel": { "post": { "x-controller-name": "HoldFreezeController", "x-operation-name": "cancelHolds", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Cancel one or more active or future approved hold requests", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "cancelledHoldIds": { "type": "array", "items": { "type": "number" } }, "cancelledSections": { "type": "number" }, "programIds": { "type": "array", "items": { "type": "number" } }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "holdIds" ], "properties": { "holdIds": { "type": "array", "items": { "type": "number" }, "minItems": 1 }, "cancelComment": { "type": "string" }, "userId": { "type": "number" } } } } } }, "operationId": "HoldFreezeController.cancelHolds" } }, "/hold-freeze-program/total-hold-days": { "get": { "x-controller-name": "HoldFreezeController", "x-operation-name": "getTotalHoldDays", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Total hold days within a date window", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "query", "schema": { "type": "number" } }, { "name": "programId", "in": "query", "schema": { "type": "number" } }, { "name": "program_id", "in": "query", "schema": { "type": "number" } }, { "name": "last_coaching_date", "in": "query", "schema": { "type": "string" } }, { "name": "lastCoachingDate", "in": "query", "schema": { "type": "string" } }, { "name": "program_end_date", "in": "query", "schema": { "type": "string" } }, { "name": "programEndDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "HoldFreezeController.getTotalHoldDays" } }, "/hold-freeze-program/{id}/approve": { "put": { "x-controller-name": "HoldFreezeController", "x-operation-name": "approveHold", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Approve a hold/freeze request and apply program date changes", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "holdId": { "type": "number" }, "programId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "HoldFreezeController.approveHold" } }, "/hold-freeze-program/{id}": { "put": { "x-controller-name": "HoldFreezeController", "x-operation-name": "update", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Update a hold/freeze request", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "HoldFreezeController.update" }, "get": { "x-controller-name": "HoldFreezeController", "x-operation-name": "show", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Hold/freeze request detail", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HoldFreezeController.show" }, "delete": { "x-controller-name": "HoldFreezeController", "x-operation-name": "destroy", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Delete a hold/freeze request", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HoldFreezeController.destroy" } }, "/hold-freeze-program": { "post": { "x-controller-name": "HoldFreezeController", "x-operation-name": "createHold", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Create a hold/freeze request for a program", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "holdId": { "type": "number" }, "newEndDate": { "type": "string" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId", "holdStartDate", "holdEndDate" ], "properties": { "programId": { "type": "number" }, "holdStartDate": { "type": "string", "description": "YYYY-MM-DD" }, "holdEndDate": { "type": "string", "description": "YYYY-MM-DD" }, "reason": { "type": "string" }, "requesterUserId": { "type": "number" }, "approvalRequiredFromUser": { "type": "number" }, "skipNotification": { "type": "boolean" } } } } } }, "operationId": "HoldFreezeController.createHold" }, "get": { "x-controller-name": "HoldFreezeController", "x-operation-name": "index", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Paginated hold/freeze requests", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "number" } }, { "name": "program_id", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "productId", "in": "query", "schema": { "type": "number" } }, { "name": "product_id", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "nutritionistId", "in": "query", "schema": { "type": "number" } }, { "name": "nutritionist_id", "in": "query", "schema": { "type": "number" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "HoldFreezeController.index" } }, "/hold-freeze-requested-program/{programId}": { "get": { "x-controller-name": "HoldFreezeController", "x-operation-name": "getHoldsByProgram", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Get all hold requests for a program", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "programId": { "type": "number" }, "holds": { "type": "array" } } } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HoldFreezeController.getHoldsByProgram" } }, "/hold-program/list": { "get": { "x-controller-name": "HoldFreezeController", "x-operation-name": "holdProgramList", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Mobile-compatible hold/freeze list wrapper", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "HoldFreezeController.holdProgramList" } }, "/hold-program/{id}": { "put": { "x-controller-name": "HoldFreezeController", "x-operation-name": "holdProgramUpdate", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Mobile-compatible hold/freeze update wrapper", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "HoldFreezeController.holdProgramUpdate" }, "get": { "x-controller-name": "HoldFreezeController", "x-operation-name": "holdProgramDetail", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Mobile-compatible hold/freeze detail wrapper", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HoldFreezeController.holdProgramDetail" }, "delete": { "x-controller-name": "HoldFreezeController", "x-operation-name": "delete", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Mobile-compatible hold/freeze delete wrapper", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "HoldFreezeController.delete" } }, "/hold-program": { "post": { "x-controller-name": "HoldFreezeController", "x-operation-name": "holdProgramStore", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Mobile-compatible hold/freeze create wrapper", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "HoldFreezeController.holdProgramStore" } }, "/import/additional-payout": { "post": { "x-controller-name": "PayoutImportController", "x-operation-name": "importAdditionalPayout", "tags": [ "PayoutImportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import additional (ad hoc) payouts" } } } } }, "operationId": "PayoutImportController.importAdditionalPayout" } }, "/import/product-payout": { "post": { "x-controller-name": "PayoutImportController", "x-operation-name": "importProductPayout", "tags": [ "PayoutImportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import product payout rates" } } } } }, "operationId": "PayoutImportController.importProductPayout" } }, "/import/program-payout": { "post": { "x-controller-name": "PayoutImportController", "x-operation-name": "importProgramPayout", "tags": [ "PayoutImportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import program payout opening balances" } } } } }, "operationId": "PayoutImportController.importProgramPayout" } }, "/import/renewal-to-program": { "post": { "x-controller-name": "PayoutImportController", "x-operation-name": "importRenewalToProgram", "tags": [ "PayoutImportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Map renewal leads to their parent program id" } } } } }, "operationId": "PayoutImportController.importRenewalToProgram" } }, "/import/user-payout": { "post": { "x-controller-name": "PayoutImportController", "x-operation-name": "importUserPayout", "tags": [ "PayoutImportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Import nutritionist payout configuration" } } } } }, "operationId": "PayoutImportController.importUserPayout" } }, "/inquiryMaster/{id}": { "patch": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "updateInquiry", "tags": [ "LeadMasterDataController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "InquiryMaster PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadMasterDataController.updateInquiry" }, "delete": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "deleteInquiry", "tags": [ "LeadMasterDataController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "InquiryMaster DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadMasterDataController.deleteInquiry" } }, "/inquiryMaster": { "post": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "createInquiry", "tags": [ "LeadMasterDataController" ], "responses": { "200": { "description": "InquiryMaster model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryMaster" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadMasterDataController.createInquiry" }, "get": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "findInquiries", "tags": [ "LeadMasterDataController" ], "responses": { "200": { "description": "Array of InquiryMaster model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InquiryMasterWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryMaster.Filter" } } } } ], "operationId": "LeadMasterDataController.findInquiries" } }, "/intakeTiming": { "get": { "x-controller-name": "SupplementMasterController", "x-operation-name": "getIntakeTimingOptions", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get intake timing options" } } } } }, "operationId": "SupplementMasterController.getIntakeTimingOptions" } }, "/lead/by-client/{clientId}": { "get": { "x-controller-name": "LeadController", "x-operation-name": "findByClientId", "tags": [ "LeadController" ], "responses": { "200": { "description": "Lead(s) belonging to a single client, most recent first", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LeadWithRelations" } } } } } } } }, "parameters": [ { "name": "clientId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadController.findByClientId" } }, "/lead/count": { "get": { "x-controller-name": "LeadController", "x-operation-name": "count", "tags": [ "LeadController" ], "responses": { "200": { "description": "Lead model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Lead.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadController.count" } }, "/lead/filter-options/search": { "get": { "x-controller-name": "LeadController", "x-operation-name": "searchLeadFilterOptions", "tags": [ "LeadController" ], "responses": { "200": { "description": "Matching values for one server-searched leads-list column filter", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "parameters": [ { "name": "column", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "operationId": "LeadController.searchLeadFilterOptions" } }, "/lead/filter-options": { "get": { "x-controller-name": "LeadController", "x-operation-name": "leadFilterOptions", "tags": [ "LeadController" ], "responses": { "200": { "description": "Distinct values per leads-list column, for the filter-row dropdowns", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "LeadController.leadFilterOptions" } }, "/lead/pending-status": { "get": { "x-controller-name": "LeadController", "x-operation-name": "getPendingStatus", "tags": [ "LeadController" ], "responses": { "200": { "description": "Pending status analytics for lead dashboard", "content": { "application/json": { "schema": { "type": "object", "properties": { "requestCounts": { "type": "object", "properties": { "PAYMENT_PENDING": { "type": "number" }, "PDFORM_PENDING": { "type": "number" }, "MR_PENDING": { "type": "number" }, "ASSIGNMENT_PENDING": { "type": "number" }, "ASSIGNMENT_COMPLETED": { "type": "number" }, "TRANSFER_PENDING": { "type": "number" } } }, "getTotalUserCount": { "type": "number" }, "getAsignmentPendingrequest": { "type": "object", "properties": { "Senior": { "type": "number" }, "Junior": { "type": "number" }, "Exclusive": { "type": "number" }, "Priority": { "type": "number" } } }, "getTotalAssignmentPendingCount": { "type": "number" } } } } } } }, "parameters": [ { "name": "qp", "in": "query", "schema": { "type": "string" } } ], "operationId": "LeadController.getPendingStatus" } }, "/lead/{id}/handle-referral-conversion": { "post": { "x-controller-name": "ReferralController", "x-operation-name": "handleReferralConversion", "tags": [ "ReferralController" ], "responses": { "200": { "description": "Handle referral business logic when a lead converts (payment approved)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "referralDays": { "type": "number" }, "classification": { "type": "object", "nullable": true, "properties": { "classification": { "type": "string" }, "days": { "type": "number" } } }, "complimentaryProgramId": { "type": "number", "nullable": true }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "paymentApprovedDate" ], "properties": { "paymentApprovedDate": { "type": "string" }, "referralComplementaryMonth": { "type": "boolean" } } } } }, "x-parameter-index": 1 }, "operationId": "ReferralController.handleReferralConversion" } }, "/lead/{id}/handle-renewal-conversion": { "post": { "x-controller-name": "RenewalController", "x-operation-name": "handleRenewalConversion", "tags": [ "RenewalController" ], "responses": { "200": { "description": "Handle renewal business logic when a lead converts (payment approved). Creates a new Program record for the client.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "newProgramId": { "type": "number" }, "renewalDays": { "type": "number" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "paymentApprovedDate" ], "properties": { "paymentApprovedDate": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "RenewalController.handleRenewalConversion" } }, "/lead/{leadId}/status": { "get": { "x-controller-name": "LeadController", "x-operation-name": "getLeadStatus", "tags": [ "LeadController" ], "responses": { "200": { "description": "Get lead status with assignment eligibility info", "content": { "application/json": { "schema": { "type": "object", "properties": { "leadId": { "type": "number" }, "programId": { "type": "number", "nullable": true }, "clientId": { "type": "number", "nullable": true }, "consultTakenBy": { "type": "number", "nullable": true }, "referredByNutritionistId": { "type": "number", "nullable": true }, "nutritionistAssignId": { "type": "number", "nullable": true }, "coordinatorMessage": { "type": "string", "nullable": true }, "productId": { "type": "number", "nullable": true }, "mrReportUpload": { "type": "boolean" }, "userAssignId": { "type": "number", "nullable": true }, "isProgramCreated": { "type": "boolean" }, "paymentApprovedDate": { "type": "string", "nullable": true }, "inquiryMasterId": { "type": "number", "nullable": true }, "leadStatusId": { "type": "number", "nullable": true }, "leadStatusSubId": { "type": "number", "nullable": true }, "leadTypeId": { "type": "number", "nullable": true }, "mrApprovalDate": { "type": "string", "nullable": true }, "journeyStatus": { "type": "string" }, "paymentStatus": { "type": "string" }, "paymentApproved": { "type": "boolean" }, "canAssignProgram": { "type": "boolean" }, "isTransferLead": { "type": "boolean" }, "pdFormUploaded": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadController.getLeadStatus" } }, "/lead/{id}": { "put": { "x-controller-name": "LeadController", "x-operation-name": "replaceById", "tags": [ "LeadController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Lead PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } } }, "x-parameter-index": 1 }, "operationId": "LeadController.replaceById" }, "patch": { "x-controller-name": "LeadController", "x-operation-name": "updateById", "tags": [ "LeadController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Lead PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadController.updateById" }, "get": { "x-controller-name": "LeadController", "x-operation-name": "findById", "tags": [ "LeadController" ], "responses": { "200": { "description": "Lead model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "leadId", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead.Filter" } } } } ], "operationId": "LeadController.findById" }, "delete": { "x-controller-name": "LeadController", "x-operation-name": "deleteById", "tags": [ "LeadController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Lead DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadController.deleteById" } }, "/lead": { "post": { "x-controller-name": "LeadController", "x-operation-name": "create", "tags": [ "LeadController" ], "responses": { "200": { "description": "Lead model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lead" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadController.create" }, "get": { "x-controller-name": "LeadController", "x-operation-name": "find", "tags": [ "LeadController" ], "responses": { "200": { "description": "Array of Lead model instances with pagination support", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LeadWithRelations" } }, "pagination": { "type": "object", "properties": { "total": { "type": "number" }, "limit": { "type": "number" }, "offset": { "type": "number" }, "nextToken": { "type": "string", "nullable": true } } } } } } } } }, "parameters": [ { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "cq", "in": "query", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "schema": { "type": "string" } }, { "name": "city", "in": "query", "schema": { "type": "string" } }, { "name": "leadTypeId", "in": "query", "schema": { "type": "string" } }, { "name": "leadStatusId", "in": "query", "schema": { "type": "string" } }, { "name": "assignmentState", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "nextToken", "in": "query", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "schema": { "type": "string" } }, { "name": "programOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "consultOnly", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "LeadController.find" } }, "/lead-referral-request/{id}": { "get": { "x-controller-name": "ReferralController", "x-operation-name": "getReferralRequest", "tags": [ "ReferralController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get a single referral request by ID" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ReferralController.getReferralRequest" } }, "/lead-referral-request": { "post": { "x-controller-name": "ReferralController", "x-operation-name": "createReferralLead", "tags": [ "ReferralController" ], "responses": { "200": { "description": "Create a referral lead with client, lead, and referral records", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "leadId": { "type": "number" }, "clientId": { "type": "number" }, "referralRequestId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "referrerClientId", "programId" ], "properties": { "referrerClientId": { "type": "number" }, "referredClientName": { "type": "string" }, "referredClientFirstName": { "type": "string" }, "referredClientLastName": { "type": "string" }, "referredClientEmail": { "type": "string" }, "referredClientPhone": { "type": "string" }, "programId": { "type": "number" }, "keepConfidential": { "type": "boolean" }, "description": { "type": "string" }, "createdByUserId": { "type": "number" } } } } } }, "operationId": "ReferralController.createReferralLead" }, "get": { "x-controller-name": "ReferralController", "x-operation-name": "listReferralRequests", "tags": [ "ReferralController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List referral requests with filters" } } } } }, "parameters": [ { "name": "program_id", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "search2", "in": "query", "schema": { "type": "string" } }, { "name": "nutritionist_id", "in": "query", "schema": { "type": "number" } }, { "name": "product_id", "in": "query", "schema": { "type": "number" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "ReferralController.listReferralRequests" } }, "/lead-renewal-request": { "post": { "x-controller-name": "RenewalController", "x-operation-name": "createRenewalLead", "tags": [ "RenewalController" ], "responses": { "200": { "description": "Create a renewal lead for a program nearing expiry", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "leadId": { "type": "number" }, "clientId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId" ], "properties": { "programId": { "type": "number" }, "renewalPlanId": { "type": "number" }, "comment": { "type": "string" }, "clientWantsNewCoach": { "type": "string" }, "renewalFromNutritionistId": { "type": "number" } } } } } }, "operationId": "RenewalController.createRenewalLead" } }, "/leadAssignHistory/count": { "get": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "count", "tags": [ "LeadAssignHistoryController" ], "responses": { "200": { "description": "LeadAssignHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadAssignHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadAssignHistoryController.count" } }, "/leadAssignHistory/{id}": { "post": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "updateByIdPost", "tags": [ "LeadAssignHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadAssignHistory POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadAssignHistoryController.updateByIdPost" }, "put": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "replaceById", "tags": [ "LeadAssignHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadAssignHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadAssignHistory" } } }, "x-parameter-index": 1 }, "operationId": "LeadAssignHistoryController.replaceById" }, "patch": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "updateById", "tags": [ "LeadAssignHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadAssignHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadAssignHistoryController.updateById" }, "get": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "findById", "tags": [ "LeadAssignHistoryController" ], "responses": { "200": { "description": "LeadAssignHistory model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadAssignHistory.Filter" } } } } ], "operationId": "LeadAssignHistoryController.findById" }, "delete": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "deleteById", "tags": [ "LeadAssignHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadAssignHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadAssignHistoryController.deleteById" } }, "/leadAssignHistory": { "post": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "create", "tags": [ "LeadAssignHistoryController" ], "responses": { "200": { "description": "LeadAssignHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadAssignHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadAssignHistoryController.create" }, "get": { "x-controller-name": "LeadAssignHistoryController", "x-operation-name": "find", "tags": [ "LeadAssignHistoryController" ], "responses": { "200": { "description": "Array of LeadAssignHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadAssignHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadAssignHistory.Filter1" } } } } ], "operationId": "LeadAssignHistoryController.find" } }, "/leadComplementory/{id}": { "patch": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "updateLeadComplementory", "tags": [ "LeadMasterDataController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadComplementory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadMasterDataController.updateLeadComplementory" }, "delete": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "deleteLeadComplementory", "tags": [ "LeadMasterDataController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadComplementory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadMasterDataController.deleteLeadComplementory" } }, "/leadComplementory": { "post": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "createLeadComplementory", "tags": [ "LeadMasterDataController" ], "responses": { "200": { "description": "LeadComplementory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadComplementory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadMasterDataController.createLeadComplementory" }, "get": { "x-controller-name": "LeadMasterDataController", "x-operation-name": "findLeadComplementories", "tags": [ "LeadMasterDataController" ], "responses": { "200": { "description": "Array of LeadComplementory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadComplementoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadComplementory.Filter" } } } } ], "operationId": "LeadMasterDataController.findLeadComplementories" } }, "/leadDiscount/count": { "get": { "x-controller-name": "LeadDiscountController", "x-operation-name": "count", "tags": [ "LeadDiscountController" ], "responses": { "200": { "description": "LeadDiscount model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadDiscount.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadDiscountController.count" } }, "/leadDiscount/{id}": { "post": { "x-controller-name": "LeadDiscountController", "x-operation-name": "updateByIdPost", "tags": [ "LeadDiscountController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadDiscount POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadDiscountController.updateByIdPost" }, "put": { "x-controller-name": "LeadDiscountController", "x-operation-name": "replaceById", "tags": [ "LeadDiscountController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadDiscount PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadDiscount" } } }, "x-parameter-index": 1 }, "operationId": "LeadDiscountController.replaceById" }, "patch": { "x-controller-name": "LeadDiscountController", "x-operation-name": "updateById", "tags": [ "LeadDiscountController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadDiscount PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadDiscountController.updateById" }, "get": { "x-controller-name": "LeadDiscountController", "x-operation-name": "findById", "tags": [ "LeadDiscountController" ], "responses": { "200": { "description": "LeadDiscount model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadDiscount.Filter" } } } } ], "operationId": "LeadDiscountController.findById" }, "delete": { "x-controller-name": "LeadDiscountController", "x-operation-name": "deleteById", "tags": [ "LeadDiscountController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadDiscount DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadDiscountController.deleteById" } }, "/leadDiscount": { "post": { "x-controller-name": "LeadDiscountController", "x-operation-name": "create", "tags": [ "LeadDiscountController" ], "responses": { "200": { "description": "LeadDiscount model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadDiscount" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadDiscountController.create" }, "get": { "x-controller-name": "LeadDiscountController", "x-operation-name": "find", "tags": [ "LeadDiscountController" ], "responses": { "200": { "description": "Array of LeadDiscount model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadDiscountWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadDiscount.Filter1" } } } } ], "operationId": "LeadDiscountController.find" } }, "/leadPaymentHistory/count": { "get": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "count", "tags": [ "LeadPaymentHistoryController" ], "responses": { "200": { "description": "LeadPaymentHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadPaymentHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadPaymentHistoryController.count" } }, "/leadPaymentHistory/{id}": { "post": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "updateByIdPost", "tags": [ "LeadPaymentHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentHistory POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadPaymentHistoryController.updateByIdPost" }, "put": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "replaceById", "tags": [ "LeadPaymentHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentHistory" } } }, "x-parameter-index": 1 }, "operationId": "LeadPaymentHistoryController.replaceById" }, "patch": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "updateById", "tags": [ "LeadPaymentHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadPaymentHistoryController.updateById" }, "get": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "findById", "tags": [ "LeadPaymentHistoryController" ], "responses": { "200": { "description": "LeadPaymentHistory model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentHistory.Filter" } } } } ], "operationId": "LeadPaymentHistoryController.findById" }, "delete": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "deleteById", "tags": [ "LeadPaymentHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadPaymentHistoryController.deleteById" } }, "/leadPaymentHistory": { "post": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "create", "tags": [ "LeadPaymentHistoryController" ], "responses": { "200": { "description": "LeadPaymentHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadPaymentHistoryController.create" }, "get": { "x-controller-name": "LeadPaymentHistoryController", "x-operation-name": "find", "tags": [ "LeadPaymentHistoryController" ], "responses": { "200": { "description": "Array of LeadPaymentHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadPaymentHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentHistory.Filter1" } } } } ], "operationId": "LeadPaymentHistoryController.find" } }, "/leadPaymentStatusHistory/count": { "get": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "count", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "200": { "description": "LeadPaymentStatusHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadPaymentStatusHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadPaymentStatusHistoryController.count" } }, "/leadPaymentStatusHistory/{id}": { "post": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "updateByIdPost", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentStatusHistory POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadPaymentStatusHistoryController.updateByIdPost" }, "put": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "replaceById", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentStatusHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentStatusHistory" } } }, "x-parameter-index": 1 }, "operationId": "LeadPaymentStatusHistoryController.replaceById" }, "patch": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "updateById", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentStatusHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadPaymentStatusHistoryController.updateById" }, "get": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "findById", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "200": { "description": "LeadPaymentStatusHistory model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentStatusHistory.Filter" } } } } ], "operationId": "LeadPaymentStatusHistoryController.findById" }, "delete": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "deleteById", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadPaymentStatusHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadPaymentStatusHistoryController.deleteById" } }, "/leadPaymentStatusHistory": { "post": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "create", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "200": { "description": "LeadPaymentStatusHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentStatusHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadPaymentStatusHistoryController.create" }, "get": { "x-controller-name": "LeadPaymentStatusHistoryController", "x-operation-name": "find", "tags": [ "LeadPaymentStatusHistoryController" ], "responses": { "200": { "description": "Array of LeadPaymentStatusHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadPaymentStatusHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadPaymentStatusHistory.Filter1" } } } } ], "operationId": "LeadPaymentStatusHistoryController.find" } }, "/leadSource/count": { "get": { "x-controller-name": "LeadSourceController", "x-operation-name": "count", "tags": [ "LeadSourceController" ], "responses": { "200": { "description": "LeadSource model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadSource.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadSourceController.count" } }, "/leadSource/{id}": { "post": { "x-controller-name": "LeadSourceController", "x-operation-name": "updateByIdPost", "tags": [ "LeadSourceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadSource POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadSourceController.updateByIdPost" }, "put": { "x-controller-name": "LeadSourceController", "x-operation-name": "replaceById", "tags": [ "LeadSourceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadSource PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadSource" } } }, "x-parameter-index": 1 }, "operationId": "LeadSourceController.replaceById" }, "patch": { "x-controller-name": "LeadSourceController", "x-operation-name": "updateById", "tags": [ "LeadSourceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadSource PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadSourceController.updateById" }, "get": { "x-controller-name": "LeadSourceController", "x-operation-name": "findById", "tags": [ "LeadSourceController" ], "responses": { "200": { "description": "LeadSource model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadSource.Filter" } } } } ], "operationId": "LeadSourceController.findById" }, "delete": { "x-controller-name": "LeadSourceController", "x-operation-name": "deleteById", "tags": [ "LeadSourceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadSource DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadSourceController.deleteById" } }, "/leadSource": { "post": { "x-controller-name": "LeadSourceController", "x-operation-name": "create", "tags": [ "LeadSourceController" ], "responses": { "200": { "description": "LeadSource model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadSource" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadSourceController.create" }, "get": { "x-controller-name": "LeadSourceController", "x-operation-name": "find", "tags": [ "LeadSourceController" ], "responses": { "200": { "description": "Array of LeadSource model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadSourceWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadSource.Filter1" } } } } ], "operationId": "LeadSourceController.find" } }, "/leadStatus/count": { "get": { "x-controller-name": "LeadStatusController", "x-operation-name": "count", "tags": [ "LeadStatusController" ], "responses": { "200": { "description": "LeadStatus model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadStatus.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadStatusController.count" } }, "/leadStatus/{id}/children": { "get": { "x-controller-name": "LeadStatusController", "x-operation-name": "findChildren", "tags": [ "LeadStatusController" ], "responses": { "200": { "description": "Child lead statuses for a parent lead status", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadStatus" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadStatusController.findChildren" } }, "/leadStatus/{id}": { "post": { "x-controller-name": "LeadStatusController", "x-operation-name": "updateByIdPost", "tags": [ "LeadStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatus POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadStatusController.updateByIdPost" }, "put": { "x-controller-name": "LeadStatusController", "x-operation-name": "replaceById", "tags": [ "LeadStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatus PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatus" } } }, "x-parameter-index": 1 }, "operationId": "LeadStatusController.replaceById" }, "patch": { "x-controller-name": "LeadStatusController", "x-operation-name": "updateById", "tags": [ "LeadStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatus PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadStatusController.updateById" }, "get": { "x-controller-name": "LeadStatusController", "x-operation-name": "findById", "tags": [ "LeadStatusController" ], "responses": { "200": { "description": "LeadStatus model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatus.Filter" } } } } ], "operationId": "LeadStatusController.findById" }, "delete": { "x-controller-name": "LeadStatusController", "x-operation-name": "deleteById", "tags": [ "LeadStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatus DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadStatusController.deleteById" } }, "/leadStatus": { "post": { "x-controller-name": "LeadStatusController", "x-operation-name": "create", "tags": [ "LeadStatusController" ], "responses": { "200": { "description": "LeadStatus model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatus" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadStatusController.create" }, "get": { "x-controller-name": "LeadStatusController", "x-operation-name": "find", "tags": [ "LeadStatusController" ], "responses": { "200": { "description": "Array of LeadStatus model instances (with optional children)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "includeChildren", "in": "query", "schema": { "type": "boolean" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatus.Filter1" } } } } ], "operationId": "LeadStatusController.find" } }, "/leadStatusHistory/count": { "get": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "count", "tags": [ "LeadStatusHistoryController" ], "responses": { "200": { "description": "LeadStatusHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadStatusHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadStatusHistoryController.count" } }, "/leadStatusHistory/lead/{leadId}/timeline": { "get": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "getLeadStatusTimeline", "tags": [ "LeadStatusHistoryController" ], "responses": { "200": { "description": "Lead status timeline for status history tab", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadStatusHistoryController.getLeadStatusTimeline" } }, "/leadStatusHistory/{id}": { "post": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "updateByIdPost", "tags": [ "LeadStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatusHistory POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadStatusHistoryController.updateByIdPost" }, "put": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "replaceById", "tags": [ "LeadStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatusHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatusHistory" } } }, "x-parameter-index": 1 }, "operationId": "LeadStatusHistoryController.replaceById" }, "patch": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "updateById", "tags": [ "LeadStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatusHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadStatusHistoryController.updateById" }, "get": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "findById", "tags": [ "LeadStatusHistoryController" ], "responses": { "200": { "description": "LeadStatusHistory model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatusHistory.Filter" } } } } ], "operationId": "LeadStatusHistoryController.findById" }, "delete": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "deleteById", "tags": [ "LeadStatusHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadStatusHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadStatusHistoryController.deleteById" } }, "/leadStatusHistory": { "post": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "create", "tags": [ "LeadStatusHistoryController" ], "responses": { "200": { "description": "LeadStatusHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatusHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadStatusHistoryController.create" }, "get": { "x-controller-name": "LeadStatusHistoryController", "x-operation-name": "find", "tags": [ "LeadStatusHistoryController" ], "responses": { "200": { "description": "Array of LeadStatusHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadStatusHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadStatusHistory.Filter1" } } } } ], "operationId": "LeadStatusHistoryController.find" } }, "/leadType/count": { "get": { "x-controller-name": "LeadTypeController", "x-operation-name": "count", "tags": [ "LeadTypeController" ], "responses": { "200": { "description": "LeadType model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeadType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadTypeController.count" } }, "/leadType/{id}": { "post": { "x-controller-name": "LeadTypeController", "x-operation-name": "updateByIdPost", "tags": [ "LeadTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadType POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadTypeController.updateByIdPost" }, "put": { "x-controller-name": "LeadTypeController", "x-operation-name": "replaceById", "tags": [ "LeadTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadType PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadType" } } }, "x-parameter-index": 1 }, "operationId": "LeadTypeController.replaceById" }, "patch": { "x-controller-name": "LeadTypeController", "x-operation-name": "updateById", "tags": [ "LeadTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadType PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeadTypeController.updateById" }, "get": { "x-controller-name": "LeadTypeController", "x-operation-name": "findById", "tags": [ "LeadTypeController" ], "responses": { "200": { "description": "LeadType model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadType.Filter" } } } } ], "operationId": "LeadTypeController.findById" }, "delete": { "x-controller-name": "LeadTypeController", "x-operation-name": "deleteById", "tags": [ "LeadTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeadType DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadTypeController.deleteById" } }, "/leadType": { "post": { "x-controller-name": "LeadTypeController", "x-operation-name": "create", "tags": [ "LeadTypeController" ], "responses": { "200": { "description": "LeadType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeadTypeController.create" }, "get": { "x-controller-name": "LeadTypeController", "x-operation-name": "find", "tags": [ "LeadTypeController" ], "responses": { "200": { "description": "Array of LeadType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeadTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadType.Filter1" } } } } ], "operationId": "LeadTypeController.find" } }, "/leads/{leadId}/assign-program": { "post": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "assignProgram", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "Assign a new program to a lead", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "programId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "programId": { "type": "number" }, "clientId": { "type": "number" }, "productId": { "type": "number" }, "assignedUsers": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "roleId": { "type": "number" } } } }, "nutritionistUserIds": { "type": "array", "items": { "type": "number" } }, "verticalHeadUser": { "type": "number" }, "verticalHeadUserIds": { "type": "array", "items": { "type": "number" } }, "programAssignmentComment": { "type": "string" }, "isComplimentary": { "type": "boolean" }, "assignedDate": { "type": "string" }, "scheduleDate": { "type": "string" }, "scheduleId": { "type": "number" }, "programStartDate": { "type": "string" }, "programEndDate": { "type": "string" }, "notes": { "type": "string" }, "progStatus": { "type": "string" }, "nutritionistChangeRequested": { "type": "boolean" }, "changeOfNutritionistReason": { "type": "string" }, "coordinatorMessage": { "type": "string", "nullable": true } }, "required": [ "clientId", "productId", "assignedUsers" ] } } }, "x-parameter-index": 1 }, "operationId": "ProgramAssignmentController.assignProgram" } }, "/leads/{leadId}/assignment-context": { "get": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "getAssignmentContext", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Old parity assignment context for Assign Care Team modal" } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramAssignmentController.getAssignmentContext" } }, "/leads/{leadId}/assignment-users": { "get": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "getAssignmentUsers", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Role-grouped users for assignment modal" } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramAssignmentController.getAssignmentUsers" } }, "/leads/{leadId}/journey-status": { "get": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "getJourneyStatus", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "Get journey status for a lead", "content": { "application/json": { "schema": { "type": "object", "properties": { "leadId": { "type": "number" }, "programId": { "type": "number" }, "clientId": { "type": "number" }, "journeyStatus": { "type": "string" }, "canAssignProgram": { "type": "boolean" }, "userCanAssignProgram": { "type": "boolean" }, "isTransferLead": { "type": "boolean" }, "conditions": { "type": "object", "properties": { "mrReportUploaded": { "type": "boolean" }, "pdFormUpload": { "type": "boolean" }, "paymentApprovedDate": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramAssignmentController.getJourneyStatus" } }, "/leads/{leadId}/program-assignments": { "get": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "getProgramAssignments", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "Get program assignments with full details for a lead", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "programId": { "type": "number" }, "leadId": { "type": "number" }, "clientId": { "type": "number" }, "productId": { "type": "number" }, "assignedDate": { "type": "string" }, "notes": { "type": "string" }, "assignedBy": { "type": "number" }, "progStatus": { "type": "string" }, "programStartDate": { "type": "string" }, "programEndDate": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "productName": { "type": "string" }, "productLevelName": { "type": "string" }, "assignedByInfo": { "type": "array" }, "assignedNutritionistInfo": { "type": "array" }, "reportingHNInfo": { "type": "array" }, "qcTeamsInfo": { "type": "array" }, "careTeamInfo": { "type": "array" } } } } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "programId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramAssignmentController.getProgramAssignments" } }, "/leave/count": { "get": { "x-controller-name": "LeaveController", "x-operation-name": "count", "tags": [ "LeaveController" ], "responses": { "200": { "description": "LeaveRequest model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LeaveRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeaveController.count" } }, "/leave/statistics/summary": { "get": { "x-controller-name": "LeaveController", "x-operation-name": "getStatistics", "tags": [ "LeaveController" ], "responses": { "200": { "description": "Leave statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalLeaves": { "type": "number" }, "pendingLeaves": { "type": "number" }, "approvedLeaves": { "type": "number" }, "rejectedLeaves": { "type": "number" } } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } } ], "operationId": "LeaveController.getStatistics" } }, "/leave/{leaveId}": { "post": { "x-controller-name": "LeaveController", "x-operation-name": "updateById", "tags": [ "LeaveController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeaveRequest approval/rejection" } } } } }, "parameters": [ { "name": "leaveId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeaveController.updateById" }, "patch": { "x-controller-name": "LeaveController", "x-operation-name": "updateByIdPatch", "tags": [ "LeaveController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeaveRequest PATCH success" } } } } }, "parameters": [ { "name": "leaveId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "LeaveController.updateByIdPatch" }, "get": { "x-controller-name": "LeaveController", "x-operation-name": "findById", "tags": [ "LeaveController" ], "responses": { "200": { "description": "LeaveRequest model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "leaveId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeaveController.findById" }, "delete": { "x-controller-name": "LeaveController", "x-operation-name": "deleteById", "tags": [ "LeaveController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "LeaveRequest DELETE success" } } } } }, "parameters": [ { "name": "leaveId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeaveController.deleteById" } }, "/leave": { "post": { "x-controller-name": "LeaveController", "x-operation-name": "create", "tags": [ "LeaveController" ], "responses": { "200": { "description": "LeaveRequest model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaveRequest" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "LeaveController.create" }, "get": { "x-controller-name": "LeaveController", "x-operation-name": "find", "tags": [ "LeaveController" ], "responses": { "200": { "description": "Array of LeaveRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LeaveRequestWithRelations" } } } } } }, "parameters": [ { "name": "lq", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "subId", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "LeaveController.find" } }, "/lifestyleActivity/{id}": { "post": { "x-controller-name": "LifestyleMasterController", "x-operation-name": "updateById", "tags": [ "LifestyleMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update lifestyle activity" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "LifestyleMasterController.updateById" }, "get": { "x-controller-name": "LifestyleMasterController", "x-operation-name": "findById", "tags": [ "LifestyleMasterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Lifestyle activity detail" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LifestyleMasterController.findById" }, "delete": { "x-controller-name": "LifestyleMasterController", "x-operation-name": "deleteById", "tags": [ "LifestyleMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete lifestyle activity" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LifestyleMasterController.deleteById" } }, "/lifestyleActivity": { "post": { "x-controller-name": "LifestyleMasterController", "x-operation-name": "create", "tags": [ "LifestyleMasterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create lifestyle activity" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "LifestyleMasterController.create" }, "get": { "x-controller-name": "LifestyleMasterController", "x-operation-name": "find", "tags": [ "LifestyleMasterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Lifestyle activity list" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "LifestyleMasterController.find" } }, "/location": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getLocations", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Locations" } } } } }, "operationId": "AdminSupportController.getLocations" } }, "/master-catalog/{catalog}/{id}": { "patch": { "x-controller-name": "MasterCatalogController", "x-operation-name": "update", "tags": [ "MasterCatalogController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Master catalog PATCH success" } } } } }, "parameters": [ { "name": "catalog", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 2 }, "operationId": "MasterCatalogController.update" }, "delete": { "x-controller-name": "MasterCatalogController", "x-operation-name": "remove", "tags": [ "MasterCatalogController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Master catalog DELETE success" } } } } }, "parameters": [ { "name": "catalog", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MasterCatalogController.remove" } }, "/master-catalog/{catalog}": { "post": { "x-controller-name": "MasterCatalogController", "x-operation-name": "create", "tags": [ "MasterCatalogController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Created master catalog record" } } } } }, "parameters": [ { "name": "catalog", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "MasterCatalogController.create" }, "get": { "x-controller-name": "MasterCatalogController", "x-operation-name": "find", "tags": [ "MasterCatalogController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Master catalog records" } } } } }, "parameters": [ { "name": "catalog", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } } ], "operationId": "MasterCatalogController.find" } }, "/masterConfiguration/count": { "get": { "x-controller-name": "ConfigurationController", "x-operation-name": "countMasterConfigs", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "MasterConfiguration model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "operationId": "ConfigurationController.countMasterConfigs" } }, "/masterConfiguration/{id}": { "post": { "x-controller-name": "ConfigurationController", "x-operation-name": "updateMasterConfigByIdPost", "tags": [ "ConfigurationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MasterConfiguration POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ConfigurationController.updateMasterConfigByIdPost" }, "patch": { "x-controller-name": "ConfigurationController", "x-operation-name": "updateMasterConfigById", "tags": [ "ConfigurationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MasterConfiguration PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ConfigurationController.updateMasterConfigById" }, "get": { "x-controller-name": "ConfigurationController", "x-operation-name": "findMasterConfigById", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "Master configuration item", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ConfigurationController.findMasterConfigById" }, "delete": { "x-controller-name": "ConfigurationController", "x-operation-name": "deleteMasterConfigById", "tags": [ "ConfigurationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MasterConfiguration DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ConfigurationController.deleteMasterConfigById" } }, "/masterConfiguration": { "post": { "x-controller-name": "ConfigurationController", "x-operation-name": "createMasterConfig", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "Created master configuration item", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "categoryName": { "type": "string" } }, "required": [ "categoryName" ] } } } }, "operationId": "ConfigurationController.createMasterConfig" }, "get": { "x-controller-name": "ConfigurationController", "x-operation-name": "findMasterConfigs", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "Array of master configuration items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "operationId": "ConfigurationController.findMasterConfigs" } }, "/masterFeedback/count": { "get": { "x-controller-name": "MasterFeedbackController", "x-operation-name": "count", "tags": [ "MasterFeedbackController" ], "responses": { "200": { "description": "MasterFeedback model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MasterFeedback.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MasterFeedbackController.count" } }, "/masterFeedback/{id}": { "post": { "x-controller-name": "MasterFeedbackController", "x-operation-name": "updateById", "tags": [ "MasterFeedbackController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MasterFeedback update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "MasterFeedbackController.updateById" }, "patch": { "x-controller-name": "MasterFeedbackController", "x-operation-name": "updateByIdPatch", "tags": [ "MasterFeedbackController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MasterFeedback PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "MasterFeedbackController.updateByIdPatch" }, "get": { "x-controller-name": "MasterFeedbackController", "x-operation-name": "findById", "tags": [ "MasterFeedbackController" ], "responses": { "200": { "description": "MasterFeedback model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MasterFeedbackController.findById" }, "delete": { "x-controller-name": "MasterFeedbackController", "x-operation-name": "deleteById", "tags": [ "MasterFeedbackController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MasterFeedback DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MasterFeedbackController.deleteById" } }, "/masterFeedback": { "post": { "x-controller-name": "MasterFeedbackController", "x-operation-name": "create", "tags": [ "MasterFeedbackController" ], "responses": { "200": { "description": "MasterFeedback model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MasterFeedback" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "MasterFeedbackController.create" }, "get": { "x-controller-name": "MasterFeedbackController", "x-operation-name": "find", "tags": [ "MasterFeedbackController" ], "responses": { "200": { "description": "Array of MasterFeedback model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MasterFeedback" } } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "feedbackType", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "MasterFeedbackController.find" } }, "/masterTracker": { "get": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "getMasterTracker", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Master list of available tracker types", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "operationId": "ProgramDetailsSupportController.getMasterTracker" } }, "/medicalIssues/search": { "get": { "x-controller-name": "ConfigurationController", "x-operation-name": "searchMedicalIssues", "tags": [ "ConfigurationController" ], "responses": { "200": { "description": "Search active medical issues", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "ConfigurationController.searchMedicalIssues" } }, "/medicalhistory/{id}": { "delete": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "deleteMedicalHistory", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Soft-delete a client medical issue record", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "programId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramDetailsSupportController.deleteMedicalHistory" } }, "/medicalhistory": { "post": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "createMedicalHistory", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Create medical history records", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ProgramDetailsSupportController.createMedicalHistory" }, "get": { "x-controller-name": "ProgramDetailsSupportController", "x-operation-name": "getMedicalHistory", "tags": [ "ProgramDetailsSupportController" ], "responses": { "200": { "description": "Medical history list for a client", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "mhq", "in": "query", "schema": { "type": "string" } }, { "name": "programId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramDetailsSupportController.getMedicalHistory" } }, "/mid-feedback": { "post": { "x-controller-name": "FeedbackCrmController", "x-operation-name": "submitMidFeedback", "tags": [ "FeedbackCrmController" ], "responses": { "200": { "description": "Submit mid-program feedback (public - no auth required)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "feedbackId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId", "clientId", "feedback" ], "properties": { "programId": { "type": "number" }, "clientId": { "type": "number" }, "feedback": { "type": "string" }, "overallRating": { "type": "number" }, "recommendationScale": { "type": "number" } } } } } }, "operationId": "FeedbackCrmController.submitMidFeedback" } }, "/miscellaneouspayment/{paymentId}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateMiscellaneousPayment", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update additional payout" } } } } }, "parameters": [ { "name": "paymentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateMiscellaneousPayment" }, "delete": { "x-controller-name": "PayoutController", "x-operation-name": "deleteMiscellaneousPayment", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete additional payout" } } } } }, "parameters": [ { "name": "paymentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.deleteMiscellaneousPayment" } }, "/miscellaneouspayment": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "createMiscellaneousPayment", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create additional payout" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PayoutController.createMiscellaneousPayment" }, "get": { "x-controller-name": "PayoutController", "x-operation-name": "findMiscellaneousPayments", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Additional payouts" } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.findMiscellaneousPayments" } }, "/monthlypayout/approver/list": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getApproversList", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Payout approvers" } } } } }, "operationId": "PayoutController.getApproversList" } }, "/monthlypayout/approver/upsert": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "upsertApprovers", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Upsert payout approvers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array" } } } }, "operationId": "PayoutController.upsertApprovers" } }, "/monthlypayout/drafts/approve": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "approvePayoutDrafts", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Approve payout drafts" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "draftIds": { "type": "array", "items": { "type": "number" } }, "reportId": { "type": "number" }, "month": { "type": "number" }, "year": { "type": "number" } } } } } }, "operationId": "PayoutController.approvePayoutDrafts" } }, "/monthlypayout/nutritionist-comments": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getNutritionistComments", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist review comments (by draft/report, or broadly by year/status)" } } } } }, "parameters": [ { "name": "draftId", "in": "query", "schema": { "type": "number" } }, { "name": "reportId", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.getNutritionistComments" } }, "/monthlypayout/nutritionist-review": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "submitNutritionistReview", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist accept/dispute comment on a draft" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PayoutController.submitNutritionistReview" } }, "/monthlypayout/payout-approval-comments": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getPayoutApprovalComments", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Approval log for a payout report" } } } } }, "parameters": [ { "name": "reportId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.getPayoutApprovalComments" } }, "/monthlypayout/payout-comment": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "submitPayoutComment", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Log a comment against a payout report" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PayoutController.submitPayoutComment" } }, "/monthlypayout/payout-review": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "submitPayoutReview", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Approve or reject a payout report at the current stage" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "reportId", "status" ], "properties": { "reportId": { "type": "number" }, "status": { "type": "string", "enum": [ "APPROVED", "REJECTED" ] }, "comment": { "type": "string" } } } } } }, "operationId": "PayoutController.submitPayoutReview" } }, "/monthlypayout/ticket-messages": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "addPayoutTicketMessage", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Append a message to a payout ticket" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticketId", "message" ], "properties": { "ticketId": { "type": "number" }, "message": { "type": "string" } } } } } }, "operationId": "PayoutController.addPayoutTicketMessage" } }, "/monthlypayout/tickets/{id}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updatePayoutTicket", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update a payout ticket (edit or status change)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updatePayoutTicket" }, "get": { "x-controller-name": "PayoutController", "x-operation-name": "getPayoutTicket", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Payout ticket detail + full message thread" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.getPayoutTicket" }, "delete": { "x-controller-name": "PayoutController", "x-operation-name": "deletePayoutTicket", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Soft-delete a payout ticket" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.deletePayoutTicket" } }, "/monthlypayout/tickets": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "createPayoutTicket", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Raise a payout ticket against a draft category" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "draftId", "payoutType" ], "properties": { "draftId": { "type": "number" }, "payoutType": { "type": "string" }, "message": { "type": "string" } } } } } }, "operationId": "PayoutController.createPayoutTicket" }, "get": { "x-controller-name": "PayoutController", "x-operation-name": "listPayoutTickets", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List/track payout tickets with message threads" } } } } }, "parameters": [ { "name": "draftId", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.listPayoutTickets" } }, "/monthlypayout": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "findMonthlyPayouts", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Monthly payout list" } } } } }, "parameters": [ { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.findMonthlyPayouts" } }, "/notification-templates/{id}/history": { "get": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "history", "tags": [ "NotificationTemplateController" ], "responses": { "200": { "description": "Prior versions of this template", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationTemplateHistory" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotificationTemplateController.history" } }, "/notification-templates/{id}/preview": { "post": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "preview", "tags": [ "NotificationTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Rendered title/body for this template using sample or supplied variables" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": true }, "title": { "type": "string" }, "body": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "NotificationTemplateController.preview" } }, "/notification-templates/{id}/test-send": { "post": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "testSend", "tags": [ "NotificationTemplateController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Sends a rendered test notification to the current user via Chimely" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "variables": { "type": "object", "additionalProperties": true }, "title": { "type": "string" }, "body": { "type": "string" } } } } }, "required": false, "x-parameter-index": 1 }, "operationId": "NotificationTemplateController.testSend" } }, "/notification-templates/{id}": { "patch": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "updateById", "tags": [ "NotificationTemplateController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "NotificationTemplate PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "NotificationTemplateController.updateById" }, "get": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "findById", "tags": [ "NotificationTemplateController" ], "responses": { "200": { "description": "NotificationTemplate model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotificationTemplateController.findById" }, "delete": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "deleteById", "tags": [ "NotificationTemplateController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "NotificationTemplate DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotificationTemplateController.deleteById" } }, "/notification-templates": { "post": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "create", "tags": [ "NotificationTemplateController" ], "responses": { "200": { "description": "NotificationTemplate model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTemplate" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "NotificationTemplateController.create" }, "get": { "x-controller-name": "NotificationTemplateController", "x-operation-name": "find", "tags": [ "NotificationTemplateController" ], "responses": { "200": { "description": "Array of NotificationTemplate model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationTemplate" } } } } } }, "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "includeHidden", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "NotificationTemplateController.find" } }, "/notifications/inbox-config": { "get": { "x-controller-name": "ChimelyController", "x-operation-name": "getInboxConfig", "tags": [ "ChimelyController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Chimely inbox connection details for the current user" } } } } }, "operationId": "ChimelyController.getInboxConfig" } }, "/nutritionist-payout-reports/{month}": { "get": { "x-controller-name": "MasterCatalogController", "x-operation-name": "payoutReportDetails", "tags": [ "MasterCatalogController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist payout report detail" } } } } }, "parameters": [ { "name": "month", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } } ], "operationId": "MasterCatalogController.payoutReportDetails" } }, "/nutritionist-payout-reports": { "get": { "x-controller-name": "MasterCatalogController", "x-operation-name": "payoutReportMonths", "tags": [ "MasterCatalogController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist payout report months" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } } ], "operationId": "MasterCatalogController.payoutReportMonths" } }, "/nutritionpayout": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getNutritionistPayouts", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutrition payout rows" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.getNutritionistPayouts" } }, "/payment/count": { "get": { "x-controller-name": "PaymentController", "x-operation-name": "count", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Payment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PaymentController.count" } }, "/payment/statistics/summary": { "get": { "x-controller-name": "PaymentController", "x-operation-name": "getStatistics", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalPayments": { "type": "number" }, "totalAmount": { "type": "number" }, "pendingConfirmation": { "type": "number" }, "approved": { "type": "number" }, "unpaid": { "type": "number" } } } } } } }, "parameters": [ { "name": "leadId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PaymentController.getStatistics" } }, "/payment/{paymentId}": { "post": { "x-controller-name": "PaymentController", "x-operation-name": "updateById", "tags": [ "PaymentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Payment update/confirmation" } } } } }, "parameters": [ { "name": "paymentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "paymentStatus" ], "properties": { "leadId": { "type": "number" }, "invoiceType": { "type": "string" }, "paymentStatus": { "type": "string" }, "price": { "type": "number" }, "currencyId": { "type": "number" }, "productPrice": { "type": "number" }, "productTotal": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "PaymentController.updateById" }, "patch": { "x-controller-name": "PaymentController", "x-operation-name": "updateByIdPatch", "tags": [ "PaymentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Payment PATCH success" } } } } }, "parameters": [ { "name": "paymentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "paymentStatus" ], "properties": { "leadId": { "type": "number" }, "invoiceType": { "type": "string" }, "paymentStatus": { "type": "string" }, "price": { "type": "number" }, "currencyId": { "type": "number" }, "productPrice": { "type": "number" }, "productTotal": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "PaymentController.updateByIdPatch" }, "get": { "x-controller-name": "PaymentController", "x-operation-name": "findById", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment model instance with related data", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "paymentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PaymentController.findById" }, "delete": { "x-controller-name": "PaymentController", "x-operation-name": "deleteById", "tags": [ "PaymentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Payment DELETE success" } } } } }, "parameters": [ { "name": "paymentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PaymentController.deleteById" } }, "/payment": { "post": { "x-controller-name": "PaymentController", "x-operation-name": "create", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Payment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Payment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "leadId", "invoiceType", "paymentStatus" ], "properties": { "leadId": { "type": "number" }, "invoiceType": { "type": "string" }, "paymentStatus": { "type": "string" }, "price": { "type": "number" }, "currencyId": { "type": "number" }, "productPrice": { "type": "number" }, "productTotal": { "type": "number" } } } } } }, "operationId": "PaymentController.create" }, "get": { "x-controller-name": "PaymentController", "x-operation-name": "find", "tags": [ "PaymentController" ], "responses": { "200": { "description": "Array of Payment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentWithRelations" } } } } } }, "parameters": [ { "name": "pq", "in": "query", "schema": { "type": "number" } }, { "name": "paymentStatus", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "PaymentController.find" } }, "/payout/annual-summary": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "annualSummary", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Per-month draft totals for a year (optionally per user)" } } } } }, "parameters": [ { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.annualSummary" } }, "/payout/breakdown/bulk": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getPayoutBreakdownBulk", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Component-wise payout breakdown for every draft in a month, for CSV export" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.getPayoutBreakdownBulk" } }, "/payout/draft/{draftId}/invoice": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "draftInvoice", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "HTML invoice for a payout draft" } } } } }, "parameters": [ { "name": "draftId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.draftInvoice" } }, "/payout/draft/{id}": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "getPayoutDraftHeader", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Payout draft header (crm-app PayoutDraftController::show)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.getPayoutDraftHeader" } }, "/payout/drafts/export": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "exportDrafts", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "CSV export of payout drafts for a month" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.exportDrafts" } }, "/payout/program-forecast": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "programForecast", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "6-month program-based payout forecast matrix, starting at the given month/year" } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutController.programForecast" } }, "/payout/reconcile": { "post": { "x-controller-name": "PayoutImportController", "x-operation-name": "reconcilePayoutMonth", "tags": [ "PayoutImportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Diff payout_drafts totals for a month against an uploaded reference export (user_id/user_name + total_amount columns)" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "PayoutImportController.reconcilePayoutMonth" } }, "/payout/regenerate": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "regenerate", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Regenerate payout drafts for a month" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PayoutController.regenerate" } }, "/permission-lists": { "get": { "x-controller-name": "PermissionController", "x-operation-name": "list", "tags": [ "PermissionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Permission groups (modules) with their child actions and owning apps" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } } ], "operationId": "PermissionController.list" } }, "/personal-wellness-plan-preview": { "post": { "x-controller-name": "PersonalWellnessPlanPreviewController", "x-operation-name": "preview", "tags": [ "PersonalWellnessPlanPreviewController" ], "responses": { "200": { "description": "Return value of PersonalWellnessPlanPreviewController.preview" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId" ], "properties": { "programId": { "anyOf": [ { "type": "number" }, { "type": "string" } ] } } } } } }, "operationId": "PersonalWellnessPlanPreviewController.preview" } }, "/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/post-consult-notes": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getPostConsultNotes", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Latest post-consult notes for a program", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "program_id", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramController.getPostConsultNotes" } }, "/product/config": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getProductConfig", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Product configuration" } } } } }, "operationId": "AdminSupportController.getProductConfig" } }, "/product/count": { "get": { "x-controller-name": "ProductController", "x-operation-name": "count", "tags": [ "ProductController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Product count" } } } } }, "operationId": "ProductController.count" } }, "/product/event/{productId}": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getProductEvents", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Product feature events" } } } } }, "parameters": [ { "name": "productId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AdminSupportController.getProductEvents" } }, "/product/event": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "saveProductEvents", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Save product feature events" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdminSupportController.saveProductEvents" } }, "/product/system-feature/{productId}": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "saveProductSystemFeatures", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Save product system feature events" } } } } }, "parameters": [ { "name": "productId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "AdminSupportController.saveProductSystemFeatures" }, "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getProductSystemFeatures", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Product system feature events" } } } } }, "parameters": [ { "name": "productId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AdminSupportController.getProductSystemFeatures" } }, "/product/update-product-hold-setting/{id}": { "post": { "x-controller-name": "ProductController", "x-operation-name": "updateHoldSettingById", "tags": [ "ProductController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update product hold setting" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "ProductController.updateHoldSettingById" } }, "/product/{id}": { "post": { "x-controller-name": "ProductController", "x-operation-name": "updateById", "tags": [ "ProductController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update product" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "ProductController.updateById" }, "get": { "x-controller-name": "ProductController", "x-operation-name": "findById", "tags": [ "ProductController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Product details" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ProductController.findById" } }, "/product": { "post": { "x-controller-name": "ProductController", "x-operation-name": "create", "tags": [ "ProductController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create product" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ProductController.create" }, "get": { "x-controller-name": "ProductController", "x-operation-name": "find", "tags": [ "ProductController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Product list" } } } } }, "parameters": [ { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "searchbar", "in": "query", "schema": { "type": "string" } }, { "name": "pq", "in": "query", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "nextToken", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProductController.find" } }, "/product-groups/{id}/products": { "put": { "x-controller-name": "ProductGroupController", "x-operation-name": "setProducts", "tags": [ "ProductGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Products in the group replaced" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProductGroupController.setProducts" } }, "/product-groups/{id}": { "patch": { "x-controller-name": "ProductGroupController", "x-operation-name": "updateById", "tags": [ "ProductGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Product group updated" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProductGroupController.updateById" }, "get": { "x-controller-name": "ProductGroupController", "x-operation-name": "findById", "tags": [ "ProductGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "A product group with its products and templates" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProductGroupController.findById" }, "delete": { "x-controller-name": "ProductGroupController", "x-operation-name": "deleteById", "tags": [ "ProductGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Product group deleted" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProductGroupController.deleteById" } }, "/product-groups": { "post": { "x-controller-name": "ProductGroupController", "x-operation-name": "create", "tags": [ "ProductGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Created product group" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "ProductGroupController.create" }, "get": { "x-controller-name": "ProductGroupController", "x-operation-name": "find", "tags": [ "ProductGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Product groups with product and template counts" } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "includeInactive", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "ProductGroupController.find" } }, "/productPrice/count": { "get": { "x-controller-name": "ProductPriceController", "x-operation-name": "count", "tags": [ "ProductPriceController" ], "responses": { "200": { "description": "ProductPrice model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProductPrice.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProductPriceController.count" } }, "/productPrice/{id}": { "post": { "x-controller-name": "ProductPriceController", "x-operation-name": "updateByIdPost", "tags": [ "ProductPriceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductPrice POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProductPriceController.updateByIdPost" }, "put": { "x-controller-name": "ProductPriceController", "x-operation-name": "replaceById", "tags": [ "ProductPriceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductPrice PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice" } } }, "x-parameter-index": 1 }, "operationId": "ProductPriceController.replaceById" }, "patch": { "x-controller-name": "ProductPriceController", "x-operation-name": "updateById", "tags": [ "ProductPriceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductPrice PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProductPriceController.updateById" }, "get": { "x-controller-name": "ProductPriceController", "x-operation-name": "findById", "tags": [ "ProductPriceController" ], "responses": { "200": { "description": "ProductPrice model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice.Filter" } } } } ], "operationId": "ProductPriceController.findById" }, "delete": { "x-controller-name": "ProductPriceController", "x-operation-name": "deleteById", "tags": [ "ProductPriceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductPrice DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProductPriceController.deleteById" } }, "/productPrice": { "post": { "x-controller-name": "ProductPriceController", "x-operation-name": "create", "tags": [ "ProductPriceController" ], "responses": { "200": { "description": "ProductPrice model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "ProductPriceController.create" }, "get": { "x-controller-name": "ProductPriceController", "x-operation-name": "find", "tags": [ "ProductPriceController" ], "responses": { "200": { "description": "Array of ProductPrice model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPriceWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice.Filter1" } } } } ], "operationId": "ProductPriceController.find" } }, "/productType/count": { "get": { "x-controller-name": "ProductTypeController", "x-operation-name": "count", "tags": [ "ProductTypeController" ], "responses": { "200": { "description": "ProductType model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ProductType.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProductTypeController.count" } }, "/productType/{id}": { "post": { "x-controller-name": "ProductTypeController", "x-operation-name": "updateByIdPost", "tags": [ "ProductTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductType POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProductTypeController.updateByIdPost" }, "put": { "x-controller-name": "ProductTypeController", "x-operation-name": "replaceById", "tags": [ "ProductTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductType PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType" } } }, "x-parameter-index": 1 }, "operationId": "ProductTypeController.replaceById" }, "patch": { "x-controller-name": "ProductTypeController", "x-operation-name": "updateById", "tags": [ "ProductTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductType PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProductTypeController.updateById" }, "get": { "x-controller-name": "ProductTypeController", "x-operation-name": "findById", "tags": [ "ProductTypeController" ], "responses": { "200": { "description": "ProductType model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType.Filter" } } } } ], "operationId": "ProductTypeController.findById" }, "delete": { "x-controller-name": "ProductTypeController", "x-operation-name": "deleteById", "tags": [ "ProductTypeController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProductType DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProductTypeController.deleteById" } }, "/productType": { "post": { "x-controller-name": "ProductTypeController", "x-operation-name": "create", "tags": [ "ProductTypeController" ], "responses": { "200": { "description": "ProductType model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "ProductTypeController.create" }, "get": { "x-controller-name": "ProductTypeController", "x-operation-name": "find", "tags": [ "ProductTypeController" ], "responses": { "200": { "description": "Array of ProductType model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductTypeWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductType.Filter1" } } } } ], "operationId": "ProductTypeController.find" } }, "/products/{id}/product-groups": { "put": { "x-controller-name": "ProductGroupController", "x-operation-name": "setProductGroups", "tags": [ "ProductGroupController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Groups of a product replaced" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProductGroupController.setProductGroups" }, "get": { "x-controller-name": "ProductGroupController", "x-operation-name": "productGroups", "tags": [ "ProductGroupController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Groups a product belongs to" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProductGroupController.productGroups" } }, "/program/analysis": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getAnalytics", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Program analytics", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "qp", "in": "query", "schema": { "type": "string" } }, { "name": "ni", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramController.getAnalytics" } }, "/program/assignment/history/{leadId}": { "get": { "x-controller-name": "LeadController", "x-operation-name": "getProgramAssignmentHistory", "tags": [ "LeadController" ], "responses": { "200": { "description": "Get program assignment history for a lead", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramAssignmentHistory" } } } } } }, "parameters": [ { "name": "leadId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LeadController.getProgramAssignmentHistory" } }, "/program/count": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "count", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Program model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Program.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ProgramController.count" } }, "/program/dashboard-summary": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "dashboardSummary", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Aggregate program counts for the dashboard tiles", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "productType", "in": "query", "schema": { "type": "string" } }, { "name": "assignedNutritionistId", "in": "query", "schema": { "type": "number" } }, { "name": "reportingTo", "in": "query", "schema": { "type": "number" } }, { "name": "assignedAsNutritionist", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "ProgramController.dashboardSummary" } }, "/program/filter-options/search": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "searchProgramFilterOptions", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Matching values for one server-searched Programs / Consults list column filter", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "parameters": [ { "name": "column", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProgramController.searchProgramFilterOptions" } }, "/program/filter-options": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "programFilterOptions", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Distinct values for the admin Programs / Consults list filter dropdowns", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "ProgramController.programFilterOptions" } }, "/program/{programId}/call-log-notes/{noteId}": { "patch": { "x-controller-name": "ProgramCallLogNoteController", "x-operation-name": "update", "tags": [ "ProgramCallLogNoteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update a note" } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "noteId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "note" ], "properties": { "note": { "type": "string" } } } } }, "x-parameter-index": 2 }, "operationId": "ProgramCallLogNoteController.update" }, "delete": { "x-controller-name": "ProgramCallLogNoteController", "x-operation-name": "delete", "tags": [ "ProgramCallLogNoteController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete a note" } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "noteId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramCallLogNoteController.delete" } }, "/program/{programId}/call-log-notes": { "post": { "x-controller-name": "ProgramCallLogNoteController", "x-operation-name": "create", "tags": [ "ProgramCallLogNoteController" ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "description": "Create a note for a program" } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "note" ], "properties": { "note": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "ProgramCallLogNoteController.create" }, "get": { "x-controller-name": "ProgramCallLogNoteController", "x-operation-name": "list", "tags": [ "ProgramCallLogNoteController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List notes recorded for a program" } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramCallLogNoteController.list" } }, "/program/{programId}/call-logs/{callLogId}": { "patch": { "x-controller-name": "EventController", "x-operation-name": "updateCompletedCallLog", "tags": [ "EventController" ], "responses": { "200": { "description": "Completed call log updated", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "callLogId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "datetimeOfCall", "callSummary" ], "properties": { "datetimeOfCall": { "type": "string" }, "callSummary": { "type": "string" }, "internalTeamComment": { "type": "string" }, "modeOfCommunication": { "type": "string" } } } } }, "x-parameter-index": 2 }, "operationId": "EventController.updateCompletedCallLog" } }, "/program/{progId}/care-team": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getCareTeam", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Care team members from program assignments and Vertical Head assignments", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.getCareTeam" } }, "/program/{id}/close-details": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getProgramCloseDetails", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Close request details for a program", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.getProgramCloseDetails" } }, "/program/{id}/consult-notes/{callLogId}/internal-team-comment": { "post": { "x-controller-name": "ProgramController", "x-operation-name": "updateConsultNoteInternalTeamComment", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Update internal team comment for a consult note communication entry", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "callLogId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 2 }, "operationId": "ProgramController.updateConsultNoteInternalTeamComment" } }, "/program/{id}/consult-notes": { "post": { "x-controller-name": "ProgramController", "x-operation-name": "createConsultNotes", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Create consult note communication entry", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProgramController.createConsultNotes" } }, "/program/{id}/details": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getProgramDetails", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Program details by program ID including active requests", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.getProgramDetails" } }, "/program/{id}/feature-permissions": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getProgramFeaturePermissions", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Caller-effective view/create/edit/delete booleans for every program feature. Drives the Program Details v2 UI gating; the Admin UI still reads program_features.view_access directly.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "featureId": { "type": "number" }, "view": { "type": "boolean" }, "create": { "type": "boolean" }, "edit": { "type": "boolean" }, "delete": { "type": "boolean" } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.getProgramFeaturePermissions" } }, "/program/{progId}/food-plan-email-retry": { "post": { "x-controller-name": "ProgramController", "x-operation-name": "retryFoodPlanEmail", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Queue the latest approved food plan email for immediate retry", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.retryFoodPlanEmail" } }, "/program/{progId}/food-plan-email-status": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getFoodPlanEmailStatus", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Delivery state of the latest approved food plan email for a program", "content": { "application/json": { "schema": { "type": "object", "properties": { "pending": { "type": "boolean" }, "delivered": { "type": "boolean" }, "canRetry": { "type": "boolean" }, "state": { "type": "string" }, "fileUploadId": { "type": "number", "nullable": true }, "scheduledAt": { "type": "string", "nullable": true }, "lastError": { "type": "string", "nullable": true } } } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.getFoodPlanEmailStatus" } }, "/program/{id}/hold-allowance": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getHoldAllowance", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Hold days a new hold starting on holdStartDate may cover", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "holdStartDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProgramController.getHoldAllowance" } }, "/program/{subId}/nutridashboard": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getNutriDashboardSummary", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Nutrition dashboard member summary", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "subId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "schema": { "type": "string" } } ], "operationId": "ProgramController.getNutriDashboardSummary" } }, "/program/{userId}/nutridashboard": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "nutritionistDashboard", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist dashboard counters" } } } } }, "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AdminSupportController.nutritionistDashboard" } }, "/program/{id}/status-history": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getProgramStatusHistory", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Canonical program lifecycle and status history", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.getProgramStatusHistory" } }, "/program/{subId}": { "post": { "x-controller-name": "ProgramController", "x-operation-name": "updateBySubIdPost", "tags": [ "ProgramController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Program POST (update) success" } } } } }, "parameters": [ { "name": "subId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "cq", "in": "query", "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProgramController.updateBySubIdPost" }, "patch": { "x-controller-name": "ProgramController", "x-operation-name": "updateBySubId", "tags": [ "ProgramController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Program PATCH success" } } } } }, "parameters": [ { "name": "subId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "cq", "in": "query", "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "ProgramController.updateBySubId" }, "get": { "x-controller-name": "ProgramController", "x-operation-name": "findBySubId", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Program model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "subId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "cq", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramController.findBySubId" } }, "/program/{id}": { "put": { "x-controller-name": "ProgramController", "x-operation-name": "replaceById", "tags": [ "ProgramController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Program PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } }, "x-parameter-index": 1 }, "operationId": "ProgramController.replaceById" }, "delete": { "x-controller-name": "ProgramController", "x-operation-name": "deleteById", "tags": [ "ProgramController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Program DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramController.deleteById" } }, "/program": { "post": { "x-controller-name": "ProgramController", "x-operation-name": "create", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Program model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Program" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "ProgramController.create" }, "get": { "x-controller-name": "ProgramController", "x-operation-name": "find", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Array of Program model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProgramWithRelations" } } } } } }, "parameters": [ { "name": "productType", "in": "query", "schema": { "type": "string" } }, { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "searchbar", "in": "query", "schema": { "type": "string" } }, { "name": "progStatus", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } }, { "name": "dateFilterScope", "in": "query", "schema": { "type": "string" } }, { "name": "nextToken", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "cq", "in": "query", "schema": { "type": "string" } }, { "name": "pq", "in": "query", "schema": { "type": "string" } }, { "name": "assignedTo", "in": "query", "schema": { "type": "number" } }, { "name": "reportingTo", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } }, { "name": "assignedNutritionistId", "in": "query", "schema": { "type": "number" } }, { "name": "smeId", "in": "query", "schema": { "type": "number" } }, { "name": "programState", "in": "query", "schema": { "type": "string" } }, { "name": "productCode", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "isProgramStartedFlag", "in": "query", "schema": { "type": "boolean" } }, { "name": "isRedFlag", "in": "query", "schema": { "type": "boolean" } }, { "name": "isVip", "in": "query", "schema": { "type": "boolean" } }, { "name": "isBdClient", "in": "query", "schema": { "type": "boolean" } }, { "name": "isInternational", "in": "query", "schema": { "type": "boolean" } }, { "name": "isDomestic", "in": "query", "schema": { "type": "boolean" } }, { "name": "activeTimelineOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "isProgramUnresponsiveFlag", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "assignedAsNutritionist", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeFacets", "in": "query", "schema": { "type": "boolean" } }, { "name": "transferredOutOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "transferredInOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "idsOnly", "in": "query", "schema": { "type": "boolean" } }, { "name": "roadmapPending", "in": "query", "schema": { "type": "boolean" } }, { "name": "renewalDue", "in": "query", "schema": { "type": "boolean" } }, { "name": "verticalHeadOnly", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "ProgramController.find" } }, "/program-assignments/{id}/status": { "patch": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "updateStatus", "tags": [ "ProgramAssignmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ProgramAssignmentHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "progStatus": { "type": "string" }, "assignStatus": { "type": "string" }, "notes": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "ProgramAssignmentController.updateStatus" } }, "/program-audit-logs/client-list/{nutritionistId}": { "get": { "x-controller-name": "ProgramAuditController", "x-operation-name": "getNutritionistClientList", "tags": [ "ProgramAuditController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist program list for audit filters" } } } } }, "parameters": [ { "name": "nutritionistId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramAuditController.getNutritionistClientList" } }, "/program-audit-logs/summary": { "post": { "x-controller-name": "ProgramAuditController", "x-operation-name": "getNutritionistSummary", "tags": [ "ProgramAuditController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionist audit summary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "date", "nutritionist_id" ], "properties": { "date": { "type": "string" }, "nutritionist_id": { "type": "number" } } } } } }, "operationId": "ProgramAuditController.getNutritionistSummary" } }, "/program-audit-logs": { "get": { "x-controller-name": "ProgramAuditController", "x-operation-name": "getAuditLogs", "tags": [ "ProgramAuditController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Program audit logs" } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "nutritionist_id", "in": "query", "schema": { "type": "number" } }, { "name": "program_id", "in": "query", "schema": { "type": "number" } }, { "name": "current_status", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "per_page", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramAuditController.getAuditLogs" } }, "/program-audit-reports/generate": { "post": { "x-controller-name": "ProgramAuditController", "x-operation-name": "generateAuditReports", "tags": [ "ProgramAuditController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Generate the program audit reports for a date" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string" } } } } }, "required": false }, "operationId": "ProgramAuditController.generateAuditReports" } }, "/program-audit-reports": { "get": { "x-controller-name": "ProgramAuditController", "x-operation-name": "getAuditReports", "tags": [ "ProgramAuditController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Program audit reports" } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "from_date", "in": "query", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "schema": { "type": "string" } }, { "name": "nutritionist_id", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "per_page", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramAuditController.getAuditReports" } }, "/program-feature/{id}": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "updateProgramFeature", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update program feature" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "AdminSupportController.updateProgramFeature" }, "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getProgramFeatureById", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Program feature details" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdminSupportController.getProgramFeatureById" } }, "/program-feature": { "post": { "x-controller-name": "AdminSupportController", "x-operation-name": "createProgramFeature", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create program feature" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AdminSupportController.createProgramFeature" }, "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getProgramFeatures", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Program feature list" } } } } }, "parameters": [ { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "searchbar", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } } ], "operationId": "AdminSupportController.getProgramFeatures" } }, "/program-feedback/by-program/{programId}": { "get": { "x-controller-name": "FeedbackCrmController", "x-operation-name": "getFeedbackByProgram", "tags": [ "FeedbackCrmController" ], "responses": { "200": { "description": "Get all feedback for a program", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "programId": { "type": "number" }, "feedback": { "type": "array" } } } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FeedbackCrmController.getFeedbackByProgram" } }, "/program-feedback/file/upload": { "post": { "x-controller-name": "FeedbackCrmController", "x-operation-name": "uploadFeedbackFiles", "tags": [ "FeedbackCrmController" ], "responses": { "200": { "description": "Upload feedback attachments to S3", "content": { "application/json": { "schema": { "type": "object", "required": [ "files" ], "properties": { "file": { "type": "string" }, "files": { "type": "array", "items": { "type": "object", "required": [ "file", "url", "fileName", "contentType" ], "properties": { "file": { "type": "string" }, "url": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" } } } } } } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "FeedbackCrmController.uploadFeedbackFiles" } }, "/program-feedback/{id}": { "put": { "x-controller-name": "FeedbackCrmController", "x-operation-name": "actionFeedback", "tags": [ "FeedbackCrmController" ], "responses": { "200": { "description": "Tag feedback and/or take action", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "feedbackId": { "type": "number" }, "action": { "type": "string" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tag": { "type": "string", "description": "POSITIVE, NEGATIVE, NEITHER, REJECT" }, "tagUsers": { "type": "array", "items": { "type": "number" } }, "useForTestimonial": { "type": "boolean" }, "useForEscalation": { "type": "boolean" }, "action": { "type": "string", "description": "REFUND, TRANSFER_PROGRAM, EXTEND_PROGRAM, TRANSFER_NUTRITIONIST, CONTINUE_AS_IS_WITH_HANDHOLDING" }, "actionSummary": { "type": "string" }, "gapIdentification": { "type": "string" }, "scopeOfImprovement": { "type": "string" }, "faultDetection": { "type": "string" }, "nutritionistView": { "type": "string" }, "generalClassification": { "type": "string" }, "generalClassificationComment": { "type": "string" }, "clientFaultClassification": { "type": "string" }, "feedbackTagComment": { "type": "string" }, "callDone": { "type": "boolean" }, "callDate": { "type": "string" }, "emailSent": { "type": "boolean" }, "emailSentDate": { "type": "string" }, "lastCoachingDate": { "type": "string" }, "last_coaching_date": { "type": "string" }, "hnAcknowledgmentDate": { "type": "string" }, "hn_acknowledgment_date": { "type": "string" }, "newEndDate": { "type": "string" }, "new_end_date": { "type": "string" }, "transferToClientId": { "type": "number" }, "transfer_to_client_id": { "type": "number" }, "actionTakenBy": { "type": "number" }, "action_taken_by": { "type": "number" }, "action_taken": { "type": "string" }, "action_summary": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "FeedbackCrmController.actionFeedback" } }, "/program-feedback": { "post": { "x-controller-name": "FeedbackCrmController", "x-operation-name": "createFeedback", "tags": [ "FeedbackCrmController" ], "responses": { "200": { "description": "Create program feedback (CRM staff entry)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "feedbackId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId", "clientId", "feedback" ], "properties": { "programId": { "type": "number" }, "clientId": { "type": "number" }, "feedback": { "type": "string" }, "feedbackReceivedDate": { "type": "string" }, "nutritionistId": { "type": "number" }, "nutritionistName": { "type": "string" }, "programName": { "type": "string" }, "clientName": { "type": "string" }, "file": { "type": "string" }, "files": { "type": "array", "items": { "type": "string" } }, "source": { "type": "string" }, "overallRating": { "type": "number" }, "nutritionistRating": { "type": "number" }, "feelCared": { "type": "boolean" }, "recommendationScale": { "type": "number" }, "useTestimonialOnSocialMedia": { "type": "string" }, "likeToRenew": { "type": "boolean" }, "goalAchived": { "type": "boolean" }, "createdByUserId": { "type": "number" }, "createdByName": { "type": "string" } } } } } }, "operationId": "FeedbackCrmController.createFeedback" } }, "/program-renewal-request/update-comment": { "post": { "x-controller-name": "RenewalController", "x-operation-name": "updateRenewalComment", "tags": [ "RenewalController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update comment for a renewal request and its associated lead" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "comment", "client_wants_new_coach" ], "properties": { "id": { "type": "number" }, "comment": { "type": "string" }, "client_wants_new_coach": { "type": "string" } } } } } }, "operationId": "RenewalController.updateRenewalComment" } }, "/program-renewal-request/{id}": { "put": { "x-controller-name": "RenewalController", "x-operation-name": "updateRenewalRequest", "tags": [ "RenewalController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update a renewal request" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "program_id": { "type": "number" }, "client_id": { "type": "number" }, "product_old_tier": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "RenewalController.updateRenewalRequest" }, "get": { "x-controller-name": "RenewalController", "x-operation-name": "getRenewalRequest", "tags": [ "RenewalController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get a single renewal request by ID" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RenewalController.getRenewalRequest" }, "delete": { "x-controller-name": "RenewalController", "x-operation-name": "deleteRenewalRequest", "tags": [ "RenewalController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft-delete a renewal request" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RenewalController.deleteRenewalRequest" } }, "/program-renewal-request": { "get": { "x-controller-name": "RenewalController", "x-operation-name": "listRenewalRequests", "tags": [ "RenewalController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List renewal requests with filters" } } } } }, "parameters": [ { "name": "program_id", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "nutritionist_id", "in": "query", "schema": { "type": "number" } }, { "name": "tier_id", "in": "query", "schema": { "type": "number" } }, { "name": "product_id", "in": "query", "schema": { "type": "number" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } } ], "operationId": "RenewalController.listRenewalRequests" } }, "/program-transfer-remaining-days/{programId}": { "get": { "x-controller-name": "TransferNutritionistController", "x-operation-name": "remainingDays", "tags": [ "TransferNutritionistController" ], "responses": { "200": { "description": "Return value of TransferNutritionistController.remainingDays" } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "lastCoachingDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "TransferNutritionistController.remainingDays" } }, "/programClientHistory": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getProgramClientHistory", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Programs previously/currently taken by the selected client", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "programId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramController.getProgramClientHistory" } }, "/programHistory": { "get": { "x-controller-name": "ProgramController", "x-operation-name": "getProgramHistory", "tags": [ "ProgramController" ], "responses": { "200": { "description": "Program status and assignment history", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "phq", "in": "query", "schema": { "type": "number" } } ], "operationId": "ProgramController.getProgramHistory" } }, "/programbalance/{id}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateProgramBalance", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update program payout opening balance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateProgramBalance" } }, "/programbalance": { "get": { "x-controller-name": "PayoutController", "x-operation-name": "listProgramBalances", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Editable program payout opening balances" } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.listProgramBalances" } }, "/programs/{programId}/assigned-users": { "get": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "getAssignedUsers", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "Get assigned users for a program", "content": { "application/json": { "schema": { "type": "object", "properties": { "programId": { "type": "number" }, "users": { "type": "array" }, "nutritionists": { "type": "array" }, "qc": { "type": "array" }, "hn": { "type": "array" } } } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramAssignmentController.getAssignedUsers" } }, "/programs/{programId}/dates": { "get": { "x-controller-name": "ProgramAssignmentController", "x-operation-name": "getProgramDates", "tags": [ "ProgramAssignmentController" ], "responses": { "200": { "description": "Get program dates", "content": { "application/json": { "schema": { "type": "object", "properties": { "programId": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "assignedDate": { "type": "string" }, "duration": { "type": "number" } } } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ProgramAssignmentController.getProgramDates" } }, "/programs/{programId}/personal-wellness-plan.pdf": { "get": { "x-controller-name": "PersonalWellnessPlanController", "x-operation-name": "download", "tags": [ "PersonalWellnessPlanController" ], "responses": { "200": { "description": "Return value of PersonalWellnessPlanController.download" } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PersonalWellnessPlanController.download" } }, "/question": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getQuestions", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Assessment question bank" } } } } }, "parameters": [ { "name": "corporateId", "in": "query", "schema": { "type": "string" } } ], "operationId": "AdminSupportController.getQuestions" } }, "/randr/access": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "randrAccess", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "RNR Calculator access for the logged-in user" } } } } }, "operationId": "ReportsController.randrAccess" } }, "/randr/adjust": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "randrAdjust", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "R&R adjustment result" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.randrAdjust" } }, "/randr/backfill": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "randrBackfill", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "R&R backfill result" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.randrBackfill" } }, "/randr/config": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "updateRandRConfig", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Updated R&R category config" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.updateRandRConfig" }, "get": { "x-controller-name": "ReportsController", "x-operation-name": "getRandRConfig", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "R&R category config" } } } } }, "parameters": [ { "name": "team", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.getRandRConfig" } }, "/randr/me": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "randrMe", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Logged-in nutritionist's own R&R standing" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "string" } }, { "name": "nutritionistId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ReportsController.randrMe" } }, "/randr/roster": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "randrRoster", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Nutritionists covered by R&R" } } } } }, "operationId": "ReportsController.randrRoster" } }, "/randr/team": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "randrMoveTeam", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "R&R team move result" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.randrMoveTeam" }, "get": { "x-controller-name": "ReportsController", "x-operation-name": "randrTeam", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "The logged-in user's team on the R&R roster" } } } } }, "operationId": "ReportsController.randrTeam" } }, "/randr": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "randrPost", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "R&R data" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.randrPost" }, "get": { "x-controller-name": "ReportsController", "x-operation-name": "randr", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "R&R data" } } } } }, "parameters": [ { "name": "year", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.randr" } }, "/red-flag-request/{id}/action": { "post": { "x-controller-name": "RequestController", "x-operation-name": "handleDedicatedRedFlagAction", "tags": [ "RequestController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Handle red flag action from head nutritionist" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "RequestController.handleDedicatedRedFlagAction" } }, "/red-flag-request/{id}": { "get": { "x-controller-name": "RedFlagController", "x-operation-name": "findById", "tags": [ "RedFlagController" ], "responses": { "200": { "description": "Get a Red Flag request", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RedFlagController.findById" } }, "/red-flag-request": { "post": { "x-controller-name": "RedFlagController", "x-operation-name": "create", "tags": [ "RedFlagController" ], "responses": { "200": { "description": "Create a Red Flag request and flag the program immediately", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "program_id" ], "additionalProperties": true } } } }, "operationId": "RedFlagController.create" } }, "/refundReason/count": { "get": { "x-controller-name": "RefundReasonController", "x-operation-name": "count", "tags": [ "RefundReasonController" ], "responses": { "200": { "description": "RefundReason model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RefundReason.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RefundReasonController.count" } }, "/refundReason/{id}": { "post": { "x-controller-name": "RefundReasonController", "x-operation-name": "updateByIdPost", "tags": [ "RefundReasonController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RefundReason POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "RefundReasonController.updateByIdPost" }, "put": { "x-controller-name": "RefundReasonController", "x-operation-name": "replaceById", "tags": [ "RefundReasonController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RefundReason PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundReason" } } }, "x-parameter-index": 1 }, "operationId": "RefundReasonController.replaceById" }, "patch": { "x-controller-name": "RefundReasonController", "x-operation-name": "updateById", "tags": [ "RefundReasonController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RefundReason PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "RefundReasonController.updateById" }, "get": { "x-controller-name": "RefundReasonController", "x-operation-name": "findById", "tags": [ "RefundReasonController" ], "responses": { "200": { "description": "RefundReason model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundReason.Filter" } } } } ], "operationId": "RefundReasonController.findById" }, "delete": { "x-controller-name": "RefundReasonController", "x-operation-name": "deleteById", "tags": [ "RefundReasonController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RefundReason DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RefundReasonController.deleteById" } }, "/refundReason": { "post": { "x-controller-name": "RefundReasonController", "x-operation-name": "create", "tags": [ "RefundReasonController" ], "responses": { "200": { "description": "RefundReason model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundReason" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "RefundReasonController.create" }, "get": { "x-controller-name": "RefundReasonController", "x-operation-name": "find", "tags": [ "RefundReasonController" ], "responses": { "200": { "description": "Array of RefundReason model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RefundReasonWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundReason.Filter1" } } } } ], "operationId": "RefundReasonController.find" } }, "/refundRequest/update-status/{id}": { "post": { "x-controller-name": "RefundRequestController", "x-operation-name": "updateStatus", "tags": [ "RefundRequestController" ], "responses": { "200": { "description": "Update refund request status (3-stage approval)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "RefundRequestController.updateStatus" } }, "/refundRequest/{id}/resend-refund-email": { "post": { "x-controller-name": "RefundRequestController", "x-operation-name": "resendRefundApprovalEmail", "tags": [ "RefundRequestController" ], "responses": { "200": { "description": "Resend refund approval email", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RefundRequestController.resendRefundApprovalEmail" } }, "/refundRequest/{id}": { "post": { "x-controller-name": "RefundRequestController", "x-operation-name": "updatePost", "tags": [ "RefundRequestController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update a refund request (POST)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "RefundRequestController.updatePost" }, "patch": { "x-controller-name": "RefundRequestController", "x-operation-name": "update", "tags": [ "RefundRequestController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update a refund request" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "RefundRequestController.update" }, "get": { "x-controller-name": "RefundRequestController", "x-operation-name": "show", "tags": [ "RefundRequestController" ], "responses": { "200": { "description": "Get a single refund request with relations", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RefundRequestController.show" }, "delete": { "x-controller-name": "RefundRequestController", "x-operation-name": "destroy", "tags": [ "RefundRequestController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Soft delete a refund request" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RefundRequestController.destroy" } }, "/refundRequest": { "post": { "x-controller-name": "RefundRequestController", "x-operation-name": "store", "tags": [ "RefundRequestController" ], "responses": { "200": { "description": "Create a new refund request", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "RefundRequestController.store" }, "get": { "x-controller-name": "RefundRequestController", "x-operation-name": "index", "tags": [ "RefundRequestController" ], "responses": { "200": { "description": "List refund requests with filters", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "program_id", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "per_page", "in": "query", "schema": { "type": "number" } } ], "operationId": "RefundRequestController.index" } }, "/report/count": { "get": { "x-controller-name": "MedicalReportController", "x-operation-name": "count", "tags": [ "MedicalReportController" ], "responses": { "200": { "description": "MedicalReport model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "MedicalReport.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "MedicalReportController.count" } }, "/report/file": { "get": { "x-controller-name": "MedicalReportController", "x-operation-name": "proxyMedicalReportFile", "tags": [ "MedicalReportController" ], "responses": { "200": { "description": "Proxy a medical report file from the available CRM host", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "parameters": [ { "name": "path", "in": "query", "schema": { "type": "string" } } ], "operationId": "MedicalReportController.proxyMedicalReportFile" } }, "/report/upload": { "post": { "x-controller-name": "MedicalReportController", "x-operation-name": "upload", "tags": [ "MedicalReportController" ], "responses": { "200": { "description": "Uploaded medical report model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MedicalReport" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "MedicalReportController.upload" } }, "/report/{id}": { "post": { "x-controller-name": "MedicalReportController", "x-operation-name": "updateByIdPost", "tags": [ "MedicalReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MedicalReport POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "MedicalReportController.updateByIdPost" }, "put": { "x-controller-name": "MedicalReportController", "x-operation-name": "replaceById", "tags": [ "MedicalReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MedicalReport PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MedicalReport" } } }, "x-parameter-index": 1 }, "operationId": "MedicalReportController.replaceById" }, "patch": { "x-controller-name": "MedicalReportController", "x-operation-name": "updateById", "tags": [ "MedicalReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MedicalReport PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "MedicalReportController.updateById" }, "get": { "x-controller-name": "MedicalReportController", "x-operation-name": "findById", "tags": [ "MedicalReportController" ], "responses": { "200": { "description": "MedicalReport model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MedicalReport.Filter" } } } } ], "operationId": "MedicalReportController.findById" }, "delete": { "x-controller-name": "MedicalReportController", "x-operation-name": "deleteById", "tags": [ "MedicalReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "MedicalReport DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "MedicalReportController.deleteById" } }, "/report": { "post": { "x-controller-name": "MedicalReportController", "x-operation-name": "create", "tags": [ "MedicalReportController" ], "responses": { "200": { "description": "MedicalReport model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MedicalReport" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "MedicalReportController.create" }, "get": { "x-controller-name": "MedicalReportController", "x-operation-name": "find", "tags": [ "MedicalReportController" ], "responses": { "200": { "description": "Array of MedicalReport model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MedicalReportWithRelations" } } } } } }, "parameters": [ { "name": "leadId", "in": "query", "schema": { "type": "number" } }, { "name": "clientId", "in": "query", "schema": { "type": "number" } }, { "name": "programId", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MedicalReport.Filter1" } } } }, { "name": "subId", "in": "query", "schema": { "type": "number" } } ], "operationId": "MedicalReportController.find" } }, "/reports/analytics": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "analytics", "tags": [ "ReportsController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Reports analytics data" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.analytics" } }, "/reports/feedback-deck": { "get": { "x-controller-name": "FeedbackDeckReportController", "x-operation-name": "feedbackDeck", "tags": [ "FeedbackDeckReportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Row-level feedback report for the HN deck (one calendar month)" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "operationId": "FeedbackDeckReportController.feedbackDeck" } }, "/request/analysis": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "requestAnalysis", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Dashboard request analysis" } } } } }, "parameters": [ { "name": "qp", "in": "query", "schema": { "type": "string" } } ], "operationId": "AdminSupportController.requestAnalysis" } }, "/request/approvals-access": { "get": { "x-controller-name": "RequestController", "x-operation-name": "approvalsAccess", "tags": [ "RequestController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Coach app Approvals access for the logged-in user" } } } } }, "operationId": "RequestController.approvalsAccess" } }, "/request/count": { "get": { "x-controller-name": "RequestController", "x-operation-name": "count", "tags": [ "RequestController" ], "responses": { "200": { "description": "Request model count", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "RequestController.count" } }, "/request/filter-options": { "get": { "x-controller-name": "RequestController", "x-operation-name": "filterOptions", "tags": [ "RequestController" ], "responses": { "200": { "description": "Column filter dropdown values for the request list", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "requestorSubId", "in": "query", "schema": { "type": "number" } }, { "name": "approvedBySubId", "in": "query", "schema": { "type": "number" } }, { "name": "reqType", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "pendingAssignment", "in": "query", "schema": { "type": "boolean" } }, { "name": "careTeam", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "RequestController.filterOptions" } }, "/request/statistics": { "get": { "x-controller-name": "RequestController", "x-operation-name": "getStatistics", "tags": [ "RequestController" ], "responses": { "200": { "description": "Request statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalRequests": { "type": "number" }, "pendingRequests": { "type": "number" }, "approvedRequests": { "type": "number" }, "rejectedRequests": { "type": "number" } } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } } ], "operationId": "RequestController.getStatistics" } }, "/request/summary": { "get": { "x-controller-name": "RequestController", "x-operation-name": "summary", "tags": [ "RequestController" ], "responses": { "200": { "description": "Per-request-type counts for the list tiles", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "requestorSubId", "in": "query", "schema": { "type": "number" } }, { "name": "approvedBySubId", "in": "query", "schema": { "type": "number" } }, { "name": "reqType", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "pendingAssignment", "in": "query", "schema": { "type": "boolean" } }, { "name": "approvalStage", "in": "query", "schema": { "type": "string" } }, { "name": "careTeam", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "RequestController.summary" } }, "/request/{reqId}/client-message": { "post": { "x-controller-name": "RequestController", "x-operation-name": "updateRenewalClientMessage", "tags": [ "RequestController" ], "responses": { "200": { "description": "Renewal lead client message update", "content": { "application/json": { "schema": { "type": "object", "properties": { "renewalLeadId": { "type": "number" }, "clientMessage": { "type": "string" }, "updatedAt": { "type": "string" } } } } } } }, "parameters": [ { "name": "reqId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "clientMessage": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "RequestController.updateRenewalClientMessage" } }, "/request/{reqId}/red-flag-action": { "post": { "x-controller-name": "RequestController", "x-operation-name": "handleRedFlagAction", "tags": [ "RequestController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Handle red flag action from head nutritionist" } } } } }, "parameters": [ { "name": "reqId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "RequestController.handleRedFlagAction" } }, "/request/{reqId}/resend-refund-email": { "post": { "x-controller-name": "RequestController", "x-operation-name": "resendRefundApprovalEmail", "tags": [ "RequestController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Resend the refund approval email for an already-approved refund" } } } } }, "parameters": [ { "name": "reqId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "RequestController.resendRefundApprovalEmail" } }, "/request/{reqId}": { "post": { "x-controller-name": "RequestController", "x-operation-name": "updateById", "tags": [ "RequestController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Request approval workflow update" } } } } }, "parameters": [ { "name": "reqId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "RequestController.updateById" }, "get": { "x-controller-name": "RequestController", "x-operation-name": "findById", "tags": [ "RequestController" ], "responses": { "200": { "description": "Request detail", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "reqId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "RequestController.findById" } }, "/request": { "post": { "x-controller-name": "RequestController", "x-operation-name": "create", "tags": [ "RequestController" ], "responses": { "200": { "description": "Create request and route by reqType", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "RequestController.create" }, "get": { "x-controller-name": "RequestController", "x-operation-name": "find", "tags": [ "RequestController" ], "responses": { "200": { "description": "Unified request list", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "rp", "in": "query", "schema": { "type": "number" } }, { "name": "isPagination", "in": "query", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "reqType", "in": "query", "schema": { "type": "string" } }, { "name": "reqtype", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "requestorSubId", "in": "query", "schema": { "type": "number" } }, { "name": "approvedBySubId", "in": "query", "schema": { "type": "number" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } }, { "name": "nextToken", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDirection", "in": "query", "schema": { "type": "string" } }, { "name": "filters", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "includeFacets", "in": "query", "schema": { "type": "boolean" } }, { "name": "pendingAssignment", "in": "query", "schema": { "type": "boolean" } }, { "name": "approvalStage", "in": "query", "schema": { "type": "string" } }, { "name": "careTeam", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "RequestController.find" } }, "/requested-nutritionist/{id}": { "put": { "x-controller-name": "TransferNutritionistController", "x-operation-name": "addRequestedNutritionist", "tags": [ "TransferNutritionistController" ], "responses": { "200": { "description": "Add candidate nutritionist to a transfer request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "transferId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "nutritionistId", "userId" ], "properties": { "nutritionistId": { "type": "number" }, "userId": { "type": "number" } } } } }, "x-parameter-index": 1 }, "operationId": "TransferNutritionistController.addRequestedNutritionist" } }, "/resume-hold-program": { "post": { "x-controller-name": "HoldFreezeController", "x-operation-name": "resumeHold", "tags": [ "HoldFreezeController" ], "responses": { "200": { "description": "Resume a program from hold early", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "programStatus": { "type": "string" }, "newEndDate": { "type": "string" }, "holdEndDate": { "type": "string" }, "resumeDate": { "type": "string" }, "returnedDays": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "programId", "holdId", "resumeDate", "userId" ], "properties": { "programId": { "type": "number" }, "holdId": { "type": "number" }, "resumeDate": { "type": "string", "description": "YYYY-MM-DD" }, "resumeComment": { "type": "string" }, "userId": { "type": "number" } } } } } }, "operationId": "HoldFreezeController.resumeHold" } }, "/resume-program-after-transfer/{programId}": { "get": { "x-controller-name": "TransferNutritionistController", "x-operation-name": "getResumeProgramAfterTransferEligibility", "tags": [ "TransferNutritionistController" ], "responses": { "200": { "description": "Eligibility details for resuming a suspended program after nutritionist transfer", "content": { "application/json": { "schema": { "type": "object", "properties": { "eligible": { "type": "boolean" }, "transferNutritionistRequestId": { "type": "number" }, "suspendedAt": { "type": "string" } } } } } } }, "parameters": [ { "name": "programId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TransferNutritionistController.getResumeProgramAfterTransferEligibility" } }, "/resume-program-after-transfer": { "post": { "x-controller-name": "TransferNutritionistController", "x-operation-name": "resumeProgramAfterTransfer", "tags": [ "TransferNutritionistController" ], "responses": { "200": { "description": "Resume a suspended program after nutritionist transfer and shift future timeline dates", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "programId": { "type": "number" }, "transferNutritionistRequestId": { "type": "number" }, "suspendedAt": { "type": "string" }, "resumedAt": { "type": "string" }, "shiftedCallLogRows": { "type": "number" }, "shiftedFileUploadRows": { "type": "number" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "programId", "transferNutritionistRequestId" ], "properties": { "userId": { "type": "number" }, "programId": { "type": "number" }, "transferNutritionistRequestId": { "type": "number" } } } } } }, "operationId": "TransferNutritionistController.resumeProgramAfterTransfer" } }, "/resume-unresponive-client": { "post": { "x-controller-name": "UnresponsiveClientController", "x-operation-name": "resumeUnresponiveClient", "tags": [ "UnresponsiveClientController" ], "responses": { "200": { "description": "Resume a program from an unresponsive client request", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "requestId", "resumeDate" ], "additionalProperties": true } } } }, "operationId": "UnresponsiveClientController.resumeUnresponiveClient" } }, "/resume-unresponsive-client": { "post": { "x-controller-name": "UnresponsiveClientController", "x-operation-name": "resumeUnresponsiveClient", "tags": [ "UnresponsiveClientController" ], "responses": { "200": { "description": "Correctly spelled alias for resuming an unresponsive client request", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "requestId", "resumeDate" ], "additionalProperties": true } } } }, "operationId": "UnresponsiveClientController.resumeUnresponsiveClient" } }, "/rewardpayout/{id}": { "patch": { "x-controller-name": "PayoutController", "x-operation-name": "updateRewardPayout", "tags": [ "PayoutController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Update a reward payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PayoutController.updateRewardPayout" }, "delete": { "x-controller-name": "PayoutController", "x-operation-name": "deleteRewardPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Delete a reward payout" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PayoutController.deleteRewardPayout" } }, "/rewardpayout": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "createRewardPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Create a reward payout" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "month", "year", "payoutAmount" ], "properties": { "userId": { "type": "number" }, "userName": { "type": "string" }, "month": { "type": "number" }, "year": { "type": "number" }, "payoutTitle": { "type": "string" }, "payoutDescription": { "type": "string" }, "payoutAmount": { "type": "number" } } } } } }, "operationId": "PayoutController.createRewardPayout" }, "get": { "x-controller-name": "PayoutController", "x-operation-name": "listRewardPayout", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "List reward payout rows" } } } } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "number" } }, { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "sortBy", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "operationId": "PayoutController.listRewardPayout" } }, "/role": { "get": { "x-controller-name": "AdminSupportController", "x-operation-name": "getRoles", "tags": [ "AdminSupportController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Role list" } } } } }, "operationId": "AdminSupportController.getRoles" } }, "/role-permission/{id}": { "get": { "x-controller-name": "PermissionController", "x-operation-name": "rolePermission", "tags": [ "PermissionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Permissions assigned to a role" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PermissionController.rolePermission" } }, "/role-permission-update/{id}": { "put": { "x-controller-name": "PermissionController", "x-operation-name": "updateRolePermission", "tags": [ "PermissionController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Role permissions updated" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "PermissionController.updateRolePermission" } }, "/salescall/count": { "get": { "x-controller-name": "SalesCallController", "x-operation-name": "count", "tags": [ "SalesCallController" ], "responses": { "200": { "description": "SalesCall model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "SalesCall.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "SalesCallController.count" } }, "/salescall/{id}": { "post": { "x-controller-name": "SalesCallController", "x-operation-name": "updateByIdPost", "tags": [ "SalesCallController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "SalesCall POST update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "SalesCallController.updateByIdPost" }, "put": { "x-controller-name": "SalesCallController", "x-operation-name": "replaceById", "tags": [ "SalesCallController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "SalesCall PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCall" } } }, "x-parameter-index": 1 }, "operationId": "SalesCallController.replaceById" }, "patch": { "x-controller-name": "SalesCallController", "x-operation-name": "updateById", "tags": [ "SalesCallController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "SalesCall PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "SalesCallController.updateById" }, "get": { "x-controller-name": "SalesCallController", "x-operation-name": "findById", "tags": [ "SalesCallController" ], "responses": { "200": { "description": "SalesCall model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCall.Filter" } } } } ], "operationId": "SalesCallController.findById" }, "delete": { "x-controller-name": "SalesCallController", "x-operation-name": "deleteById", "tags": [ "SalesCallController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "SalesCall DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SalesCallController.deleteById" } }, "/salescall": { "post": { "x-controller-name": "SalesCallController", "x-operation-name": "create", "tags": [ "SalesCallController" ], "responses": { "200": { "description": "SalesCall model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCall" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "SalesCallController.create" }, "get": { "x-controller-name": "SalesCallController", "x-operation-name": "find", "tags": [ "SalesCallController" ], "responses": { "200": { "description": "Array of SalesCall model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCallWithRelations" } } } } } }, "parameters": [ { "name": "pq", "in": "query", "schema": { "type": "string" } }, { "name": "leadId", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCall.Filter1" } } } } ], "operationId": "SalesCallController.find" } }, "/schedule-resync/{progId}": { "put": { "x-controller-name": "ScheduleResyncController", "x-operation-name": "rescheduleEntry", "tags": [ "ScheduleResyncController" ], "responses": { "200": { "description": "Reschedule a call-log or file-upload entry", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "entryType": { "type": "string", "enum": [ "call", "file" ] }, "entryId": { "type": "number" }, "newScheduleDate": { "type": "string" } }, "required": [ "entryType", "entryId", "newScheduleDate" ] } } }, "x-parameter-index": 1 }, "operationId": "ScheduleResyncController.rescheduleEntry" }, "get": { "x-controller-name": "ScheduleResyncController", "x-operation-name": "getReschedulableEntries", "tags": [ "ScheduleResyncController" ], "responses": { "200": { "description": "List call-logs and file-uploads with schedule-date >= today for a given program", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "progId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ScheduleResyncController.getReschedulableEntries" } }, "/set-blog-payment": { "post": { "x-controller-name": "PayoutController", "x-operation-name": "setBlogPayment", "tags": [ "PayoutController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update the global default blog payout amount" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PayoutController.setBlogPayment" } }, "/suppleduration": { "get": { "x-controller-name": "SupplementMasterController", "x-operation-name": "getDurationOptions", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get duration options" } } } } }, "operationId": "SupplementMasterController.getDurationOptions" } }, "/supplement/count": { "get": { "x-controller-name": "SupplementMasterController", "x-operation-name": "count", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "Supplement model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Supplement.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "SupplementMasterController.count" } }, "/supplement/{id}": { "post": { "x-controller-name": "SupplementMasterController", "x-operation-name": "updateById", "tags": [ "SupplementMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Supplement update success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "SupplementMasterController.updateById" }, "patch": { "x-controller-name": "SupplementMasterController", "x-operation-name": "updateByIdPatch", "tags": [ "SupplementMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Supplement PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } }, "x-parameter-index": 1 }, "operationId": "SupplementMasterController.updateByIdPatch" }, "get": { "x-controller-name": "SupplementMasterController", "x-operation-name": "findById", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "Supplement model instance", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SupplementMasterController.findById" }, "delete": { "x-controller-name": "SupplementMasterController", "x-operation-name": "deleteById", "tags": [ "SupplementMasterController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Supplement DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SupplementMasterController.deleteById" } }, "/supplement": { "post": { "x-controller-name": "SupplementMasterController", "x-operation-name": "create", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "Supplement model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Supplement" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "operationId": "SupplementMasterController.create" }, "get": { "x-controller-name": "SupplementMasterController", "x-operation-name": "find", "tags": [ "SupplementMasterController" ], "responses": { "200": { "description": "Array of Supplement model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementWithRelations" } } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "form", "in": "query", "schema": { "type": "string" } }, { "name": "frequency", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "skip", "in": "query", "schema": { "type": "number" } } ], "operationId": "SupplementMasterController.find" } }, "/template/count": { "get": { "x-controller-name": "TemplateMasterController", "x-operation-name": "count", "tags": [ "TemplateMasterController" ], "responses": { "200": { "description": "Template model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Template.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where