{ "openapi": "3.0.0", "info": { "title": "MMonster API", "version": "1.0.0", "description": "API documentation for MMonster platform. Generated from source code.", "contact": { "name": "MMonster Support" } }, "servers": [ { "url": "https://stgadm.mmonster.co/api", "description": "API server" } ], "paths": { "/wallet-transactions": { "get": { "tags": [ "WalletTransaction" ], "summary": "List wallet-transactions", "description": "Retrieve a paginated list of wallet-transactions with optional filtering and sorting", "operationId": "getWalletTransactionList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletTransactionListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/wallet-transactions/{id}": { "get": { "tags": [ "WalletTransaction" ], "summary": "Get wallet-transaction by ID", "description": "Retrieve a single wallet-transaction by its ID", "operationId": "getWalletTransactionById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "WalletTransaction ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletTransactionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/wallets": { "get": { "tags": [ "Wallet" ], "summary": "List wallets", "description": "Retrieve a paginated list of wallets with optional filtering and sorting", "operationId": "getWalletList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/wallets/{id}": { "get": { "tags": [ "Wallet" ], "summary": "Get wallet by ID", "description": "Retrieve a single wallet by its ID", "operationId": "getWalletById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Wallet ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/tickets": { "get": { "tags": [ "Ticket" ], "summary": "List tickets", "description": "Retrieve a paginated list of tickets with optional filtering and sorting", "operationId": "getTicketList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Ticket" ], "summary": "Create ticket", "description": "Create a new ticket", "operationId": "createTicket", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/tickets/{id}": { "get": { "tags": [ "Ticket" ], "summary": "Get ticket by ID", "description": "Retrieve a single ticket by its ID", "operationId": "getTicketById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticket ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Ticket" ], "summary": "Update ticket", "description": "Update an existing ticket by ID", "operationId": "updateTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticket ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Ticket" ], "summary": "Delete ticket", "description": "Delete a ticket by ID", "operationId": "deleteTicket", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticket ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/teams": { "get": { "tags": [ "Team" ], "summary": "List teams", "description": "Retrieve a paginated list of teams with optional filtering and sorting", "operationId": "getTeamList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Team" ], "summary": "Create team", "description": "Create a new team", "operationId": "createTeam", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/teams/{id}": { "get": { "tags": [ "Team" ], "summary": "Get team by ID", "description": "Retrieve a single team by its ID", "operationId": "getTeamById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Team ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Team" ], "summary": "Update team", "description": "Update an existing team by ID", "operationId": "updateTeam", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Team ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Team" ], "summary": "Delete team", "description": "Delete a team by ID", "operationId": "deleteTeam", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Team ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/tags": { "get": { "tags": [ "Tag" ], "summary": "List tags", "description": "Retrieve a paginated list of tags with optional filtering and sorting", "operationId": "getTagList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Tag" ], "summary": "Create tag", "description": "Create a new tag", "operationId": "createTag", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/tags/{id}": { "get": { "tags": [ "Tag" ], "summary": "Get tag by ID", "description": "Retrieve a single tag by its ID", "operationId": "getTagById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Tag ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Tag" ], "summary": "Update tag", "description": "Update an existing tag by ID", "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Tag ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Tag" ], "summary": "Delete tag", "description": "Delete a tag by ID", "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Tag ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/stores": { "get": { "tags": [ "Store" ], "summary": "List stores", "description": "Retrieve a paginated list of stores with optional filtering and sorting", "operationId": "getStoreList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Store" ], "summary": "Create store", "description": "Create a new store", "operationId": "createStore", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/stores/{id}": { "get": { "tags": [ "Store" ], "summary": "Get store by ID", "description": "Retrieve a single store by its ID", "operationId": "getStoreById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Store" ], "summary": "Update store", "description": "Update an existing store by ID", "operationId": "updateStore", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Store" ], "summary": "Delete store", "description": "Delete a store by ID", "operationId": "deleteStore", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Store ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/service-types": { "get": { "tags": [ "ServiceType" ], "summary": "List service-types", "description": "Retrieve a paginated list of service-types with optional filtering and sorting", "operationId": "getServiceTypeList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTypeListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "ServiceType" ], "summary": "Create service-type", "description": "Create a new service-type", "operationId": "createServiceType", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTypeRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTypeResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/service-types/{id}": { "get": { "tags": [ "ServiceType" ], "summary": "Get service-type by ID", "description": "Retrieve a single service-type by its ID", "operationId": "getServiceTypeById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ServiceType ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTypeResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ServiceType" ], "summary": "Update service-type", "description": "Update an existing service-type by ID", "operationId": "updateServiceType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ServiceType ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTypeRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTypeResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ServiceType" ], "summary": "Delete service-type", "description": "Delete a service-type by ID", "operationId": "deleteServiceType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ServiceType ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTypeResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/schedules": { "get": { "tags": [ "Schedule" ], "summary": "List schedules", "description": "Retrieve a paginated list of schedules with optional filtering and sorting", "operationId": "getScheduleList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Schedule" ], "summary": "Create schedule", "description": "Create a new schedule", "operationId": "createSchedule", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/schedules/{id}": { "get": { "tags": [ "Schedule" ], "summary": "Get schedule by ID", "description": "Retrieve a single schedule by its ID", "operationId": "getScheduleById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Schedule ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Schedule" ], "summary": "Update schedule", "description": "Update an existing schedule by ID", "operationId": "updateSchedule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Schedule ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Schedule" ], "summary": "Delete schedule", "description": "Delete a schedule by ID", "operationId": "deleteSchedule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Schedule ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/sales-channels": { "get": { "tags": [ "SalesChannel" ], "summary": "List sales-channels", "description": "Retrieve a paginated list of sales-channels with optional filtering and sorting", "operationId": "getSalesChannelList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "SalesChannel" ], "summary": "Create sales-channel", "description": "Create a new sales-channel", "operationId": "createSalesChannel", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/sales-channels/{id}": { "get": { "tags": [ "SalesChannel" ], "summary": "Get sales-channel by ID", "description": "Retrieve a single sales-channel by its ID", "operationId": "getSalesChannelById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "SalesChannel ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "SalesChannel" ], "summary": "Update sales-channel", "description": "Update an existing sales-channel by ID", "operationId": "updateSalesChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "SalesChannel ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "SalesChannel" ], "summary": "Delete sales-channel", "description": "Delete a sales-channel by ID", "operationId": "deleteSalesChannel", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "SalesChannel ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/push-subscriptions": { "get": { "tags": [ "PushSubscription" ], "summary": "List push-subscriptions", "description": "Retrieve a paginated list of push-subscriptions with optional filtering and sorting", "operationId": "getPushSubscriptionList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushSubscriptionListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "PushSubscription" ], "summary": "Create push-subscription", "description": "Create a new push-subscription", "operationId": "createPushSubscription", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushSubscriptionRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushSubscriptionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/push-subscriptions/{id}": { "get": { "tags": [ "PushSubscription" ], "summary": "Get push-subscription by ID", "description": "Retrieve a single push-subscription by its ID", "operationId": "getPushSubscriptionById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "PushSubscription ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushSubscriptionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "PushSubscription" ], "summary": "Update push-subscription", "description": "Update an existing push-subscription by ID", "operationId": "updatePushSubscription", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "PushSubscription ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushSubscriptionRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushSubscriptionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "PushSubscription" ], "summary": "Delete push-subscription", "description": "Delete a push-subscription by ID", "operationId": "deletePushSubscription", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "PushSubscription ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PushSubscriptionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/providers": { "get": { "tags": [ "Provider" ], "summary": "List providers", "description": "Retrieve a paginated list of providers with optional filtering and sorting", "operationId": "getProviderList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Provider" ], "summary": "Create provider", "description": "Create a new provider", "operationId": "createProvider", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/providers/{id}": { "get": { "tags": [ "Provider" ], "summary": "Get provider by ID", "description": "Retrieve a single provider by its ID", "operationId": "getProviderById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Provider ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Provider" ], "summary": "Update provider", "description": "Update an existing provider by ID", "operationId": "updateProvider", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Provider ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Provider" ], "summary": "Delete provider", "description": "Delete a provider by ID", "operationId": "deleteProvider", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Provider ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/profiles": { "get": { "tags": [ "Profile" ], "summary": "List profiles", "description": "Retrieve a paginated list of profiles with optional filtering and sorting", "operationId": "getProfileList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Profile" ], "summary": "Create profile", "description": "Create a new profile", "operationId": "createProfile", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/{id}": { "get": { "tags": [ "Profile" ], "summary": "Get profile by ID", "description": "Retrieve a single profile by its ID", "operationId": "getProfileById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Profile ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Profile" ], "summary": "Update profile", "description": "Update an existing profile by ID", "operationId": "updateProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Profile ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Profile" ], "summary": "Delete profile", "description": "Delete a profile by ID", "operationId": "deleteProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Profile ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/products": { "get": { "tags": [ "Product" ], "summary": "List products", "description": "Retrieve a paginated list of products with optional filtering and sorting", "operationId": "getProductList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Product" ], "summary": "Create product", "description": "Create a new product", "operationId": "createProduct", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/products/{id}": { "get": { "tags": [ "Product" ], "summary": "Get product by ID", "description": "Retrieve a single product by its ID", "operationId": "getProductById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Product" ], "summary": "Update product", "description": "Update an existing product by ID", "operationId": "updateProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Product" ], "summary": "Delete product", "description": "Delete a product by ID", "operationId": "deleteProduct", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Product ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/payouts": { "get": { "tags": [ "Payout" ], "summary": "List payouts", "description": "Retrieve a paginated list of payouts with optional filtering and sorting", "operationId": "getPayoutList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Payout" ], "summary": "Create payout", "description": "Create a new payout", "operationId": "createPayout", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/payouts/{id}": { "get": { "tags": [ "Payout" ], "summary": "Get payout by ID", "description": "Retrieve a single payout by its ID", "operationId": "getPayoutById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Payout ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Payout" ], "summary": "Update payout", "description": "Update an existing payout by ID", "operationId": "updatePayout", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Payout ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Payout" ], "summary": "Delete payout", "description": "Delete a payout by ID", "operationId": "deletePayout", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Payout ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/orders": { "get": { "tags": [ "Order" ], "summary": "List orders", "description": "Retrieve a paginated list of orders with optional filtering and sorting", "operationId": "getOrderList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Order" ], "summary": "Create order", "description": "Create a new order", "operationId": "createOrder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/orders/{id}": { "get": { "tags": [ "Order" ], "summary": "Get order by ID", "description": "Retrieve a single order by its ID", "operationId": "getOrderById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Order" ], "summary": "Update order", "description": "Update an existing order by ID", "operationId": "updateOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Order" ], "summary": "Delete order", "description": "Delete a order by ID", "operationId": "deleteOrder", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Order ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/offers": { "get": { "tags": [ "Offer" ], "summary": "List offers", "description": "Retrieve a paginated list of offers with optional filtering and sorting", "operationId": "getOfferList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Offer" ], "summary": "Create offer", "description": "Create a new offer", "operationId": "createOffer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/offers/{id}": { "get": { "tags": [ "Offer" ], "summary": "Get offer by ID", "description": "Retrieve a single offer by its ID", "operationId": "getOfferById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Offer ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Offer" ], "summary": "Update offer", "description": "Update an existing offer by ID", "operationId": "updateOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Offer ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Offer" ], "summary": "Delete offer", "description": "Delete a offer by ID", "operationId": "deleteOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Offer ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/notification-delivery-logs": { "get": { "tags": [ "NotificationDeliveryLog" ], "summary": "List notification-delivery-logs", "description": "Retrieve a paginated list of notification-delivery-logs with optional filtering and sorting", "operationId": "getNotificationDeliveryLogList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryLogListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "NotificationDeliveryLog" ], "summary": "Create notification-delivery-log", "description": "Create a new notification-delivery-log", "operationId": "createNotificationDeliveryLog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryLogRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/notification-delivery-logs/{id}": { "get": { "tags": [ "NotificationDeliveryLog" ], "summary": "Get notification-delivery-log by ID", "description": "Retrieve a single notification-delivery-log by its ID", "operationId": "getNotificationDeliveryLogById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "NotificationDeliveryLog ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "NotificationDeliveryLog" ], "summary": "Update notification-delivery-log", "description": "Update an existing notification-delivery-log by ID", "operationId": "updateNotificationDeliveryLog", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "NotificationDeliveryLog ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryLogRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "NotificationDeliveryLog" ], "summary": "Delete notification-delivery-log", "description": "Delete a notification-delivery-log by ID", "operationId": "deleteNotificationDeliveryLog", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "NotificationDeliveryLog ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDeliveryLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/notifications": { "get": { "summary": "Get notifications for current user", "operationId": "notification_find", "tags": [ "Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Notification" ], "summary": "Create notification", "description": "Create a new notification", "operationId": "createNotification", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/notifications/{id}": { "get": { "tags": [ "Notification" ], "summary": "Get notification by ID", "description": "Retrieve a single notification by its ID", "operationId": "getNotificationById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Notification ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Notification" ], "summary": "Update notification", "description": "Update an existing notification by ID", "operationId": "updateNotification", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Notification ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Notification" ], "summary": "Delete notification", "description": "Delete a notification by ID", "operationId": "deleteNotification", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Notification ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/mm-user-links": { "get": { "tags": [ "MmUserLink" ], "summary": "List mm-user-links", "description": "Retrieve a paginated list of mm-user-links with optional filtering and sorting", "operationId": "getMmUserLinkList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MmUserLinkListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "MmUserLink" ], "summary": "Create mm-user-link", "description": "Create a new mm-user-link", "operationId": "createMmUserLink", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MmUserLinkRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MmUserLinkResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/mm-user-links/{id}": { "get": { "tags": [ "MmUserLink" ], "summary": "Get mm-user-link by ID", "description": "Retrieve a single mm-user-link by its ID", "operationId": "getMmUserLinkById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "MmUserLink ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MmUserLinkResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "MmUserLink" ], "summary": "Update mm-user-link", "description": "Update an existing mm-user-link by ID", "operationId": "updateMmUserLink", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "MmUserLink ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MmUserLinkRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MmUserLinkResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "MmUserLink" ], "summary": "Delete mm-user-link", "description": "Delete a mm-user-link by ID", "operationId": "deleteMmUserLink", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "MmUserLink ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MmUserLinkResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/manufacturers": { "get": { "tags": [ "Manufacturer" ], "summary": "List manufacturers", "description": "Retrieve a paginated list of manufacturers with optional filtering and sorting", "operationId": "getManufacturerList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturerListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Manufacturer" ], "summary": "Create manufacturer", "description": "Create a new manufacturer", "operationId": "createManufacturer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturerRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/manufacturers/{id}": { "get": { "tags": [ "Manufacturer" ], "summary": "Get manufacturer by ID", "description": "Retrieve a single manufacturer by its ID", "operationId": "getManufacturerById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Manufacturer ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Manufacturer" ], "summary": "Update manufacturer", "description": "Update an existing manufacturer by ID", "operationId": "updateManufacturer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Manufacturer ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturerRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Manufacturer" ], "summary": "Delete manufacturer", "description": "Delete a manufacturer by ID", "operationId": "deleteManufacturer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Manufacturer ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManufacturerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/logs": { "get": { "tags": [ "Log" ], "summary": "List logs", "description": "Retrieve a paginated list of logs with optional filtering and sorting", "operationId": "getLogList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/logs/{id}": { "get": { "tags": [ "Log" ], "summary": "Get log by ID", "description": "Retrieve a single log by its ID", "operationId": "getLogById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Log ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/event-logs": { "get": { "summary": "Search event logs with filters", "operationId": "event-log_find", "tags": [ "Event Log" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "EventLog" ], "summary": "Create event-log", "description": "Create a new event-log", "operationId": "createEventLog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventLogRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/event-logs/{id}": { "get": { "tags": [ "EventLog" ], "summary": "Get event-log by ID", "description": "Retrieve a single event-log by its ID", "operationId": "getEventLogById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "EventLog ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "EventLog" ], "summary": "Update event-log", "description": "Update an existing event-log by ID", "operationId": "updateEventLog", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "EventLog ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventLogRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "EventLog" ], "summary": "Delete event-log", "description": "Delete a event-log by ID", "operationId": "deleteEventLog", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "EventLog ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/deals": { "get": { "tags": [ "Deal" ], "summary": "List deals", "description": "Retrieve a paginated list of deals with optional filtering and sorting", "operationId": "getDealList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Deal" ], "summary": "Create deal", "description": "Create a new deal", "operationId": "createDeal", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/deals/{id}": { "get": { "tags": [ "Deal" ], "summary": "Get deal by ID", "description": "Retrieve a single deal by its ID", "operationId": "getDealById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deal ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Deal" ], "summary": "Update deal", "description": "Update an existing deal by ID", "operationId": "updateDeal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deal ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Deal" ], "summary": "Delete deal", "description": "Delete a deal by ID", "operationId": "deleteDeal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Deal ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/customers": { "get": { "tags": [ "Customer" ], "summary": "List customers", "description": "Retrieve a paginated list of customers with optional filtering and sorting", "operationId": "getCustomerList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Customer" ], "summary": "Create customer", "description": "Create a new customer", "operationId": "createCustomer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/customers/{id}": { "get": { "tags": [ "Customer" ], "summary": "Get customer by ID", "description": "Retrieve a single customer by its ID", "operationId": "getCustomerById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Customer" ], "summary": "Update customer", "description": "Update an existing customer by ID", "operationId": "updateCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Customer" ], "summary": "Delete customer", "description": "Delete a customer by ID", "operationId": "deleteCustomer", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Customer ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/config-schedules": { "get": { "tags": [ "ConfigSchedule" ], "summary": "List config-schedules", "description": "Retrieve a paginated list of config-schedules with optional filtering and sorting", "operationId": "getConfigScheduleList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigScheduleListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "ConfigSchedule" ], "summary": "Create config-schedule", "description": "Create a new config-schedule", "operationId": "createConfigSchedule", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigScheduleRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/config-schedules/{id}": { "get": { "tags": [ "ConfigSchedule" ], "summary": "Get config-schedule by ID", "description": "Retrieve a single config-schedule by its ID", "operationId": "getConfigScheduleById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigSchedule ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ConfigSchedule" ], "summary": "Update config-schedule", "description": "Update an existing config-schedule by ID", "operationId": "updateConfigSchedule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigSchedule ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigScheduleRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ConfigSchedule" ], "summary": "Delete config-schedule", "description": "Delete a config-schedule by ID", "operationId": "deleteConfigSchedule", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigSchedule ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigScheduleResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/config-mixins": { "get": { "tags": [ "ConfigMixin" ], "summary": "List config-mixins", "description": "Retrieve a paginated list of config-mixins with optional filtering and sorting", "operationId": "getConfigMixinList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMixinListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "ConfigMixin" ], "summary": "Create config-mixin", "description": "Create a new config-mixin", "operationId": "createConfigMixin", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMixinRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMixinResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/config-mixins/{id}": { "get": { "tags": [ "ConfigMixin" ], "summary": "Get config-mixin by ID", "description": "Retrieve a single config-mixin by its ID", "operationId": "getConfigMixinById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigMixin ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMixinResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ConfigMixin" ], "summary": "Update config-mixin", "description": "Update an existing config-mixin by ID", "operationId": "updateConfigMixin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigMixin ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMixinRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMixinResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ConfigMixin" ], "summary": "Delete config-mixin", "description": "Delete a config-mixin by ID", "operationId": "deleteConfigMixin", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigMixin ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigMixinResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/config-extensions": { "get": { "tags": [ "ConfigExtension" ], "summary": "List config-extensions", "description": "Retrieve a paginated list of config-extensions with optional filtering and sorting", "operationId": "getConfigExtensionList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExtensionListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "ConfigExtension" ], "summary": "Create config-extension", "description": "Create a new config-extension", "operationId": "createConfigExtension", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExtensionRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExtensionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/config-extensions/{id}": { "get": { "tags": [ "ConfigExtension" ], "summary": "Get config-extension by ID", "description": "Retrieve a single config-extension by its ID", "operationId": "getConfigExtensionById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigExtension ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExtensionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ConfigExtension" ], "summary": "Update config-extension", "description": "Update an existing config-extension by ID", "operationId": "updateConfigExtension", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigExtension ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExtensionRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExtensionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ConfigExtension" ], "summary": "Delete config-extension", "description": "Delete a config-extension by ID", "operationId": "deleteConfigExtension", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ConfigExtension ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigExtensionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/coins-transactions": { "get": { "tags": [ "CoinsTransaction" ], "summary": "List coins-transactions", "description": "Retrieve a paginated list of coins-transactions with optional filtering and sorting", "operationId": "getCoinsTransactionList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinsTransactionListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/coins-transactions/{id}": { "get": { "tags": [ "CoinsTransaction" ], "summary": "Get coins-transaction by ID", "description": "Retrieve a single coins-transaction by its ID", "operationId": "getCoinsTransactionById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "CoinsTransaction ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoinsTransactionResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/chat-assignments": { "get": { "tags": [ "ChatAssignment" ], "summary": "List chat-assignments", "description": "Retrieve a paginated list of chat-assignments with optional filtering and sorting", "operationId": "getChatAssignmentList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAssignmentListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "ChatAssignment" ], "summary": "Create chat-assignment", "description": "Create a new chat-assignment", "operationId": "createChatAssignment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAssignmentRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAssignmentResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/chat-assignments/{id}": { "get": { "tags": [ "ChatAssignment" ], "summary": "Get chat-assignment by ID", "description": "Retrieve a single chat-assignment by its ID", "operationId": "getChatAssignmentById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ChatAssignment ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAssignmentResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "ChatAssignment" ], "summary": "Update chat-assignment", "description": "Update an existing chat-assignment by ID", "operationId": "updateChatAssignment", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ChatAssignment ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAssignmentRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAssignmentResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "ChatAssignment" ], "summary": "Delete chat-assignment", "description": "Delete a chat-assignment by ID", "operationId": "deleteChatAssignment", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ChatAssignment ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatAssignmentResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/chats": { "get": { "tags": [ "Chat" ], "summary": "List chats", "description": "Retrieve a paginated list of chats with optional filtering and sorting", "operationId": "getChatList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Chat" ], "summary": "Create chat", "description": "Create a new chat", "operationId": "createChat", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/chats/{id}": { "get": { "tags": [ "Chat" ], "summary": "Get chat by ID", "description": "Retrieve a single chat by its ID", "operationId": "getChatById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Chat ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Chat" ], "summary": "Update chat", "description": "Update an existing chat by ID", "operationId": "updateChat", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Chat ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Chat" ], "summary": "Delete chat", "description": "Delete a chat by ID", "operationId": "deleteChat", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Chat ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/attention-event-logs": { "get": { "tags": [ "AttentionEventLog" ], "summary": "List attention-event-logs", "description": "Retrieve a paginated list of attention-event-logs with optional filtering and sorting", "operationId": "getAttentionEventLogList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventLogListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "AttentionEventLog" ], "summary": "Create attention-event-log", "description": "Create a new attention-event-log", "operationId": "createAttentionEventLog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventLogRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/attention-event-logs/{id}": { "get": { "tags": [ "AttentionEventLog" ], "summary": "Get attention-event-log by ID", "description": "Retrieve a single attention-event-log by its ID", "operationId": "getAttentionEventLogById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "AttentionEventLog ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "AttentionEventLog" ], "summary": "Update attention-event-log", "description": "Update an existing attention-event-log by ID", "operationId": "updateAttentionEventLog", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "AttentionEventLog ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventLogRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "AttentionEventLog" ], "summary": "Delete attention-event-log", "description": "Delete a attention-event-log by ID", "operationId": "deleteAttentionEventLog", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "AttentionEventLog ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventLogResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/attention-events": { "get": { "summary": "List attention events", "operationId": "attention-event_find", "tags": [ "AttentionEvent" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "AttentionEvent" ], "summary": "Create attention-event", "description": "Create a new attention-event", "operationId": "createAttentionEvent", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventRequest" } } } }, "responses": { "200": { "description": "Created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/attention-events/{id}": { "get": { "summary": "Get a single attention event", "operationId": "attention-event_findOne", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "AttentionEvent" ], "summary": "Update attention-event", "description": "Update an existing attention-event by ID", "operationId": "updateAttentionEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "AttentionEvent ID", "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventRequest" } } } }, "responses": { "200": { "description": "Updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "AttentionEvent" ], "summary": "Delete attention-event", "description": "Delete a attention-event by ID", "operationId": "deleteAttentionEvent", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "AttentionEvent ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttentionEventResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/applications": { "get": { "tags": [ "Application" ], "summary": "List applications", "description": "Retrieve a paginated list of applications with optional filtering and sorting", "operationId": "getApplicationList", "parameters": [ { "name": "sort", "in": "query", "description": "Sort by field (e.g., createdAt:desc)", "schema": { "type": "string" } }, { "name": "pagination[page]", "in": "query", "description": "Page number (default: 1)", "schema": { "type": "integer", "default": 1 } }, { "name": "pagination[pageSize]", "in": "query", "description": "Items per page (default: 25, max: 100)", "schema": { "type": "integer", "default": 25 } }, { "name": "filters", "in": "query", "description": "Filter conditions (e.g., filters[status][$eq]=open)", "style": "deepObject", "explode": true, "schema": { "type": "object", "additionalProperties": true } }, { "name": "populate", "in": "query", "description": "Relations to populate (e.g., populate=* or populate[0]=customer)", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "Fields to return (e.g., fields[0]=name&fields[1]=status)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationListResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/applications/{id}": { "get": { "tags": [ "Application" ], "summary": "Get application by ID", "description": "Retrieve a single application by its ID", "operationId": "getApplicationById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Application ID", "schema": { "type": "integer" } }, { "name": "populate", "in": "query", "description": "Relations to populate", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationResponse" } } } }, "400": { "description": "Bad Request - Invalid parameters" }, "401": { "description": "Unauthorized - Missing or invalid authentication" }, "403": { "description": "Forbidden - Insufficient permissions" }, "404": { "description": "Not Found - Resource does not exist" }, "500": { "description": "Internal Server Error" } } } }, "/helper/chats/{chatId}/assignments": { "get": { "summary": "GET /chats/:chatId/assignments", "operationId": "api::chat-assignment_chat-assignment-admin.getAssignments", "tags": [ "Admin: Chat Assignment" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /chats/:chatId/assignments", "operationId": "api::chat-assignment_chat-assignment-admin.addAssignment", "tags": [ "Admin: Chat Assignment" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/{chatId}/assignments/{id}": { "delete": { "summary": "DELETE /chats/:chatId/assignments/:id", "operationId": "api::chat-assignment_chat-assignment-admin.removeAssignment", "tags": [ "Admin: Chat Assignment" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/{chatId}/follow": { "post": { "summary": "POST /chats/:chatId/follow", "operationId": "api::chat-assignment_chat-assignment-admin.follow", "tags": [ "Admin: Chat Assignment" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /chats/:chatId/follow", "operationId": "api::chat-assignment_chat-assignment-admin.unfollow", "tags": [ "Admin: Chat Assignment" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/{chatId}/is-following": { "get": { "summary": "GET /chats/:chatId/is-following", "operationId": "api::chat-assignment_chat-assignment-admin.isFollowing", "tags": [ "Admin: Chat Assignment" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/my-chats": { "get": { "summary": "GET /my-chats", "operationId": "api::chat-assignment_chat-assignment-admin.myChats", "tags": [ "Admin: Chat Assignment" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/my-chats/ids": { "get": { "summary": "GET /my-chats/ids", "operationId": "api::chat-assignment_chat-assignment-admin.myFollowedChatIds", "tags": [ "Admin: Chat Assignment" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chat-notifications": { "get": { "summary": "GET /chat-notifications", "operationId": "api::chat_chat-notifications.list", "tags": [ "Admin: Chat Notifications" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/chats/{id}/archive": { "post": { "summary": "POST /chats/:id/archive", "operationId": "chat_archive", "tags": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/chats/{id}/unarchive": { "post": { "summary": "POST /chats/:id/unarchive", "operationId": "chat_unarchive", "tags": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/chats/active": { "get": { "summary": "GET /chats/active", "operationId": "chat_findActive", "tags": [], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/customers/sync": { "post": { "summary": "Sync customers from Shopware", "operationId": "customer_sync", "tags": [ "Customer" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/customers/{id}/kyc": { "put": { "summary": "PUT /customers/:id/kyc", "operationId": "customer_updateKycStatus", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/customers/{id}/kyc/request": { "post": { "summary": "POST /customers/:id/kyc/request", "operationId": "customer_requestKyc", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/customers/discord/{id}": { "put": { "summary": "Update customer by Discord user ID", "operationId": "customer_updateByDiscordId", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } }, "get": { "summary": "Find customer by Discord user ID", "operationId": "customer_getByDiscordId", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/customers/shopware/{id}": { "put": { "summary": "Update customer by Shopware customer ID", "operationId": "customer_updateByShopwareId", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } }, "get": { "summary": "Find customer by Shopware customer ID", "operationId": "customer_getByShopwareId", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/customers/email/{email}": { "get": { "summary": "Find customer by email address", "operationId": "customer_getByEmail", "tags": [ "Customer" ], "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/customers/{id}/coins": { "get": { "summary": "Get coins balance for customer by ID", "operationId": "customer_getCoins", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/customers/coins": { "post": { "summary": "Adjust coins balance for customer (add/subtract)", "operationId": "customer_adjustCoins", "tags": [ "Customer" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/customers/shopware/{id}/coins": { "get": { "summary": "Get coins balance for customer by Shopware ID", "operationId": "customer_getCoinsByShopwareId", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/customers/shopware/{id}/promotion/{code}": { "get": { "summary": "Validate promotion code for Shopware customer", "operationId": "customer_validatePromotion", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/customers/shopware/{id}/promotion": { "post": { "summary": "Create promotion for Shopware customer", "operationId": "customer_createPromotion", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/deals/{id}/status": { "put": { "summary": "Update deal status (draft, open, assigned, on_approval, completed, failed)", "operationId": "deal_setStatus", "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/deals/{id}/message": { "post": { "summary": "Send message to deal Discord thread", "operationId": "deal_sendMessage", "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/deals/{id}/offline": { "post": { "summary": "Report provider offline for deal", "operationId": "deal_reportOffline", "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/deals/{id}/problem": { "post": { "summary": "Report problem with deal", "operationId": "deal_reportPloblem", "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/discord-oauth/status": { "get": { "summary": "Check if Discord OAuth is configured", "operationId": "discord-oauth_status", "tags": [ "Discord OAuth" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/discord-oauth/authorize": { "get": { "summary": "Generate Discord OAuth authorization URL", "operationId": "discord-oauth_authorize", "tags": [ "Discord OAuth" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/discord-oauth/callback": { "get": { "summary": "Handle Discord OAuth callback", "operationId": "discord-oauth_callback", "tags": [ "Discord OAuth" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/event-logs/entity/{uid}/{id}": { "get": { "summary": "Get event logs for specific entity (e.g., api::order.order/123)", "operationId": "event-log_findByEntity", "tags": [ "Event Log" ], "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/event-logs/timeline/{uid}/{id}": { "get": { "summary": "Get timeline view of events for entity", "operationId": "event-log_timeline", "tags": [ "Event Log" ], "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/event-logs/order-timeline/{orderId}": { "get": { "summary": "Get timeline view for order including related deals and coins transactions", "operationId": "event-log_orderTimeline", "tags": [ "Event Log" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/helper/settings/global": { "get": { "summary": "GET /settings/global", "operationId": "plugin::helper_settings.getGlobal", "tags": [ "Admin: Settings" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /settings/global", "operationId": "api::global_global.update", "tags": [ "Admin: Settings" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/intercom/webhook": { "post": { "summary": "Webhook endpoint for receiving Intercom events", "operationId": "intercom_processWebhookEvent", "tags": [ "Intercom" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/manufacturers/sync": { "post": { "summary": "Sync manufacturers from Shopware", "operationId": "manufacturer_sync", "tags": [ "Manufacturer" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/manufacturers/shopware/{id}": { "put": { "summary": "Update manufacturer by Shopware manufacturer ID", "operationId": "manufacturer_updateByShopwareId", "tags": [ "Manufacturer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/mattermost/profile": { "get": { "summary": "Get or create Mattermost credentials for current admin user", "operationId": "mattermost_ensureMmCredentials", "tags": [ "Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/customer/{customerId}/ensure": { "get": { "summary": "Ensure customer has Mattermost user account", "operationId": "mattermost_ensureCustomer", "tags": [ "Mattermost" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/test": { "get": { "summary": "Test Mattermost connection and configuration", "operationId": "mattermost_test", "tags": [ "Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/channels": { "post": { "summary": "Create a new Mattermost channel", "operationId": "mattermost_createChannel", "tags": [ "Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/mattermost/channels/{channelId}": { "get": { "summary": "Get Mattermost channel details by ID", "operationId": "mattermost_getChannel", "tags": [ "Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/channels/{channelId}/posts": { "get": { "summary": "Get posts/messages from a Mattermost channel", "operationId": "mattermost_getChannelPosts", "tags": [ "Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "summary": "Create a new post/message in a Mattermost channel", "operationId": "mattermost_createPost", "tags": [ "Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/mattermost/posts/{postId}": { "put": { "summary": "Update an existing Mattermost post/message", "operationId": "mattermost_updatePost", "tags": [ "Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } }, "delete": { "summary": "Delete a Mattermost post/message", "operationId": "mattermost_deletePost", "tags": [ "Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/files/{fileId}": { "get": { "summary": "Get file attachment from Mattermost", "operationId": "mattermost_getFile", "tags": [ "Mattermost" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/files/{fileId}/thumbnail": { "get": { "summary": "Get file thumbnail from Mattermost", "operationId": "mattermost_getFileThumbnail", "tags": [ "Mattermost" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/channels/{channelId}/mentionable": { "get": { "summary": "Get mentionable users and roles for a channel", "operationId": "mattermost_getMentionableUsers", "tags": [ "Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/channels/{channelId}/files": { "post": { "summary": "Upload files to a Mattermost channel", "operationId": "mattermost_uploadFiles", "tags": [ "Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/mattermost/search": { "post": { "summary": "Search chat messages across all channels", "operationId": "mattermost_searchChats", "tags": [ "Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/mattermost/channels/stats": { "post": { "summary": "Get channels stats", "description": "Get statistics for multiple channels including last message time and message count", "tags": [ "Mattermost" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "channelIds" ], "properties": { "channelIds": { "type": "array", "items": { "type": "string" }, "description": "Array of channel IDs to get stats for" } } } } } }, "responses": { "200": { "description": "Channel statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "stats": { "type": "object", "additionalProperties": { "type": "object", "properties": { "lastPostAt": { "type": "integer", "description": "Unix timestamp of last post" }, "messageCount": { "type": "integer", "description": "Total message count in channel" } } } } } } } } }, "400": { "description": "Invalid request - channelIds array required" }, "500": { "description": "Failed to get channel stats" } } } }, "/mattermost/posts/{postId}/reactions/{emoji}": { "post": { "summary": "Add a reaction to a post", "operationId": "mattermost_addReaction", "tags": [ "Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } }, "delete": { "summary": "Remove a reaction from a post", "operationId": "mattermost_removeReaction", "tags": [ "Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/mattermost/posts/{postId}/reactions": { "get": { "summary": "Get all reactions for a post", "operationId": "mattermost_getReactions", "tags": [ "Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/notifications/count": { "get": { "summary": "Get unread notifications count for current user", "operationId": "notification_count", "tags": [ "Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/notifications/{id}/read": { "put": { "summary": "Mark notification as read", "operationId": "notification_markAsRead", "tags": [ "Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/notifications/read-multiple": { "put": { "summary": "Mark multiple notifications as read", "operationId": "notification_markMultipleAsRead", "tags": [ "Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/notifications/read-all": { "put": { "summary": "Mark all notifications as read for current user", "operationId": "notification_markAllAsRead", "tags": [ "Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/offers/{id}/apply": { "post": { "summary": "Apply to offer (submit provider application)", "operationId": "offer_apply", "tags": [ "Offer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/offers/{id}/edit": { "post": { "summary": "Edit offer details", "operationId": "offer_edit", "tags": [ "Offer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/offers/{id}/withdraw": { "post": { "summary": "Withdraw offer from marketplace", "operationId": "offer_withdraw", "tags": [ "Offer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/upsert": { "post": { "summary": "Create or update order from external source", "operationId": "order_upsert", "tags": [ "Order" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/{id}/refresh": { "post": { "summary": "Refresh order data from external sources", "operationId": "order_refresh", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/discord/{id}": { "put": { "summary": "Update order by Discord thread ID", "operationId": "order_updateByDiscordId", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/shopware/{id}": { "put": { "summary": "Update order by Shopware order ID", "operationId": "order_updateByShopwareId", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } }, "get": { "summary": "Find order by Shopware order ID", "operationId": "order_getByShopwareId", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/orders/intercom/{id}": { "get": { "summary": "Find order by Intercom conversation ID", "operationId": "order_getByIntercomId", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/orders/{id}/deals": { "post": { "summary": "Check and create deals for order line items", "operationId": "order_checkDeals", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } }, "put": { "summary": "Update deals associated with order", "operationId": "order_updateDeals", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/shopware": { "post": { "summary": "Create order from Shopware data", "operationId": "order_createShopwareOrder", "tags": [ "Order" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/{id}/status": { "post": { "summary": "Update order status", "operationId": "order_setStatus", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/intercom/{id}/status": { "put": { "summary": "Update order status by Intercom conversation ID", "operationId": "order_setStatusByIntercomId", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/{id}/migrate-to-mattermost": { "post": { "summary": "Migrate order chat from Discord to Mattermost", "operationId": "order_migrateToMattermost", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/orders/{id}/migration-status": { "get": { "summary": "Get Mattermost migration status for order", "operationId": "order_getMigrationStatus", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/orders/{id}/line-items": { "get": { "summary": "Get sanitized line items for an order", "description": "Returns line items with sanitized optionsComment (internal options filtered out)", "tags": [ "Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sanitized line items", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } } } } } } }, "404": { "description": "Order not found" } } } }, "/payouts/status": { "post": { "summary": "Update payout status (pending, processing, completed, failed)", "operationId": "payout_setStatus", "tags": [ "Payout" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/payouts/{id}/change": { "put": { "summary": "Change payout details (amount, method, etc)", "operationId": "payout_change", "tags": [ "Payout" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/products/sync": { "post": { "summary": "Sync products from Shopware", "operationId": "product_sync", "tags": [ "Product" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/products/shopware/{id}": { "put": { "summary": "Update product by Shopware product ID", "operationId": "product_updateByShopwareId", "tags": [ "Product" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/profiles/sync-services": { "post": { "summary": "Sync service types for profiles", "operationId": "profile_syncServiceTypes", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/profiles/discord/{id}": { "get": { "summary": "Find profile by Discord user ID", "operationId": "profile_getByDiscordId", "tags": [ "Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/intercom/{id}": { "get": { "summary": "Find profile by Intercom contact ID", "operationId": "profile_getByIntercomId", "tags": [ "Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/{id}/kyc": { "put": { "summary": "PUT /profiles/:id/kyc", "operationId": "profile_updateKycStatus", "tags": [ "Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/profiles/{id}/kyc/request": { "post": { "summary": "POST /profiles/:id/kyc/request", "operationId": "profile_requestKyc", "tags": [ "Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/profiles/unlinked": { "get": { "summary": "Get profiles not linked to any admin user", "operationId": "profile_getUnlinked", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/{id}/link-admin": { "post": { "summary": "Link an unlinked profile to the current admin user", "operationId": "profile_linkToAdmin", "tags": [ "Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/profiles/create-for-admin": { "post": { "summary": "Create a new profile for the current admin user", "operationId": "profile_createForAdmin", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/profiles/onboarding-status": { "get": { "summary": "Check if current admin user has completed onboarding", "operationId": "profile_checkOnboardingStatus", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/managers": { "get": { "summary": "Get profiles that can be assigned as managers", "operationId": "profile_getManagerProfiles", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/providers": { "get": { "summary": "Get profiles linked to providers (excluding admin profiles)", "operationId": "profile_getProviderProfiles", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/admins": { "get": { "summary": "Get profiles linked to active admin users", "operationId": "profile_getAdminProfiles", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/{id}/status": { "post": { "summary": "Update provider status", "operationId": "action_setStatus", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/providers/{id}/wallets": { "post": { "summary": "Set provider wallet status", "operationId": "action_setWalletStatus", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } }, "put": { "summary": "Adjust provider wallet balances (main, requested, paid, pending)", "operationId": "action_adjustWallets", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/providers/stats": { "get": { "summary": "Get deal statistics for multiple providers", "description": "Returns aggregated deal counts (completed, active, failed) for specified providers", "tags": [ "Provider" ], "parameters": [ { "name": "ids", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Comma-separated list of provider IDs" } ], "responses": { "200": { "description": "Provider stats", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "object", "properties": { "completed": { "type": "integer" }, "active": { "type": "integer" }, "failed": { "type": "integer" } } } } } } } } }, "400": { "description": "Invalid or missing ids parameter" } } } }, "/providers/active-service-types": { "get": { "summary": "Get provider activity per service type", "description": "Returns which providers have deals on which service types within a time window", "tags": [ "Provider" ], "parameters": [ { "name": "serviceTypes", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated list of service type IDs to filter by" }, { "name": "months", "in": "query", "required": false, "schema": { "type": "integer", "default": 3 }, "description": "Time window in months (default 3)" } ], "responses": { "200": { "description": "Active service types data", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "integer" } } }, "meta": { "type": "object", "properties": { "windowMonths": { "type": "integer" }, "generatedAt": { "type": "string", "format": "date-time" } } } } } } } } } } }, "/providers/{id}/permissions": { "post": { "summary": "Check provider permissions", "operationId": "provider_checkPermissions", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/providers/{id}/log/wallets": { "get": { "summary": "Get provider wallet history log", "operationId": "provider_logWallets", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/{id}/receipt": { "post": { "summary": "Generate payment receipt for provider", "operationId": "provider_getReceipt", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/providers/{id}/payouts": { "post": { "summary": "Request payout for provider", "operationId": "provider_requestPayout", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/providers/{id}/log/payouts": { "get": { "summary": "Get provider payouts history log", "operationId": "provider_logPayouts", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/providers/{id}/log/transactions": { "get": { "summary": "Get provider transactions history log", "operationId": "provider_logTransactions", "tags": [ "Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/reports/{slug}": { "get": { "summary": "Generate report by slug (requires authentication)", "operationId": "report_report", "tags": [ "Report" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/reports/{slug}/public": { "get": { "summary": "Generate public report by slug (no authentication)", "operationId": "report_reportPublic", "tags": [ "Report" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/sales-channels/sync": { "post": { "summary": "Sync sales channels from Shopware", "operationId": "sales-channel_sync", "tags": [ "Sales Channel" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/sales-channels/shopware/{id}": { "put": { "summary": "Update sales channel by Shopware ID", "operationId": "sales-channel_updateByShopwareId", "tags": [ "Sales Channel" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/search/omnisearch": { "get": { "summary": "GET /search/omnisearch", "operationId": "search_omnisearch", "tags": [], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/search/reindex": { "post": { "summary": "POST /search/reindex", "operationId": "search_reindex", "tags": [], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/search/stats": { "get": { "summary": "GET /search/stats", "operationId": "search_stats", "tags": [], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/shopware/customers": { "get": { "summary": "Search customers in Shopware", "operationId": "shopware_searchCustomers", "tags": [ "Shopware" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } }, "post": { "summary": "Create customer in Shopware", "operationId": "shopware_createCustomer", "tags": [ "Shopware" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/shopware/manufacturers": { "get": { "summary": "Search manufacturers in Shopware", "operationId": "shopware_searchManufacturers", "tags": [ "Shopware" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/helper/teams": { "get": { "summary": "GET /teams", "operationId": "api::team_team-admin.list", "tags": [ "Admin: Team" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /teams", "operationId": "api::team_team-admin.create", "tags": [ "Admin: Team" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/teams/{id}": { "get": { "summary": "GET /teams/:id", "operationId": "api::team_team-admin.findOne", "tags": [ "Admin: Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /teams/:id", "operationId": "api::team_team-admin.update", "tags": [ "Admin: Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /teams/:id", "operationId": "api::team_team-admin.delete", "tags": [ "Admin: Team" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/teams/default-assignments": { "get": { "summary": "GET /teams/default-assignments", "operationId": "api::team_team-admin.getDefaultAssignments", "tags": [ "Admin: Team" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/teams/default-assignments/{entityType}": { "put": { "summary": "PUT /teams/default-assignments/:entityType", "operationId": "api::team_team-admin.updateDefaultAssignment", "tags": [ "Admin: Team" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/liveness": { "get": { "summary": "Liveness probe — simple alive check for Kubernetes", "operationId": "health_liveness", "tags": [ "Telemetry" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/health": { "get": { "summary": "Readiness probe — full dependency check for Kubernetes", "operationId": "health_readiness", "tags": [ "Telemetry" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/metrics": { "get": { "summary": "Prometheus metrics endpoint", "operationId": "metrics_getMetrics", "tags": [ "Telemetry" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/tickets/with-chat": { "post": { "summary": "POST /tickets/with-chat", "operationId": "ticket_createWithChat", "tags": [], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/tickets/{id}/resolve": { "post": { "summary": "POST /tickets/:id/resolve", "operationId": "ticket_resolve", "tags": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/tickets/{id}/close": { "post": { "summary": "POST /tickets/:id/close", "operationId": "ticket_close", "tags": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/tickets/{id}/reopen": { "post": { "summary": "POST /tickets/:id/reopen", "operationId": "ticket_reopen", "tags": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/webhook-deliveries/list": { "get": { "summary": "List webhook deliveries", "description": "Retrieve paginated list of webhook deliveries with optional filters by subscription, status, and date range", "tags": [ "WebhookDelivery" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "default": 20 }, "description": "Items per page" }, { "name": "subscriptionId", "in": "query", "schema": { "type": "integer" }, "description": "Filter by subscription ID" }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "pending", "delivered", "failed", "cancelled" ] }, "description": "Filter by delivery status" }, { "name": "eventLogId", "in": "query", "schema": { "type": "integer" }, "description": "Filter by event log ID" }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filter deliveries from this date" }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Filter deliveries until this date" } ], "responses": { "200": { "description": "Paginated list of deliveries", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDelivery" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object" } } } } } } } } } } }, "/webhook-deliveries/{id}/details": { "get": { "summary": "Get delivery details", "description": "Retrieve detailed information about a specific webhook delivery including request/response data", "tags": [ "WebhookDelivery" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Delivery ID" } ], "responses": { "200": { "description": "Delivery details", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookDelivery" } } } } } }, "404": { "description": "Delivery not found" } } } }, "/webhook-deliveries/{id}/retry": { "post": { "summary": "Retry failed delivery", "description": "Queue a failed or cancelled webhook delivery for retry. Only non-delivered deliveries can be retried.", "tags": [ "WebhookDelivery" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Delivery ID" } ], "responses": { "200": { "description": "Delivery queued for retry", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookDelivery" } } } } } }, "400": { "description": "Delivery cannot be retried (already delivered or invalid state)" }, "404": { "description": "Delivery not found" } } } }, "/webhook-deliveries/{id}/cancel": { "delete": { "summary": "Cancel pending delivery", "description": "Cancel a pending webhook delivery before it is processed. Only pending deliveries can be cancelled.", "tags": [ "WebhookDelivery" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Delivery ID" } ], "responses": { "200": { "description": "Delivery cancelled", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookDelivery" } } } } } }, "400": { "description": "Delivery cannot be cancelled (not in pending state)" }, "404": { "description": "Delivery not found" } } } }, "/webhook-subscriptions/list": { "get": { "summary": "List webhook subscriptions", "description": "Retrieve paginated list of webhook subscriptions with delivery statistics", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "default": 20 }, "description": "Items per page" }, { "name": "enabled", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Filter by enabled status" }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Search by name or URL" } ], "responses": { "200": { "description": "Paginated list of subscriptions with stats", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookSubscription" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object" } } } } } } } } } } }, "/webhook-subscriptions/{id}/details": { "get": { "summary": "Get subscription details", "description": "Retrieve detailed information about a specific webhook subscription including delivery statistics", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Subscription ID" } ], "responses": { "200": { "description": "Subscription details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscription" } } } }, "404": { "description": "Subscription not found" } } } }, "/webhook-subscriptions/create": { "post": { "summary": "Create webhook subscription", "description": "Create a new webhook subscription. Returns the subscription details including\na one-time secret that should be saved securely for signature verification.\n", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "url", "eventPatterns" ], "properties": { "name": { "type": "string", "description": "Human-readable name for the subscription" }, "url": { "type": "string", "format": "uri", "description": "Webhook endpoint URL (must be HTTPS in production)" }, "description": { "type": "string", "description": "Optional description" }, "eventPatterns": { "type": "array", "items": { "type": "string" }, "description": "Event patterns to subscribe to (e.g., 'order.created', 'deal.*')" }, "entityTypes": { "type": "array", "items": { "type": "string" }, "description": "Entity types to filter (e.g., 'order', 'deal')" }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom headers to include in webhook requests" }, "retryPolicy": { "type": "object", "properties": { "maxRetries": { "type": "integer", "default": 3 }, "backoffMultiplier": { "type": "number", "default": 2 } } }, "rateLimitPerMinute": { "type": "integer", "default": 60 }, "timeoutMs": { "type": "integer", "default": 30000 } } } } } }, "responses": { "200": { "description": "Subscription created", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/WebhookSubscription" }, { "type": "object", "properties": { "secret": { "type": "string", "description": "One-time secret for signature verification" } } } ] } } } } } }, "400": { "description": "Invalid request body" } } } }, "/webhook-subscriptions/{id}/update": { "put": { "summary": "Update webhook subscription", "description": "Update an existing webhook subscription configuration", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Subscription ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "eventPatterns": { "type": "array", "items": { "type": "string" } }, "entityTypes": { "type": "array", "items": { "type": "string" } }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "retryPolicy": { "type": "object" }, "rateLimitPerMinute": { "type": "integer" }, "timeoutMs": { "type": "integer" } } } } } }, "responses": { "200": { "description": "Subscription updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebhookSubscription" } } } } } }, "400": { "description": "Invalid request body" }, "404": { "description": "Subscription not found" } } } }, "/webhook-subscriptions/{id}/delete": { "delete": { "summary": "Delete webhook subscription", "description": "Soft delete a webhook subscription (disables but retains for audit)", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Subscription ID" } ], "responses": { "200": { "description": "Subscription deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "deleted": { "type": "boolean" } } } } } } } }, "404": { "description": "Subscription not found" } } } }, "/webhook-subscriptions/{id}/test": { "post": { "summary": "Test webhook subscription", "description": "Send a test webhook payload to verify the subscription endpoint is working correctly", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Subscription ID" } ], "responses": { "200": { "description": "Test result", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "statusCode": { "type": "integer" }, "responseTime": { "type": "integer", "description": "Response time in milliseconds" }, "error": { "type": "string" } } } } } } } }, "400": { "description": "Test failed" }, "404": { "description": "Subscription not found" } } } }, "/webhook-subscriptions/{id}/regenerate-secret": { "post": { "summary": "Regenerate webhook secret", "description": "Generate a new signing secret for the subscription. The old secret will\nbe invalidated immediately. Save the new secret securely.\n", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Subscription ID" } ], "responses": { "200": { "description": "New secret generated", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "secret": { "type": "string", "description": "New signing secret (one-time display)" } } } } } } } }, "404": { "description": "Subscription not found" } } } }, "/webhook-subscriptions/{id}/stats": { "get": { "summary": "Get subscription statistics", "description": "Retrieve delivery statistics for a webhook subscription including success/failure rates", "tags": [ "WebhookSubscription" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Subscription ID" } ], "responses": { "200": { "description": "Subscription statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "totalDeliveries": { "type": "integer" }, "successfulDeliveries": { "type": "integer" }, "failedDeliveries": { "type": "integer" }, "pendingDeliveries": { "type": "integer" }, "successRate": { "type": "number", "format": "float" }, "avgResponseTime": { "type": "number", "description": "Average response time in milliseconds" }, "lastDeliveryAt": { "type": "string", "format": "date-time" } } } } } } } }, "404": { "description": "Subscription not found" } } } }, "/provider/applications": { "get": { "summary": "List provider applications", "description": "Returns a paginated list of applications submitted by the authenticated provider.\nIncludes related offer and deal information.\n", "tags": [ "Provider Applications" ], "security": [ { "cookieAuth": [] } ], "parameters": [ { "name": "filters[active][$eq]", "in": "query", "schema": { "type": "boolean" }, "description": "Filter by active status" }, { "name": "sort", "in": "query", "schema": { "type": "string", "default": "createdAt:desc" }, "description": "Sort field and direction" }, { "name": "pagination[page]", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "pagination[pageSize]", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 }, "description": "Items per page (max 100)" }, { "$ref": "#/components/parameters/XProviderId" } ], "responses": { "200": { "description": "List of applications", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "active": { "type": "boolean" }, "price": { "type": "number" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "offer": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "deal": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "number" }, "status": { "type": "string" }, "serviceType": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } } } } } } } }, "meta": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } } }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/applications/{id}": { "get": { "summary": "Get application by ID", "description": "Returns a single application by ID. Only returns applications\nbelonging to the authenticated provider (RLS enforced).\n", "tags": [ "Provider Applications" ], "security": [ { "cookieAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Application ID" }, { "$ref": "#/components/parameters/XProviderId" } ], "responses": { "200": { "description": "Application details", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "active": { "type": "boolean" }, "price": { "type": "number" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "offer": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "deal": { "type": "object" } } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "404": { "description": "Application not found" }, "500": { "description": "Server error" } } }, "delete": { "summary": "Withdraw application", "description": "Withdraws an active application. Only the provider who submitted\nthe application can withdraw it. Cannot withdraw if the application\nhas already been accepted.\n", "tags": [ "Provider Applications" ], "security": [ { "cookieAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Application ID" }, { "$ref": "#/components/parameters/XProviderId" } ], "responses": { "200": { "description": "Application withdrawn successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "boolean", "example": true } } } } } } } }, "400": { "description": "Cannot withdraw (already accepted or other error)", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string" } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } } }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/auth": { "get": { "summary": "Better Auth GET handler", "description": "Handles Better Auth GET requests including:\n- `GET /provider/auth/get-session` - Get current session\n- `GET /provider/auth/callback/discord` - Discord OAuth callback\n", "tags": [ "Provider Auth" ], "responses": { "200": { "description": "Auth response (varies by endpoint)" }, "302": { "description": "OAuth redirect" }, "401": { "description": "Unauthorized" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "post": { "summary": "Better Auth POST handler", "description": "Handles Better Auth POST requests including:\n- `POST /provider/auth/sign-up/email` - Register with email/password\n- `POST /provider/auth/sign-in/email` - Sign in with email/password\n- `POST /provider/auth/sign-in/social` - Initiate Discord OAuth\n- `POST /provider/auth/sign-out` - Sign out and clear session\n- `POST /provider/auth/forget-password` - Request password reset\n- `POST /provider/auth/reset-password` - Complete password reset\n", "tags": [ "Provider Auth" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Request body varies by endpoint" } } } }, "responses": { "200": { "description": "Auth response (varies by endpoint)" }, "302": { "description": "OAuth redirect" }, "400": { "description": "Validation error" }, "401": { "description": "Invalid credentials" }, "500": { "description": "Authentication error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/deals": { "get": { "summary": "List provider deals", "description": "Returns a paginated list of deals assigned to the authenticated provider.\nSupports filtering by status, sorting, and pagination.\n", "tags": [ "Provider Deals" ], "security": [ { "cookieAuth": [] } ], "parameters": [ { "name": "filters[status][$eq]", "in": "query", "schema": { "type": "string", "enum": [ "draft", "open", "assigned", "on_approval", "completed", "failed" ] }, "description": "Filter by deal status" }, { "name": "sort", "in": "query", "schema": { "type": "string", "default": "createdAt:desc" }, "description": "Sort field and direction (e.g., createdAt:desc)" }, { "name": "pagination[page]", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "pagination[pageSize]", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 }, "description": "Items per page (max 100)" }, { "$ref": "#/components/parameters/XProviderId" } ], "responses": { "200": { "description": "List of deals", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "open", "assigned", "on_approval", "completed", "failed" ] }, "price": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "serviceType": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } } } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } } }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/deals/{id}": { "get": { "summary": "Get deal by ID", "description": "Returns a single deal by ID. Only returns deals assigned to the\nauthenticated provider (RLS enforced).\n", "tags": [ "Provider Deals" ], "security": [ { "cookieAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Deal ID" }, { "$ref": "#/components/parameters/XProviderId" } ], "responses": { "200": { "description": "Deal details", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "open", "assigned", "on_approval", "completed", "failed" ] }, "price": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "openedAt": { "type": "string", "format": "date-time" }, "assignedAt": { "type": "string", "format": "date-time" }, "closedAt": { "type": "string", "format": "date-time" }, "deadlineAt": { "type": "string", "format": "date-time" }, "statusComment": { "type": "string" }, "sessionState": { "type": "string" }, "serviceType": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } }, "details": { "type": "object", "description": "Deal details component (varies by service type)" } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "404": { "description": "Deal not found" }, "500": { "description": "Server error" } } }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/onboarding/status": { "get": { "summary": "Get onboarding status", "description": "Returns the current onboarding status and completion state\nfor the authenticated provider. Used to determine which\nonboarding steps are complete and which are pending.\n", "tags": [ "Provider Onboarding" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "Onboarding status", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "isComplete": { "type": "boolean", "description": "Whether onboarding is fully complete" }, "steps": { "type": "object", "properties": { "profile": { "type": "boolean", "description": "Display name is set" }, "serviceTypes": { "type": "boolean", "description": "At least one service type selected" } } }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" } } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "404": { "description": "Provider not found" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/onboarding/submit": { "post": { "summary": "Submit onboarding form", "description": "Submits the onboarding form with profile information and\nselected service types. Validates all required fields and\nupdates the provider's profile.\n", "tags": [ "Provider Onboarding" ], "security": [ { "cookieAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "displayName", "serviceTypeIds" ], "properties": { "displayName": { "type": "string", "minLength": 2, "maxLength": 50, "description": "Provider's display name" }, "serviceTypeIds": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "description": "IDs of selected service types" }, "bio": { "type": "string", "maxLength": 500, "description": "Optional bio/description" } } } } } }, "responses": { "200": { "description": "Onboarding submitted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "success": { "type": "boolean" }, "provider": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" } } } } } } } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "message": { "type": "string", "example": "Display name is required" } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/onboarding/service-types": { "get": { "summary": "Get available service types", "description": "Returns a list of available service types that providers\ncan select during onboarding. Service types define what\nkinds of services the provider can offer.\n", "tags": [ "Provider Onboarding" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "List of service types", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/payouts": { "get": { "summary": "List provider payouts", "description": "Returns a paginated list of payouts for the authenticated provider.\nIncludes related deal information.\n", "tags": [ "Provider Payouts" ], "security": [ { "cookieAuth": [] } ], "parameters": [ { "name": "filters[status][$eq]", "in": "query", "schema": { "type": "string", "enum": [ "pending", "approved", "processing", "paid", "failed", "cancelled" ] }, "description": "Filter by payout status" }, { "name": "sort", "in": "query", "schema": { "type": "string", "default": "createdAt:desc" }, "description": "Sort field and direction" }, { "name": "pagination[page]", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Page number" }, { "name": "pagination[pageSize]", "in": "query", "schema": { "type": "integer", "default": 25, "maximum": 100 }, "description": "Items per page (max 100)" }, { "$ref": "#/components/parameters/XProviderId" } ], "responses": { "200": { "description": "List of payouts", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "approved", "processing", "paid", "failed", "cancelled" ] }, "amount": { "type": "number" }, "fee": { "type": "number" }, "total": { "type": "number" }, "mode": { "type": "string", "enum": [ "free", "standard", "fast", "priority", "urgent" ] }, "currency": { "type": "string", "enum": [ "EUR", "USD", "GBP" ] }, "createdAt": { "type": "string", "format": "date-time" }, "processedAt": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "number" } } } } } } }, "meta": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } } }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/payouts/{id}": { "get": { "summary": "Get payout by ID", "description": "Returns a single payout by ID. Only returns payouts belonging\nto the authenticated provider (RLS enforced).\n", "tags": [ "Provider Payouts" ], "security": [ { "cookieAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Payout ID" }, { "$ref": "#/components/parameters/XProviderId" } ], "responses": { "200": { "description": "Payout details", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "approved", "processing", "paid", "failed", "cancelled" ] }, "amount": { "type": "number" }, "fee": { "type": "number" }, "total": { "type": "number" }, "mode": { "type": "string" }, "currency": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "processedAt": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "price": { "type": "number" } } } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "404": { "description": "Payout not found" }, "500": { "description": "Server error" } } }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/payouts/summary": { "get": { "summary": "Get payout summary", "description": "Returns a summary of payouts grouped by status.\nUseful for dashboard displays showing pending/paid amounts.\n", "tags": [ "Provider Payouts" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "Payout summary by status", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "pending": { "type": "object", "properties": { "count": { "type": "integer" }, "amount": { "type": "number" } } }, "approved": { "type": "object", "properties": { "count": { "type": "integer" }, "amount": { "type": "number" } } }, "processing": { "type": "object", "properties": { "count": { "type": "integer" }, "amount": { "type": "number" } } }, "paid": { "type": "object", "properties": { "count": { "type": "integer" }, "amount": { "type": "number" } } }, "total": { "type": "object", "properties": { "count": { "type": "integer" }, "amount": { "type": "number" } } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/me": { "get": { "summary": "Get current provider profile", "description": "Returns the authenticated provider's profile including:\n- Basic info (name, status, type, skill level)\n- Account status (active, financialStatus)\n- Related data (owner, wallets, serviceTypes, avatar)\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "Provider profile", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "new", "pending", "active", "inactive", "blocked" ] }, "type": { "type": "string" }, "active": { "type": "boolean" }, "financialStatus": { "type": "string" }, "owner": { "type": "object", "properties": { "id": { "type": "integer" }, "email": { "type": "string" }, "username": { "type": "string" } } }, "wallets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "balance": { "type": "number" }, "type": { "type": "string" }, "currency": { "type": "string" } } } }, "serviceTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "404": { "description": "Provider not found" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "patch": { "summary": "Update provider profile", "description": "Updates the authenticated provider's profile.\nCurrently supports updating the provider name only.\nName must be 2-32 characters, alphanumeric with underscore/dash/dot.\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 32, "pattern": "^[0-9a-zA-Z_\\-\\.]{2,32}$", "description": "Provider display name" } } } } } }, "responses": { "200": { "description": "Updated provider profile" }, "400": { "description": "Validation error (invalid format or missing field)" }, "401": { "description": "Unauthorized - no valid session" }, "403": { "description": "Forbidden - account is blocked" }, "409": { "description": "Conflict - name already taken" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/dashboard": { "get": { "summary": "Get dashboard statistics", "description": "Returns aggregated statistics for the provider's dashboard including:\n- Deal counts by status\n- Active applications count\n- Pending payouts\n- Earnings summary\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "Dashboard statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deals": { "type": "object", "properties": { "active": { "type": "integer" }, "completed": { "type": "integer" }, "total": { "type": "integer" } } }, "applications": { "type": "object", "properties": { "pending": { "type": "integer" } } }, "payouts": { "type": "object", "properties": { "pending": { "type": "integer" }, "pendingAmount": { "type": "number" } } }, "earnings": { "type": "object", "properties": { "total": { "type": "number" }, "thisMonth": { "type": "number" } } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/wallets": { "get": { "summary": "Get wallet balances", "description": "Returns all wallet balances for the authenticated provider.\nProviders have multiple wallets for different purposes:\n- main: Available balance\n- requested: Pending payout requests\n- paid: Total paid out\n- pending: Pending earnings from deals\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "Wallet balances", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "balance": { "type": "number" }, "type": { "type": "string", "enum": [ "main", "requested", "paid", "pending" ] }, "currency": { "type": "string", "enum": [ "EUR", "USD", "GBP" ] } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/me/service-types": { "patch": { "summary": "Update provider service types", "description": "Updates the service types associated with the provider.\nAccepts an array of service type IDs.\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "serviceTypeIds" ], "properties": { "serviceTypeIds": { "type": "array", "items": { "type": "integer" }, "description": "Array of service type IDs" } } } } } }, "responses": { "200": { "description": "Updated provider profile with new service types" }, "400": { "description": "Validation error" }, "401": { "description": "Unauthorized - no valid session" }, "403": { "description": "Forbidden - account is blocked" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/providers": { "get": { "summary": "Get all providers for current profile", "description": "Returns all providers that the current profile owns or is a member of.\nUsed for provider switching functionality.\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "List of providers with role information", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "active": { "type": "boolean" }, "financialStatus": { "type": "string" }, "avatar": { "type": "object" }, "role": { "type": "string", "enum": [ "owner", "member" ] } } } } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/switch-provider": { "post": { "summary": "Switch active provider", "description": "Switches the active provider context for the current session.\nReturns a new JWT token with the updated provider ID.\nThe provider must be owned by or have the current profile as a member.\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "providerId" ], "properties": { "providerId": { "type": "integer", "description": "ID of the provider to switch to" } } } } } }, "responses": { "200": { "description": "Successfully switched provider", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "provider": { "type": "object" }, "role": { "type": "string", "enum": [ "owner", "member" ] }, "token": { "type": "string", "description": "New JWT token with updated provider context" } } } } } } } }, "400": { "description": "Invalid request (missing providerId)" }, "401": { "description": "Unauthorized - no valid session" }, "403": { "description": "Forbidden - no access to provider or provider is blocked" }, "404": { "description": "Provider not found" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/me/avatar": { "post": { "summary": "Upload provider avatar", "description": "Uploads a new avatar image for the provider.\nAccepts JPEG, PNG, or WebP images up to 5MB.\nReplaces any existing avatar.\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "Avatar image file (JPEG, PNG, or WebP, max 5MB)" } } } } } }, "responses": { "200": { "description": "Successfully uploaded avatar", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "Updated provider profile with new avatar" } } } } } }, "400": { "description": "Invalid file (wrong type, too large, or missing)" }, "401": { "description": "Unauthorized - no valid session" }, "403": { "description": "Forbidden - account is blocked" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/profile/has-password": { "get": { "summary": "Check if user has password authentication", "description": "Returns whether the current user has password authentication configured.\nUsed to determine if Discord unlinking is available.\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "responses": { "200": { "description": "Password auth status", "content": { "application/json": { "schema": { "type": "object", "properties": { "hasPassword": { "type": "boolean" } } } } } }, "401": { "description": "Unauthorized - no valid session" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/provider/profile/discord/unlink": { "post": { "summary": "Unlink Discord account", "description": "Unlinks the Discord account from the current profile.\nRequires password verification for security.\nUser must have password authentication configured.\n", "tags": [ "Provider Profile" ], "security": [ { "cookieAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "description": "User's password for verification" } } } } } }, "responses": { "200": { "description": "Discord unlinked successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "400": { "description": "Password required or user has no password auth" }, "401": { "description": "Invalid password" }, "500": { "description": "Server error" } }, "parameters": [ { "$ref": "#/components/parameters/XProviderId" } ] }, "servers": [ { "url": "https://stgadm.mmonster.co", "description": "Provider App BFF" } ] }, "/teams/validate/mention-name": { "get": { "summary": "Check mention name availability", "operationId": "api::core_validation.checkUsernameAvailability", "tags": [ "Team" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/profiles/validate/username": { "get": { "summary": "Check username availability", "operationId": "api::core_validation.checkUsernameAvailability", "tags": [ "Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/orders/sync": { "post": { "summary": "[DEPRECATED] Use POST /orders/upsert instead", "operationId": "order_upsert", "tags": [ "Order" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/{id}/dismiss": { "post": { "summary": "Dismiss an attention event", "operationId": "attention-event_dismiss", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/{id}/snooze": { "post": { "summary": "Snooze an attention event", "operationId": "attention-event_snooze", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/{id}/undo": { "post": { "summary": "Undo dismiss or snooze on an attention event", "operationId": "attention-event_undo", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/bulk": { "post": { "summary": "Bulk operations on attention events", "operationId": "attention-event_bulk", "tags": [ "AttentionEvent" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/sections/{sectionId}/reactivate-dismissed": { "post": { "summary": "Reactivate all dismissed events in a section", "operationId": "attention-event_reactivateDismissed", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/sections/{sectionId}/reactivate-snoozed": { "post": { "summary": "Reactivate all snoozed events in a section", "operationId": "attention-event_reactivateSnoozed", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/queue": { "get": { "summary": "Get attention event queue for current user", "operationId": "attention-event_getQueue", "tags": [ "AttentionEvent" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/attention-events/for-entities": { "post": { "summary": "Get attention events for specific entities", "operationId": "attention-event_getForEntities", "tags": [ "AttentionEvent" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/attention-events/sections/{sectionId}/entity-ids": { "get": { "summary": "Get entity IDs with attention events in a section", "operationId": "attention-event_getEntityIds", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/attention-events/sections/{sectionId}/counts": { "get": { "summary": "Get attention event counts for a section", "operationId": "attention-event_getSectionCounts", "tags": [ "AttentionEvent" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } } } }, "/attention-events/reconcile": { "post": { "summary": "Reconcile attention events with current state", "operationId": "attention-event_reconcile", "tags": [ "AttentionEvent" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } } } }, "/helper/webhook-subscriptions": { "get": { "summary": "GET /webhook-subscriptions", "operationId": "api::webhook-subscription_webhook-subscription.findSubscriptions", "tags": [ "Admin: Webhook" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /webhook-subscriptions", "operationId": "api::webhook-subscription_webhook-subscription.createSubscription", "tags": [ "Admin: Webhook" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/webhook-subscriptions/{id}": { "get": { "summary": "GET /webhook-subscriptions/:id", "operationId": "api::webhook-subscription_webhook-subscription.findOneSubscription", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /webhook-subscriptions/:id", "operationId": "api::webhook-subscription_webhook-subscription.updateSubscription", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /webhook-subscriptions/:id", "operationId": "api::webhook-subscription_webhook-subscription.deleteSubscription", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/webhook-subscriptions/{id}/test": { "post": { "summary": "POST /webhook-subscriptions/:id/test", "operationId": "api::webhook-subscription_webhook-subscription.testSubscription", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/webhook-subscriptions/{id}/regenerate-secret": { "post": { "summary": "POST /webhook-subscriptions/:id/regenerate-secret", "operationId": "api::webhook-subscription_webhook-subscription.regenerateSecret", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/webhook-subscriptions/{id}/stats": { "get": { "summary": "GET /webhook-subscriptions/:id/stats", "operationId": "api::webhook-subscription_webhook-subscription.getSubscriptionStats", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/webhook-deliveries": { "get": { "summary": "GET /webhook-deliveries", "operationId": "api::webhook-delivery_webhook-delivery.findDeliveries", "tags": [ "Admin: Webhook" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/webhook-deliveries/{id}": { "get": { "summary": "GET /webhook-deliveries/:id", "operationId": "api::webhook-delivery_webhook-delivery.findOneDelivery", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /webhook-deliveries/:id", "operationId": "api::webhook-delivery_webhook-delivery.cancelDelivery", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/webhook-deliveries/{id}/retry": { "post": { "summary": "POST /webhook-deliveries/:id/retry", "operationId": "api::webhook-delivery_webhook-delivery.retryDelivery", "tags": [ "Admin: Webhook" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/wallet-transactions": { "get": { "summary": "GET /wallet-transactions", "operationId": "api::wallet-transaction_wallet-transaction.find", "tags": [ "Admin: Wallet Transaction" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /wallet-transactions", "operationId": "api::wallet-transaction_wallet-transaction.create", "tags": [ "Admin: Wallet Transaction" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/wallet-transactions/{id}": { "get": { "summary": "GET /wallet-transactions/:id", "operationId": "api::wallet-transaction_wallet-transaction.findOne", "tags": [ "Admin: Wallet Transaction" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /wallet-transactions/:id", "operationId": "api::wallet-transaction_wallet-transaction.update", "tags": [ "Admin: Wallet Transaction" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /wallet-transactions/:id", "operationId": "api::wallet-transaction_wallet-transaction.delete", "tags": [ "Admin: Wallet Transaction" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tickets": { "get": { "summary": "GET /tickets", "operationId": "api::ticket_ticket.find", "tags": [ "Admin: Ticket" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /tickets", "operationId": "api::ticket_ticket.create", "tags": [ "Admin: Ticket" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tickets/{id}": { "get": { "summary": "GET /tickets/:id", "operationId": "api::ticket_ticket.findOne", "tags": [ "Admin: Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /tickets/:id", "operationId": "api::ticket_ticket.update", "tags": [ "Admin: Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /tickets/:id", "operationId": "api::ticket_ticket.delete", "tags": [ "Admin: Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tickets/with-chat": { "post": { "summary": "POST /tickets/with-chat", "operationId": "api::ticket_ticket.createWithChat", "tags": [ "Admin: Ticket" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tickets/{id}/resolve": { "post": { "summary": "POST /tickets/:id/resolve", "operationId": "api::ticket_ticket.resolve", "tags": [ "Admin: Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tickets/{id}/close": { "post": { "summary": "POST /tickets/:id/close", "operationId": "api::ticket_ticket.close", "tags": [ "Admin: Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tickets/{id}/reopen": { "post": { "summary": "POST /tickets/:id/reopen", "operationId": "api::ticket_ticket.reopen", "tags": [ "Admin: Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/teams/validate/mention-name": { "get": { "summary": "GET /teams/validate/mention-name", "operationId": "api::core_validation.checkUsernameAvailability", "tags": [ "Admin: Team" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tags": { "get": { "summary": "GET /tags", "operationId": "api::tag_tag.find", "tags": [ "Admin: Tag" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /tags", "operationId": "api::tag_tag.create", "tags": [ "Admin: Tag" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tags/{id}": { "get": { "summary": "GET /tags/:id", "operationId": "api::tag_tag.findOne", "tags": [ "Admin: Tag" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /tags/:id", "operationId": "api::tag_tag.update", "tags": [ "Admin: Tag" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /tags/:id", "operationId": "api::tag_tag.delete", "tags": [ "Admin: Tag" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tags/assign/{entityType}/{entityId}": { "put": { "summary": "PUT /tags/assign/:entityType/:entityId", "operationId": "api::tag_tag.assign", "tags": [ "Admin: Tag" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/tags/entity/{entityType}/{entityId}": { "get": { "summary": "GET /tags/entity/:entityType/:entityId", "operationId": "api::tag_tag.getEntityTags", "tags": [ "Admin: Tag" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/stores": { "get": { "summary": "GET /stores", "operationId": "api::store_store.find", "tags": [ "Admin: Store" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /stores", "operationId": "api::store_store.create", "tags": [ "Admin: Store" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/stores/{id}": { "get": { "summary": "GET /stores/:id", "operationId": "api::store_store.findOne", "tags": [ "Admin: Store" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /stores/:id", "operationId": "api::store_store.update", "tags": [ "Admin: Store" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /stores/:id", "operationId": "api::store_store.delete", "tags": [ "Admin: Store" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/shopware/customers": { "get": { "summary": "GET /shopware/customers", "operationId": "api::shopware_shopware.searchCustomers", "tags": [ "Admin: Shopware" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /shopware/customers", "operationId": "api::shopware_shopware.createCustomer", "tags": [ "Admin: Shopware" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/shopware/manufacturers": { "get": { "summary": "GET /shopware/manufacturers", "operationId": "api::shopware_shopware.searchManufacturers", "tags": [ "Admin: Shopware" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/settings/discord": { "get": { "summary": "GET /settings/discord", "operationId": "api::discord_discord.find", "tags": [ "Admin: Settings" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /settings/discord", "operationId": "api::discord_discord.update", "tags": [ "Admin: Settings" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/service-types": { "get": { "summary": "GET /service-types", "operationId": "api::service-type_service-type.find", "tags": [ "Admin: Service Type" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /service-types", "operationId": "api::service-type_service-type.create", "tags": [ "Admin: Service Type" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/service-types/{id}": { "get": { "summary": "GET /service-types/:id", "operationId": "api::service-type_service-type.findOne", "tags": [ "Admin: Service Type" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /service-types/:id", "operationId": "api::service-type_service-type.update", "tags": [ "Admin: Service Type" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /service-types/:id", "operationId": "api::service-type_service-type.delete", "tags": [ "Admin: Service Type" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/report/{slug}": { "get": { "summary": "GET /report/:slug", "operationId": "api::report_report.report", "tags": [ "Admin: Report" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/me/access": { "get": { "summary": "GET /me/access", "operationId": "rbac_getMyAccess", "tags": [ "Admin: Rbac" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/settings/rbac": { "get": { "summary": "GET /settings/rbac", "operationId": "rbac_getSettings", "tags": [ "Admin: Rbac" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /settings/rbac", "operationId": "rbac_updateSettings", "tags": [ "Admin: Rbac" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/settings/rbac/roles": { "get": { "summary": "GET /settings/rbac/roles", "operationId": "rbac_getAvailableRoles", "tags": [ "Admin: Rbac" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/settings/rbac/domains": { "get": { "summary": "GET /settings/rbac/domains", "operationId": "rbac_getBusinessDomains", "tags": [ "Admin: Rbac" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/push/vapid-public-key": { "get": { "summary": "GET /push/vapid-public-key", "operationId": "api::push-subscription_push-subscription.getVapidPublicKey", "tags": [ "Admin: Push" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/push/subscriptions": { "get": { "summary": "GET /push/subscriptions", "operationId": "api::push-subscription_push-subscription.listSubscriptions", "tags": [ "Admin: Push" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/push/subscribe": { "post": { "summary": "POST /push/subscribe", "operationId": "api::push-subscription_push-subscription.subscribe", "tags": [ "Admin: Push" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/push/unsubscribe/{id}": { "delete": { "summary": "DELETE /push/unsubscribe/:id", "operationId": "api::push-subscription_push-subscription.unsubscribe", "tags": [ "Admin: Push" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/push/unsubscribe-all": { "delete": { "summary": "DELETE /push/unsubscribe-all", "operationId": "api::push-subscription_push-subscription.unsubscribeAll", "tags": [ "Admin: Push" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/providers/active-service-types": { "get": { "summary": "GET /providers/active-service-types", "operationId": "api::provider_action.getActiveServiceTypes", "tags": [ "Admin: Provider" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/providers/stats": { "get": { "summary": "GET /providers/stats", "operationId": "api::provider_action.getStats", "tags": [ "Admin: Provider" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/providers": { "get": { "summary": "GET /providers", "operationId": "api::provider_provider.find", "tags": [ "Admin: Provider" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /providers", "operationId": "api::provider_provider.create", "tags": [ "Admin: Provider" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/providers/{id}": { "get": { "summary": "GET /providers/:id", "operationId": "api::provider_provider.findOne", "tags": [ "Admin: Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /providers/:id", "operationId": "api::provider_provider.update", "tags": [ "Admin: Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /providers/:id", "operationId": "api::provider_provider.delete", "tags": [ "Admin: Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/providers/{id}/status": { "post": { "summary": "POST /providers/:id/status", "operationId": "api::provider_action.setStatus", "tags": [ "Admin: Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/providers/{id}/wallets": { "post": { "summary": "POST /providers/:id/wallets", "operationId": "api::provider_action.setWalletStatus", "tags": [ "Admin: Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /providers/:id/wallets", "operationId": "api::provider_action.adjustWallets", "tags": [ "Admin: Provider" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/me/profile": { "get": { "summary": "GET /me/profile", "operationId": "api::profile_profile.getCurrentProfile", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /me/profile", "operationId": "api::profile_profile.updateCurrentProfile", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/me/avatar": { "post": { "summary": "POST /me/avatar", "operationId": "api::profile_profile.uploadAvatar", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /me/avatar", "operationId": "api::profile_profile.deleteAvatar", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/me/settings": { "get": { "summary": "GET /me/settings", "operationId": "api::profile_profile.getSettings", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /me/settings", "operationId": "api::profile_profile.updateSettings", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/avatars/{profileId}/{filename}": { "get": { "summary": "GET /avatars/:profileId/:filename", "operationId": "api::profile_profile.getAvatar", "tags": [ "Admin: Profile" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "filename", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/avatars/{profileId}/{baseFilename}/{size}": { "get": { "summary": "GET /avatars/:profileId/:baseFilename/:size", "operationId": "api::profile_profile.getAvatarWithSize", "tags": [ "Admin: Profile" ], "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "baseFilename", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "size", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles/managers": { "get": { "summary": "GET /profiles/managers", "operationId": "api::profile_profile.getManagerProfiles", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles/providers": { "get": { "summary": "GET /profiles/providers", "operationId": "api::profile_profile.getProviderProfiles", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles/admins": { "get": { "summary": "GET /profiles/admins", "operationId": "api::profile_profile.getAdminProfiles", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles": { "get": { "summary": "GET /profiles", "operationId": "api::profile_profile.find", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /profiles", "operationId": "api::profile_profile.create", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles/{id}": { "get": { "summary": "GET /profiles/:id", "operationId": "api::profile_profile.findOne", "tags": [ "Admin: Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /profiles/:id", "operationId": "api::profile_profile.update", "tags": [ "Admin: Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /profiles/:id", "operationId": "api::profile_profile.delete", "tags": [ "Admin: Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles/{id}/kyc": { "put": { "summary": "PUT /profiles/:id/kyc", "operationId": "api::profile_profile.updateKycStatus", "tags": [ "Admin: Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles/{id}/kyc/request": { "post": { "summary": "POST /profiles/:id/kyc/request", "operationId": "api::profile_profile.requestKyc", "tags": [ "Admin: Profile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/profiles/validate/username": { "get": { "summary": "GET /profiles/validate/username", "operationId": "api::core_validation.checkUsernameAvailability", "tags": [ "Admin: Profile" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/payouts": { "get": { "summary": "GET /payouts", "operationId": "api::payout_payout.find", "tags": [ "Admin: Payout" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /payouts", "operationId": "api::payout_payout.create", "tags": [ "Admin: Payout" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/payouts/{id}": { "get": { "summary": "GET /payouts/:id", "operationId": "api::payout_payout.findOne", "tags": [ "Admin: Payout" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /payouts/:id", "operationId": "api::payout_payout.update", "tags": [ "Admin: Payout" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /payouts/:id", "operationId": "api::payout_payout.delete", "tags": [ "Admin: Payout" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/deals/{id}/early-payout": { "post": { "summary": "POST /deals/:id/early-payout", "operationId": "api::payout_payout.earlyPayout", "tags": [ "Admin: Payout" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/payouts/status": { "post": { "summary": "POST /payouts/status", "operationId": "api::payout_payout.setStatus", "tags": [ "Admin: Payout" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/payouts/{id}/change": { "put": { "summary": "PUT /payouts/:id/change", "operationId": "api::payout_payout.change", "tags": [ "Admin: Payout" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders": { "get": { "summary": "GET /orders", "operationId": "api::order_order.find", "tags": [ "Admin: Order" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /orders", "operationId": "api::order_order.create", "tags": [ "Admin: Order" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders/{id}": { "get": { "summary": "GET /orders/:id", "operationId": "api::order_order.findOne", "tags": [ "Admin: Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /orders/:id", "operationId": "api::order_order.update", "tags": [ "Admin: Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /orders/:id", "operationId": "api::order_order.delete", "tags": [ "Admin: Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders/upsert": { "post": { "summary": "POST /orders/upsert", "operationId": "api::order_order.upsert", "tags": [ "Admin: Order" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders/shopware": { "post": { "summary": "POST /orders/shopware", "operationId": "api::order_order.createShopwareOrder", "tags": [ "Admin: Order" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders/{id}/create-chat": { "post": { "summary": "POST /orders/:id/create-chat", "operationId": "api::order_order.createChat", "tags": [ "Admin: Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders/{id}/migrate-to-mattermost": { "post": { "summary": "POST /orders/:id/migrate-to-mattermost", "operationId": "api::order_order.migrateToMattermost", "tags": [ "Admin: Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders/{id}/migration-status": { "get": { "summary": "GET /orders/:id/migration-status", "operationId": "api::order_order.getMigrationStatus", "tags": [ "Admin: Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/orders/{id}/line-items": { "get": { "summary": "GET /orders/:id/line-items", "operationId": "api::order_order.getLineItems", "tags": [ "Admin: Order" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/onboarding/status": { "get": { "summary": "GET /onboarding/status", "operationId": "api::profile_profile.checkOnboardingStatus", "tags": [ "Admin: Onboarding" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/onboarding/profiles/unlinked": { "get": { "summary": "GET /onboarding/profiles/unlinked", "operationId": "api::profile_profile.getUnlinked", "tags": [ "Admin: Onboarding" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/onboarding/profiles/{id}/link": { "post": { "summary": "POST /onboarding/profiles/:id/link", "operationId": "api::profile_profile.linkToAdmin", "tags": [ "Admin: Onboarding" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/onboarding/profiles/create": { "post": { "summary": "POST /onboarding/profiles/create", "operationId": "api::profile_profile.createForAdmin", "tags": [ "Admin: Onboarding" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/auth/discord/status": { "get": { "summary": "GET /auth/discord/status", "operationId": "api::discord-oauth_discord-oauth.status", "tags": [ "Admin: Onboarding" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/auth/discord": { "get": { "summary": "GET /auth/discord", "operationId": "api::discord-oauth_discord-oauth.authorize", "tags": [ "Admin: Onboarding" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/omnisearch": { "get": { "summary": "GET /omnisearch", "operationId": "api::search_search.omnisearch", "tags": [ "Admin: Omnisearch" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/omnisearch/reindex": { "post": { "summary": "POST /omnisearch/reindex", "operationId": "api::search_search.reindex", "tags": [ "Admin: Omnisearch" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/omnisearch/stats": { "get": { "summary": "GET /omnisearch/stats", "operationId": "api::search_search.stats", "tags": [ "Admin: Omnisearch" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications/socket-debug": { "get": { "summary": "GET /notifications/socket-debug", "operationId": "anonymous", "tags": [ "Admin: Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications": { "get": { "summary": "GET /notifications", "operationId": "api::notification_notification.find", "tags": [ "Admin: Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications/test": { "post": { "summary": "POST /notifications/test", "operationId": "api::notification_notification.sendTest", "tags": [ "Admin: Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications/count": { "get": { "summary": "GET /notifications/count", "operationId": "api::notification_notification.count", "tags": [ "Admin: Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications/{id}/read": { "post": { "summary": "POST /notifications/:id/read", "operationId": "api::notification_notification.markAsRead", "tags": [ "Admin: Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications/{id}/unread": { "post": { "summary": "POST /notifications/:id/unread", "operationId": "api::notification_notification.markAsUnread", "tags": [ "Admin: Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications/read-multiple": { "post": { "summary": "POST /notifications/read-multiple", "operationId": "api::notification_notification.markMultipleAsRead", "tags": [ "Admin: Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/notifications/read-all": { "post": { "summary": "POST /notifications/read-all", "operationId": "api::notification_notification.markAllAsRead", "tags": [ "Admin: Notification" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/me/notification-preferences": { "get": { "summary": "GET /me/notification-preferences", "operationId": "api::profile_profile.getNotificationPreferences", "tags": [ "Admin: Notification Preferences" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /me/notification-preferences", "operationId": "api::profile_profile.updateNotificationPreferences", "tags": [ "Admin: Notification Preferences" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/admin/notification-delivery-logs": { "get": { "summary": "GET /admin/notification-delivery-logs", "operationId": "api::notification-delivery-log_notification-delivery-log.list", "tags": [ "Admin: Notification Delivery Logs" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/admin/notification-delivery-stats": { "get": { "summary": "GET /admin/notification-delivery-stats", "operationId": "api::notification-delivery-log_notification-delivery-log.stats", "tags": [ "Admin: Notification Delivery Logs" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/profile": { "get": { "summary": "GET /mattermost/profile", "operationId": "api::mattermost_mattermost.ensureMmCredentials", "tags": [ "Admin: Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/config": { "get": { "summary": "GET /mattermost/config", "operationId": "api::mattermost_mattermost.getConfig", "tags": [ "Admin: Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/customer/{customerId}/ensure": { "get": { "summary": "GET /mattermost/customer/:customerId/ensure", "operationId": "api::mattermost_mattermost.ensureCustomer", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/test": { "get": { "summary": "GET /mattermost/test", "operationId": "api::mattermost_mattermost.test", "tags": [ "Admin: Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/channels": { "post": { "summary": "POST /mattermost/channels", "operationId": "api::mattermost_mattermost.createChannel", "tags": [ "Admin: Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/channels/{channelId}": { "get": { "summary": "GET /mattermost/channels/:channelId", "operationId": "api::mattermost_mattermost.getChannel", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/channels/{channelId}/posts": { "get": { "summary": "GET /mattermost/channels/:channelId/posts", "operationId": "api::mattermost_mattermost.getChannelPosts", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /mattermost/channels/:channelId/posts", "operationId": "api::mattermost_mattermost.createPost", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/files/{fileId}": { "get": { "summary": "GET /mattermost/files/:fileId", "operationId": "api::mattermost_mattermost.getFile", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/files/{fileId}/thumbnail": { "get": { "summary": "GET /mattermost/files/:fileId/thumbnail", "operationId": "api::mattermost_mattermost.getFileThumbnail", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/posts/{postId}": { "put": { "summary": "PUT /mattermost/posts/:postId", "operationId": "api::mattermost_mattermost.updatePost", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /mattermost/posts/:postId", "operationId": "api::mattermost_mattermost.deletePost", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/channels/{channelId}/upload": { "post": { "summary": "POST /mattermost/channels/:channelId/upload", "operationId": "api::mattermost_mattermost.uploadFiles", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/channels/{channelId}/mentions": { "get": { "summary": "GET /mattermost/channels/:channelId/mentions", "operationId": "api::mattermost_mattermost.getMentionableUsers", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/search": { "post": { "summary": "POST /mattermost/search", "operationId": "api::mattermost_mattermost.searchChats", "tags": [ "Admin: Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/channels/stats": { "post": { "summary": "POST /mattermost/channels/stats", "operationId": "api::mattermost_mattermost.getChannelsStats", "tags": [ "Admin: Mattermost" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/posts/{postId}/reactions": { "post": { "summary": "POST /mattermost/posts/:postId/reactions", "operationId": "api::mattermost_mattermost.addReaction", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /mattermost/posts/:postId/reactions", "operationId": "api::mattermost_mattermost.removeReaction", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "get": { "summary": "GET /mattermost/posts/:postId/reactions", "operationId": "api::mattermost_mattermost.getReactions", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/posts/{postId}/pin": { "post": { "summary": "POST /mattermost/posts/:postId/pin", "operationId": "api::mattermost_mattermost.pinPost", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /mattermost/posts/:postId/pin", "operationId": "api::mattermost_mattermost.unpinPost", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "postId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/mattermost/channels/{channelId}/pins": { "get": { "summary": "GET /mattermost/channels/:channelId/pins", "operationId": "api::mattermost_mattermost.getPinnedPosts", "tags": [ "Admin: Mattermost" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/logs": { "get": { "summary": "GET /logs", "operationId": "api::log_log.find", "tags": [ "Admin: Log" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /logs", "operationId": "api::log_log.create", "tags": [ "Admin: Log" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/logs/{id}": { "get": { "summary": "GET /logs/:id", "operationId": "api::log_log.findOne", "tags": [ "Admin: Log" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /logs/:id", "operationId": "api::log_log.update", "tags": [ "Admin: Log" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /logs/:id", "operationId": "api::log_log.delete", "tags": [ "Admin: Log" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/event-logs": { "get": { "summary": "GET /event-logs", "operationId": "api::event-log_event-log.find", "tags": [ "Admin: Event Log" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/event-logs/entity/{uid}/{id}": { "get": { "summary": "GET /event-logs/entity/:uid/:id", "operationId": "api::event-log_event-log.findByEntity", "tags": [ "Admin: Event Log" ], "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/event-logs/order-timeline/{orderId}": { "get": { "summary": "GET /event-logs/order-timeline/:orderId", "operationId": "api::event-log_event-log.orderTimeline", "tags": [ "Admin: Event Log" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/event-logs/timeline/{uid}/{id}": { "get": { "summary": "GET /event-logs/timeline/:uid/:id", "operationId": "api::event-log_event-log.timeline", "tags": [ "Admin: Event Log" ], "parameters": [ { "name": "uid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/deals": { "get": { "summary": "GET /deals", "operationId": "api::deal_deal.find", "tags": [ "Admin: Deal" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /deals", "operationId": "api::deal_deal.create", "tags": [ "Admin: Deal" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/deals/{id}": { "get": { "summary": "GET /deals/:id", "operationId": "api::deal_deal.findOne", "tags": [ "Admin: Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /deals/:id", "operationId": "api::deal_deal.update", "tags": [ "Admin: Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /deals/:id", "operationId": "api::deal_deal.delete", "tags": [ "Admin: Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/deals/{id}/status": { "put": { "summary": "PUT /deals/:id/status", "operationId": "api::deal_deal.setStatus", "tags": [ "Admin: Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/customers": { "get": { "summary": "GET /customers", "operationId": "api::customer_customer.find", "tags": [ "Admin: Customer" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /customers", "operationId": "api::customer_customer.create", "tags": [ "Admin: Customer" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/customers/{id}": { "get": { "summary": "GET /customers/:id", "operationId": "api::customer_customer.findOne", "tags": [ "Admin: Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /customers/:id", "operationId": "api::customer_customer.update", "tags": [ "Admin: Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /customers/:id", "operationId": "api::customer_customer.delete", "tags": [ "Admin: Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/customers/{id}/kyc": { "put": { "summary": "PUT /customers/:id/kyc", "operationId": "api::customer_customer.updateKycStatus", "tags": [ "Admin: Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/customers/{id}/kyc/request": { "post": { "summary": "POST /customers/:id/kyc/request", "operationId": "api::customer_customer.requestKyc", "tags": [ "Admin: Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/customers/coins": { "post": { "summary": "POST /customers/coins", "operationId": "api::customer_customer.adjustCoins", "tags": [ "Admin: Customer" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/customers/{id}/coins": { "get": { "summary": "GET /customers/:id/coins", "operationId": "api::customer_customer.getCoins", "tags": [ "Admin: Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/customers/email": { "post": { "summary": "POST /customers/email", "operationId": "api::customer_customer.findByEmails", "tags": [ "Admin: Customer" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/coins-transactions": { "get": { "summary": "GET /coins-transactions", "operationId": "api::coins-transaction_coins-transaction.find", "tags": [ "Admin: Coins Transaction" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /coins-transactions", "operationId": "api::coins-transaction_coins-transaction.create", "tags": [ "Admin: Coins Transaction" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/coins-transactions/{id}": { "get": { "summary": "GET /coins-transactions/:id", "operationId": "api::coins-transaction_coins-transaction.findOne", "tags": [ "Admin: Coins Transaction" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /coins-transactions/:id", "operationId": "api::coins-transaction_coins-transaction.update", "tags": [ "Admin: Coins Transaction" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /coins-transactions/:id", "operationId": "api::coins-transaction_coins-transaction.delete", "tags": [ "Admin: Coins Transaction" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/notifications": { "get": { "summary": "GET /chats/notifications", "operationId": "api::chat_chat-notifications.getNotifications", "tags": [ "Admin: Chat" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/notifications/{id}/read": { "post": { "summary": "POST /chats/notifications/:id/read", "operationId": "api::chat_chat-notifications.markAsRead", "tags": [ "Admin: Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/notifications/read-all": { "post": { "summary": "POST /chats/notifications/read-all", "operationId": "api::chat_chat-notifications.markAllAsRead", "tags": [ "Admin: Chat" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/notifications/clear": { "post": { "summary": "POST /chats/notifications/clear", "operationId": "api::chat_chat-notifications.clearAll", "tags": [ "Admin: Chat" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/last-messages": { "post": { "summary": "POST /chats/last-messages", "operationId": "api::chat_chat-notifications.getLastMessages", "tags": [ "Admin: Chat" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats": { "get": { "summary": "GET /chats", "operationId": "api::chat_chat.find", "tags": [ "Admin: Chat" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "post": { "summary": "POST /chats", "operationId": "api::chat_chat.create", "tags": [ "Admin: Chat" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/active": { "get": { "summary": "GET /chats/active", "operationId": "api::chat_chat.findActive", "tags": [ "Admin: Chat" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/{id}": { "get": { "summary": "GET /chats/:id", "operationId": "api::chat_chat.findOne", "tags": [ "Admin: Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] }, "put": { "summary": "PUT /chats/:id", "operationId": "api::chat_chat.update", "tags": [ "Admin: Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] }, "delete": { "summary": "DELETE /chats/:id", "operationId": "api::chat_chat.delete", "tags": [ "Admin: Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/{id}/archive": { "post": { "summary": "POST /chats/:id/archive", "operationId": "api::chat_chat.archive", "tags": [ "Admin: Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chats/{id}/unarchive": { "post": { "summary": "POST /chats/:id/unarchive", "operationId": "api::chat_chat.unarchive", "tags": [ "Admin: Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chat-notifications/unread-count": { "get": { "summary": "GET /chat-notifications/unread-count", "operationId": "api::chat_chat-notifications.getUnreadCount", "tags": [ "Admin: Chat Notifications" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chat-notifications/read": { "post": { "summary": "POST /chat-notifications/read", "operationId": "api::chat_chat-notifications.markAsRead", "tags": [ "Admin: Chat Notifications" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chat-notifications/read-all": { "post": { "summary": "POST /chat-notifications/read-all", "operationId": "api::chat_chat-notifications.markAllAsRead", "tags": [ "Admin: Chat Notifications" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chat-notifications/read-chat/{chatId}": { "post": { "summary": "POST /chat-notifications/read-chat/:chatId", "operationId": "api::chat_chat-notifications.markChatAsRead", "tags": [ "Admin: Chat Notifications" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chat-notifications/chat-stats": { "get": { "summary": "GET /chat-notifications/chat-stats", "operationId": "api::chat_chat-notifications.getChatStats", "tags": [ "Admin: Chat Notifications" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/chat-notifications/read-state/{chatId}": { "get": { "summary": "GET /chat-notifications/read-state/:chatId", "operationId": "api::chat_chat-notifications.getChatReadState", "tags": [ "Admin: Chat Notifications" ], "parameters": [ { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/caches": { "get": { "summary": "GET /caches", "operationId": "plugin::helper_cache.list", "tags": [ "Admin: Cache" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/caches/{id}/clear": { "post": { "summary": "POST /caches/:id/clear", "operationId": "plugin::helper_cache.clear", "tags": [ "Admin: Cache" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/caches/{id}/rebuild": { "post": { "summary": "POST /caches/:id/rebuild", "operationId": "plugin::helper_cache.rebuild", "tags": [ "Admin: Cache" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/bull-board/auth": { "post": { "summary": "POST /bull-board/auth", "operationId": "plugin::helper_bull-board.authenticate", "tags": [ "Admin: Bull Board" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/queues": { "get": { "summary": "GET /queues", "operationId": "plugin::helper_bull-board.listQueues", "tags": [ "Admin: Bull Board" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/queues/{queueName}": { "get": { "summary": "GET /queues/:queueName", "operationId": "plugin::helper_bull-board.getQueueStats", "tags": [ "Admin: Bull Board" ], "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/queues/{queueName}/jobs": { "get": { "summary": "GET /queues/:queueName/jobs", "operationId": "plugin::helper_bull-board.getQueueJobs", "tags": [ "Admin: Bull Board" ], "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/queues/{queueName}/jobs/{jobId}/retry": { "post": { "summary": "POST /queues/:queueName/jobs/:jobId/retry", "operationId": "plugin::helper_bull-board.retryJob", "tags": [ "Admin: Bull Board" ], "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/queues/{queueName}/jobs/{jobId}/rerun": { "post": { "summary": "POST /queues/:queueName/jobs/:jobId/rerun", "operationId": "plugin::helper_bull-board.rerunJob", "tags": [ "Admin: Bull Board" ], "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/queues/{queueName}/jobs/{jobId}": { "delete": { "summary": "DELETE /queues/:queueName/jobs/:jobId", "operationId": "plugin::helper_bull-board.removeJob", "tags": [ "Admin: Bull Board" ], "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/queues/{queueName}/clean": { "post": { "summary": "POST /queues/:queueName/clean", "operationId": "plugin::helper_bull-board.cleanQueue", "tags": [ "Admin: Bull Board" ], "parameters": [ { "name": "queueName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-queue": { "get": { "summary": "GET /attention-queue", "operationId": "api::notification_attention-queue.getAttentionQueue", "tags": [ "Admin: Attention Queue" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/{id}/dismiss": { "post": { "summary": "POST /attention-events/:id/dismiss", "operationId": "api::attention-event_attention-event.dismiss", "tags": [ "Admin: Attention Queue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/{id}/snooze": { "post": { "summary": "POST /attention-events/:id/snooze", "operationId": "api::attention-event_attention-event.snooze", "tags": [ "Admin: Attention Queue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/{id}/undo": { "post": { "summary": "POST /attention-events/:id/undo", "operationId": "api::attention-event_attention-event.undo", "tags": [ "Admin: Attention Queue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/bulk": { "post": { "summary": "POST /attention-events/bulk", "operationId": "api::attention-event_attention-event.bulk", "tags": [ "Admin: Attention Queue" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/sections/{sectionId}/reactivate-dismissed": { "post": { "summary": "POST /attention-events/sections/:sectionId/reactivate-dismissed", "operationId": "api::attention-event_attention-event.reactivateDismissed", "tags": [ "Admin: Attention Queue" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/sections/{sectionId}/reactivate-snoozed": { "post": { "summary": "POST /attention-events/sections/:sectionId/reactivate-snoozed", "operationId": "api::attention-event_attention-event.reactivateSnoozed", "tags": [ "Admin: Attention Queue" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/queue": { "get": { "summary": "GET /attention-events/queue", "operationId": "api::attention-event_attention-event.getQueue", "tags": [ "Admin: Attention Queue" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/for-entities": { "post": { "summary": "POST /attention-events/for-entities", "operationId": "api::attention-event_attention-event.getForEntities", "tags": [ "Admin: Attention Queue" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/sections/{sectionId}/entity-ids": { "get": { "summary": "GET /attention-events/sections/:sectionId/entity-ids", "operationId": "api::attention-event_attention-event.getEntityIds", "tags": [ "Admin: Attention Queue" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/sections/{sectionId}/counts": { "get": { "summary": "GET /attention-events/sections/:sectionId/counts", "operationId": "api::attention-event_attention-event.getSectionCounts", "tags": [ "Admin: Attention Queue" ], "parameters": [ { "name": "sectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/attention-events/reconcile": { "post": { "summary": "POST /attention-events/reconcile", "operationId": "api::attention-event_attention-event.reconcile", "tags": [ "Admin: Attention Queue" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "description": "Request body (schema to be documented)" } } } }, "security": [ { "adminAuth": [] } ] } }, "/helper/applications": { "get": { "summary": "GET /applications", "operationId": "api::application_application.find", "tags": [ "Admin: Application" ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } }, "/helper/applications/{id}": { "get": { "summary": "GET /applications/:id", "operationId": "api::application_application.findOne", "tags": [ "Admin: Application" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error" } }, "security": [ { "adminAuth": [] } ] } } }, "components": { "schemas": { "widget_offer": { "type": "object", "description": "offer", "properties": { "id": { "type": "integer", "description": "Primary key" }, "config": { "type": "object", "additionalProperties": true }, "name": { "type": "string", "default": "offer" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "config" ] }, "order_line-item": { "type": "object", "description": "lineItem", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "quantity": { "type": "integer", "minimum": 1, "default": 1 }, "note": { "type": "string" }, "price": { "type": "number", "format": "float" }, "currency": { "type": "string", "enum": [ "EUR", "USD", "GBP" ] }, "currencyFactor": { "type": "number", "format": "float", "minimum": 0 }, "optionsComment": { "type": "object", "additionalProperties": true }, "optionsIds": { "type": "string" }, "optionsPrices": { "type": "object", "additionalProperties": true }, "product": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::product.product", "nullable": true }, "manufacturer": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::manufacturer.manufacturer", "nullable": true }, "refLineItemId": { "type": "string" }, "refProductId": { "type": "string" }, "refManufacturerId": { "type": "string" }, "refVariantId": { "type": "string" }, "refId": { "type": "string" }, "refRefId": { "type": "string" }, "optionsConfig": { "type": "object", "additionalProperties": true }, "type": { "type": "string", "enum": [ "product", "custom", "promotion", "coins" ], "default": "product" }, "coinsAccrualRate": { "type": "number", "format": "float" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "quantity", "price", "currency", "currencyFactor" ] }, "discord_message": { "type": "object", "description": "message", "properties": { "id": { "type": "integer", "description": "Primary key" }, "discordChannelId": { "type": "string" }, "discordMessageId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "deal_details": { "type": "object", "description": "details", "properties": { "id": { "type": "integer", "description": "Primary key" }, "description": { "type": "string" }, "date": { "type": "string" }, "note": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "description" ] }, "deal_customer": { "type": "object", "description": "customer", "properties": { "id": { "type": "integer", "description": "Primary key" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "common_note": { "type": "object", "description": "note", "properties": { "id": { "type": "integer", "description": "Primary key" }, "text": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "common_file-metadata": { "type": "object", "description": "File Metadata", "properties": { "id": { "type": "integer", "description": "Primary key" }, "fileName": { "type": "string" }, "mimeType": { "type": "string" }, "fileSize": { "type": "integer" }, "s3Key": { "type": "string" }, "uploadedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "common_contacts": { "type": "object", "description": "contacts", "properties": { "id": { "type": "integer", "description": "Primary key" }, "discord": { "type": "string" }, "skype": { "type": "string" }, "email": { "type": "string", "format": "email" }, "telegram": { "type": "string" }, "whatsapp": { "type": "string" }, "facebook": { "type": "string" }, "battletag": { "type": "string" }, "ebay": { "type": "string" }, "phone": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "common_address": { "type": "object", "description": "address", "properties": { "id": { "type": "integer", "description": "Primary key" }, "country": { "type": "string" }, "zip": { "type": "string" }, "city": { "type": "string" }, "street": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "WalletTransaction": { "type": "object", "description": "💵 Wallet transactions", "properties": { "id": { "type": "integer", "description": "Primary key" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "enum": [ "USD" ] }, "type": { "type": "string", "enum": [ "inbound", "outbound" ] }, "purpose": { "type": "string" }, "comment": { "type": "string" }, "processedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "processing", "processed", "failed" ], "default": "pending" }, "metadata": { "type": "object", "additionalProperties": true }, "failReason": { "type": "string" }, "allowOverdraft": { "type": "boolean", "default": false }, "deal": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::deal.deal" }, "wallet": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::wallet.wallet" }, "linkedTransaction": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::wallet-transaction.wallet-transaction", "nullable": true }, "uid": { "type": "string" }, "payout": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::payout.payout" }, "emittedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "purpose", "uid" ] }, "WalletTransactionListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WalletTransaction" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "WalletTransactionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WalletTransaction" } } }, "WalletTransactionRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "enum": [ "USD" ] }, "type": { "type": "string", "enum": [ "inbound", "outbound" ] }, "purpose": { "type": "string" }, "comment": { "type": "string" }, "processedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "processing", "processed", "failed" ], "default": "pending" }, "metadata": { "type": "object", "additionalProperties": true }, "failReason": { "type": "string" }, "allowOverdraft": { "type": "boolean", "default": false }, "deal": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::deal.deal" }, "wallet": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::wallet.wallet" }, "linkedTransaction": { "type": "integer", "description": "ID for api::wallet-transaction.wallet-transaction", "nullable": true }, "uid": { "type": "string" }, "payout": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::payout.payout" }, "emittedBy": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true } }, "required": [ "purpose", "uid" ] } }, "required": [ "data" ] }, "Wallet": { "type": "object", "description": "💵 Wallets", "properties": { "id": { "type": "integer", "description": "Primary key" }, "balance": { "type": "number", "format": "double" }, "type": { "type": "string", "enum": [ "main", "requested", "paid", "pending" ] }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::wallet-transaction.wallet-transaction" }, "provider": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "currency": { "type": "string", "enum": [ "USD" ], "default": "USD" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "currency" ] }, "WalletListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Wallet" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "WalletResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Wallet" } } }, "WalletRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "balance": { "type": "number", "format": "double" }, "type": { "type": "string", "enum": [ "main", "requested", "paid", "pending" ] }, "transactions": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::wallet-transaction.wallet-transaction" }, "provider": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "currency": { "type": "string", "enum": [ "USD" ], "default": "USD" } }, "required": [ "currency" ] } }, "required": [ "data" ] }, "Ticket": { "type": "object", "description": "Ticket", "properties": { "id": { "type": "integer", "description": "Primary key" }, "type": { "type": "string", "enum": [ "claim", "support" ], "default": "support" }, "category": { "type": "string", "enum": [ "general", "billing", "technical", "sales", "claim" ], "default": "general" }, "status": { "type": "string", "enum": [ "open", "in_progress", "resolved", "closed" ], "default": "open" }, "subject": { "type": "string" }, "description": { "type": "string" }, "chat": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::chat.chat", "nullable": true }, "order": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::order.order" }, "deal": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::deal.deal" }, "customer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "provider": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "assignedTo": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to admin::user", "nullable": true }, "resolvedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "status", "subject" ] }, "TicketListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "TicketResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Ticket" } } }, "TicketRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "claim", "support" ], "default": "support" }, "category": { "type": "string", "enum": [ "general", "billing", "technical", "sales", "claim" ], "default": "general" }, "status": { "type": "string", "enum": [ "open", "in_progress", "resolved", "closed" ], "default": "open" }, "subject": { "type": "string" }, "description": { "type": "string" }, "chat": { "type": "integer", "description": "ID for api::chat.chat", "nullable": true }, "order": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::order.order" }, "deal": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::deal.deal" }, "customer": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "provider": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "assignedTo": { "type": "integer", "description": "ID for admin::user", "nullable": true }, "resolvedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "status", "subject" ] } }, "required": [ "data" ] }, "Team": { "type": "object", "description": "Admin teams for grouping profiles (e.g., Support Team, Payout Team)", "properties": { "id": { "type": "integer", "description": "Primary key" }, "publicId": { "type": "string", "maxLength": 10 }, "name": { "type": "string", "maxLength": 100 }, "mentionName": { "type": "string", "maxLength": 50 }, "description": { "type": "string" }, "defaultFor": { "type": "object", "additionalProperties": true, "default": [] }, "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "isActive": { "type": "boolean", "default": true }, "permissions": { "type": "object", "additionalProperties": true, "default": {} }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name" ] }, "TeamListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "TeamResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Team" } } }, "TeamRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "publicId": { "type": "string", "maxLength": 10 }, "name": { "type": "string", "maxLength": 100 }, "mentionName": { "type": "string", "maxLength": 50 }, "description": { "type": "string" }, "defaultFor": { "type": "object", "additionalProperties": true, "default": [] }, "members": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "isActive": { "type": "boolean", "default": true }, "permissions": { "type": "object", "additionalProperties": true, "default": {} } }, "required": [ "name" ] } }, "required": [ "data" ] }, "Tag": { "type": "object", "description": "Unified tags with shared/personal visibility for orders, deals, customers, providers, and payouts", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string", "maxLength": 50 }, "color": { "type": "string", "default": "#3182CE" }, "targetType": { "type": "string", "enum": [ "order", "deal", "customer", "provider", "payout" ] }, "visibility": { "type": "string", "enum": [ "shared", "personal" ], "default": "shared" }, "owner": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to admin::user" }, "isSystem": { "type": "boolean", "default": false }, "showInTable": { "type": "boolean", "default": true }, "isAttentionTrigger": { "type": "boolean", "default": false }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::order.order" }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::deal.deal" }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "providers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "payouts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::payout.payout" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "color", "targetType", "visibility" ] }, "TagListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "TagResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Tag" } } }, "TagRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 50 }, "color": { "type": "string", "default": "#3182CE" }, "targetType": { "type": "string", "enum": [ "order", "deal", "customer", "provider", "payout" ] }, "visibility": { "type": "string", "enum": [ "shared", "personal" ], "default": "shared" }, "owner": { "type": "array", "items": { "type": "integer" }, "description": "IDs for admin::user" }, "isSystem": { "type": "boolean", "default": false }, "showInTable": { "type": "boolean", "default": true }, "isAttentionTrigger": { "type": "boolean", "default": false }, "orders": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::order.order" }, "deals": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::deal.deal" }, "customers": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "providers": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "payouts": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::payout.payout" } }, "required": [ "name", "color", "targetType", "visibility" ] } }, "required": [ "data" ] }, "Store": { "type": "object", "description": "External platform integrations (Shopware, eBay, etc.)", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "code": { "type": "string" }, "prefix": { "type": "string", "maxLength": 5 }, "enabled": { "type": "boolean", "default": true }, "integrationConfig": { "type": "object", "additionalProperties": true }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::order.order" }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "url": { "type": "string" }, "logo": { "type": "string" }, "customerAdminUrl": { "type": "string" }, "orderAdminUrl": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "code", "prefix", "enabled", "url" ] }, "StoreListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Store" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "StoreResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Store" } } }, "StoreRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "prefix": { "type": "string", "maxLength": 5 }, "enabled": { "type": "boolean", "default": true }, "integrationConfig": { "type": "object", "additionalProperties": true }, "orders": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::order.order" }, "customers": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "url": { "type": "string" }, "logo": { "type": "string" }, "customerAdminUrl": { "type": "string" }, "orderAdminUrl": { "type": "string" } }, "required": [ "name", "code", "prefix", "enabled", "url" ] } }, "required": [ "data" ] }, "ServiceType": { "type": "object", "description": "⚡️ Service types", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "providers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "slug": { "type": "string" }, "active": { "type": "boolean", "default": true }, "discordChannelId": { "type": "string" }, "discordRoleId": { "type": "string" }, "autoDealRate": { "type": "number", "format": "double" }, "optionIds": { "type": "string" }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::product.product" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "slug", "active" ] }, "ServiceTypeListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceType" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ServiceTypeResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ServiceType" } } }, "ServiceTypeRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "providers": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "slug": { "type": "string" }, "active": { "type": "boolean", "default": true }, "discordChannelId": { "type": "string" }, "discordRoleId": { "type": "string" }, "autoDealRate": { "type": "number", "format": "double" }, "optionIds": { "type": "string" }, "products": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::product.product" } }, "required": [ "slug", "active" ] } }, "required": [ "data" ] }, "Schedule": { "type": "object", "description": "📅 Schedule", "properties": { "id": { "type": "integer", "description": "Primary key" }, "config": { "type": "object", "additionalProperties": true }, "name": { "type": "string" }, "discordChannelId": { "type": "string" }, "contentPayload": { "type": "string" }, "locale": { "type": "string", "enum": [ "en-GB", "en-US" ], "default": "en-GB" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "discordChannelId", "locale" ] }, "ScheduleListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Schedule" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ScheduleResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Schedule" } } }, "ScheduleRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "config": { "type": "object", "additionalProperties": true }, "name": { "type": "string" }, "discordChannelId": { "type": "string" }, "contentPayload": { "type": "string" }, "locale": { "type": "string", "enum": [ "en-GB", "en-US" ], "default": "en-GB" } }, "required": [ "discordChannelId", "locale" ] } }, "required": [ "data" ] }, "SalesChannel": { "type": "object", "description": "📦 Stores", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "SalesChannelListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SalesChannel" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "SalesChannelResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SalesChannel" } } }, "SalesChannelRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" } } } }, "required": [ "data" ] }, "PushSubscription": { "type": "object", "description": "Web Push API subscription records for browser notifications", "properties": { "id": { "type": "integer", "description": "Primary key" }, "profile": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "endpoint": { "type": "string" }, "p256dh": { "type": "string" }, "auth": { "type": "string" }, "userAgent": { "type": "string" }, "deviceName": { "type": "string" }, "lastUsedAt": { "type": "string", "format": "date-time" }, "failureCount": { "type": "integer", "default": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "endpoint", "p256dh", "auth" ] }, "PushSubscriptionListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PushSubscription" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "PushSubscriptionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PushSubscription" } } }, "PushSubscriptionRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "profile": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "endpoint": { "type": "string" }, "p256dh": { "type": "string" }, "auth": { "type": "string" }, "userAgent": { "type": "string" }, "deviceName": { "type": "string" }, "lastUsedAt": { "type": "string", "format": "date-time" }, "failureCount": { "type": "integer", "default": 0 } }, "required": [ "endpoint", "p256dh", "auth" ] } }, "required": [ "data" ] }, "Provider": { "type": "object", "description": "⚡️ Providers", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string", "minLength": 2, "maxLength": 32 }, "note": { "type": "string" }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::deal.deal" }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::application.application" }, "serviceTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::service-type.service-type" }, "active": { "type": "boolean", "default": true }, "type": { "type": "string", "enum": [ "personal", "group" ], "default": "personal" }, "sellerType": { "type": "string", "enum": [ "solo", "community", "reseller" ], "default": "solo" }, "skill": { "type": "string", "enum": [ "beginner", "intermediate", "advanced", "expert" ], "default": "beginner" }, "isImportant": { "type": "boolean", "default": false }, "discordChannelId": { "type": "string" }, "owner": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "permissions": { "type": "object", "additionalProperties": true }, "comment": { "type": "string", "maxLength": 100 }, "payouts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::payout.payout" }, "isPublic": { "type": "boolean", "default": false }, "avatar": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } }, "nullable": true }, "javesId": { "type": "string" }, "skipCreateDealChannels": { "type": "boolean", "default": false }, "payoutNote": { "type": "string" }, "wallets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::wallet.wallet" }, "installmentChannelId": { "type": "string" }, "lastApplicationAt": { "type": "string", "format": "date-time" }, "lastDealAt": { "type": "string", "format": "date-time" }, "registrationFormData": { "type": "object", "additionalProperties": true }, "activatedAt": { "type": "string", "format": "date-time" }, "blockedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "active", "blocked", "rejected" ], "default": "pending" }, "financialStatus": { "type": "string", "enum": [ "active", "suspended" ], "default": "active" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::tag.tag" }, "chats": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::chat.chat" }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::ticket.ticket" }, "rejectedReason": { "type": "string" }, "rejectedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "active", "type" ] }, "ProviderListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Provider" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ProviderResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Provider" } } }, "ProviderRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 32 }, "note": { "type": "string" }, "deals": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::deal.deal" }, "applications": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::application.application" }, "serviceTypes": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::service-type.service-type" }, "active": { "type": "boolean", "default": true }, "type": { "type": "string", "enum": [ "personal", "group" ], "default": "personal" }, "sellerType": { "type": "string", "enum": [ "solo", "community", "reseller" ], "default": "solo" }, "skill": { "type": "string", "enum": [ "beginner", "intermediate", "advanced", "expert" ], "default": "beginner" }, "isImportant": { "type": "boolean", "default": false }, "discordChannelId": { "type": "string" }, "owner": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "members": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "permissions": { "type": "object", "additionalProperties": true }, "comment": { "type": "string", "maxLength": 100 }, "payouts": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::payout.payout" }, "isPublic": { "type": "boolean", "default": false }, "avatar": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } }, "nullable": true }, "javesId": { "type": "string" }, "skipCreateDealChannels": { "type": "boolean", "default": false }, "payoutNote": { "type": "string" }, "wallets": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::wallet.wallet" }, "installmentChannelId": { "type": "string" }, "lastApplicationAt": { "type": "string", "format": "date-time" }, "lastDealAt": { "type": "string", "format": "date-time" }, "registrationFormData": { "type": "object", "additionalProperties": true }, "activatedAt": { "type": "string", "format": "date-time" }, "blockedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "active", "blocked", "rejected" ], "default": "pending" }, "financialStatus": { "type": "string", "enum": [ "active", "suspended" ], "default": "active" }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::tag.tag" }, "chats": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::chat.chat" }, "tickets": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::ticket.ticket" }, "rejectedReason": { "type": "string" }, "rejectedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "active", "type" ] } }, "required": [ "data" ] }, "Profile": { "type": "object", "description": "⚡️ Profiles", "properties": { "id": { "type": "integer", "description": "Primary key" }, "publicId": { "type": "string", "maxLength": 10 }, "username": { "type": "string" }, "ownerOf": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "discordUserId": { "type": "string" }, "discordUsername": { "type": "string" }, "memberOf": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "intercomId": { "type": "string" }, "intercomName": { "type": "string" }, "adminUser": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to admin::user", "nullable": true }, "kycCompleted": { "type": "boolean" }, "kycCompletedAt": { "type": "string", "format": "date-time" }, "kycApplicantId": { "type": "string" }, "kycInspectionId": { "type": "string" }, "avatarMetadata": { "$ref": "#/components/schemas/common_file-metadata" }, "displayCompactMode": { "type": "boolean", "default": false }, "displayShowActivity": { "type": "boolean", "default": true }, "telegramUsername": { "type": "string" }, "telegramChatId": { "type": "string" }, "telegramVerified": { "type": "boolean", "default": false }, "notifyViaDiscord": { "type": "boolean", "default": false }, "notifyViaTelegram": { "type": "boolean", "default": false }, "teams": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::team.team" }, "chatAssignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::chat-assignment.chat-assignment" }, "notifyViaSound": { "type": "boolean", "default": true }, "notifyViaBrowserPush": { "type": "boolean", "default": false }, "notificationPreferences": { "type": "object", "additionalProperties": true }, "pushSubscriptions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::push-subscription.push-subscription" }, "attentionQueuePreferences": { "type": "object", "additionalProperties": true }, "chatNotificationPreferences": { "type": "object", "additionalProperties": true }, "dndEnabled": { "type": "boolean", "default": false }, "adminUiPreferences": { "type": "object", "additionalProperties": true }, "managedCustomers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "email": { "type": "string", "format": "email" }, "mmUserLinks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::mm-user-link.mm-user-link" }, "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "ProfileListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Profile" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ProfileResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Profile" } } }, "ProfileRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "publicId": { "type": "string", "maxLength": 10 }, "username": { "type": "string" }, "ownerOf": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "discordUserId": { "type": "string" }, "discordUsername": { "type": "string" }, "memberOf": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "intercomId": { "type": "string" }, "intercomName": { "type": "string" }, "adminUser": { "type": "integer", "description": "ID for admin::user", "nullable": true }, "kycCompleted": { "type": "boolean" }, "kycCompletedAt": { "type": "string", "format": "date-time" }, "kycApplicantId": { "type": "string" }, "kycInspectionId": { "type": "string" }, "avatarMetadata": { "$ref": "#/components/schemas/common_file-metadata" }, "displayCompactMode": { "type": "boolean", "default": false }, "displayShowActivity": { "type": "boolean", "default": true }, "telegramUsername": { "type": "string" }, "telegramChatId": { "type": "string" }, "telegramVerified": { "type": "boolean", "default": false }, "notifyViaDiscord": { "type": "boolean", "default": false }, "notifyViaTelegram": { "type": "boolean", "default": false }, "teams": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::team.team" }, "chatAssignments": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::chat-assignment.chat-assignment" }, "notifyViaSound": { "type": "boolean", "default": true }, "notifyViaBrowserPush": { "type": "boolean", "default": false }, "notificationPreferences": { "type": "object", "additionalProperties": true }, "pushSubscriptions": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::push-subscription.push-subscription" }, "attentionQueuePreferences": { "type": "object", "additionalProperties": true }, "chatNotificationPreferences": { "type": "object", "additionalProperties": true }, "dndEnabled": { "type": "boolean", "default": false }, "adminUiPreferences": { "type": "object", "additionalProperties": true }, "managedCustomers": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "email": { "type": "string", "format": "email" }, "mmUserLinks": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::mm-user-link.mm-user-link" }, "customers": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" } } } }, "required": [ "data" ] }, "Product": { "type": "object", "description": "📦 Products", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "optionsConfig": { "type": "object", "additionalProperties": true }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "minPrice": { "type": "number", "format": "double" }, "minPriceUsd": { "type": "number", "format": "double" }, "ghostPrice": { "type": "number", "format": "double" }, "ghostPriceUsd": { "type": "number", "format": "double" }, "discountPrice": { "type": "number", "format": "double" }, "pointsRate": { "type": "number", "format": "float" }, "pointsOverride": { "type": "boolean", "default": false }, "coinsAccrualRate": { "type": "number", "format": "double" }, "doubleQtyMode": { "type": "boolean", "default": false }, "ghostPriceMode": { "type": "string", "enum": [ "addition", "multiplication" ], "default": "addition" }, "ghostPriceRounding": { "type": "string", "enum": [ "X.00", "X.99", "X.95" ] }, "qtyInputHidden": { "type": "boolean", "default": false }, "autoDealName": { "type": "string" }, "autoDeal": { "type": "boolean", "default": false }, "autoDealRate": { "type": "number", "format": "double", "minimum": 0 }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::deal.deal" }, "serviceTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::service-type.service-type" }, "manufacturer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::manufacturer.manufacturer" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "pointsOverride", "doubleQtyMode", "ghostPriceMode" ] }, "ProductListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ProductResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Product" } } }, "ProductRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "optionsConfig": { "type": "object", "additionalProperties": true }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "minPrice": { "type": "number", "format": "double" }, "minPriceUsd": { "type": "number", "format": "double" }, "ghostPrice": { "type": "number", "format": "double" }, "ghostPriceUsd": { "type": "number", "format": "double" }, "discountPrice": { "type": "number", "format": "double" }, "pointsRate": { "type": "number", "format": "float" }, "pointsOverride": { "type": "boolean", "default": false }, "coinsAccrualRate": { "type": "number", "format": "double" }, "doubleQtyMode": { "type": "boolean", "default": false }, "ghostPriceMode": { "type": "string", "enum": [ "addition", "multiplication" ], "default": "addition" }, "ghostPriceRounding": { "type": "string", "enum": [ "X.00", "X.99", "X.95" ] }, "qtyInputHidden": { "type": "boolean", "default": false }, "autoDealName": { "type": "string" }, "autoDeal": { "type": "boolean", "default": false }, "autoDealRate": { "type": "number", "format": "double", "minimum": 0 }, "deals": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::deal.deal" }, "serviceTypes": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::service-type.service-type" }, "manufacturer": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::manufacturer.manufacturer" } }, "required": [ "name", "pointsOverride", "doubleQtyMode", "ghostPriceMode" ] } }, "required": [ "data" ] }, "Payout": { "type": "object", "description": "💵 Payouts", "properties": { "id": { "type": "integer", "description": "Primary key" }, "provider": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "status": { "type": "string", "enum": [ "open", "in_progress", "processed", "cancelled", "closed" ], "default": "open" }, "isInstallment": { "type": "boolean", "default": false }, "closedAt": { "type": "string", "format": "date-time" }, "discordChannelId": { "type": "string" }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } } } }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::deal.deal" }, "requestedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "processedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to admin::user", "nullable": true }, "dueDateAt": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double", "minimum": 0 }, "fee": { "type": "number", "format": "double", "minimum": 0 }, "feePercent": { "type": "number", "format": "float", "minimum": 0 }, "feeFixed": { "type": "number", "format": "float", "minimum": 0 }, "total": { "type": "number", "format": "double", "minimum": 0 }, "mode": { "type": "string", "enum": [ "free", "standard", "fast", "priority", "urgent" ], "default": "standard" }, "comment": { "type": "string" }, "note": { "type": "string" }, "processedAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": "string", "format": "date-time" }, "uid": { "type": "string" }, "walletTransactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::wallet-transaction.wallet-transaction" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::tag.tag" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "status", "amount", "fee", "feePercent", "feeFixed", "total", "mode", "uid" ] }, "PayoutListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Payout" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "PayoutResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Payout" } } }, "PayoutRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "provider": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "status": { "type": "string", "enum": [ "open", "in_progress", "processed", "cancelled", "closed" ], "default": "open" }, "isInstallment": { "type": "boolean", "default": false }, "closedAt": { "type": "string", "format": "date-time" }, "discordChannelId": { "type": "string" }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } } } }, "deals": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::deal.deal" }, "requestedBy": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "processedBy": { "type": "integer", "description": "ID for admin::user", "nullable": true }, "dueDateAt": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double", "minimum": 0 }, "fee": { "type": "number", "format": "double", "minimum": 0 }, "feePercent": { "type": "number", "format": "float", "minimum": 0 }, "feeFixed": { "type": "number", "format": "float", "minimum": 0 }, "total": { "type": "number", "format": "double", "minimum": 0 }, "mode": { "type": "string", "enum": [ "free", "standard", "fast", "priority", "urgent" ], "default": "standard" }, "comment": { "type": "string" }, "note": { "type": "string" }, "processedAt": { "type": "string", "format": "date-time" }, "cancelledAt": { "type": "string", "format": "date-time" }, "uid": { "type": "string" }, "walletTransactions": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::wallet-transaction.wallet-transaction" }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::tag.tag" } }, "required": [ "status", "amount", "fee", "feePercent", "feeFixed", "total", "mode", "uid" ] } }, "required": [ "data" ] }, "Order": { "type": "object", "description": "🔖 Orders", "properties": { "id": { "type": "integer", "description": "Primary key" }, "price": { "type": "number", "format": "double", "minimum": 0 }, "currency": { "type": "string", "enum": [ "EUR", "USD", "GBP" ] }, "currencyFactor": { "type": "number", "format": "float", "minimum": 0 }, "note": { "type": "string" }, "discount": { "type": "number", "format": "double" }, "discountDetails": { "type": "object", "additionalProperties": true }, "paymentStatus": { "type": "string", "enum": [ "reminded", "failed", "open", "paid", "authorized", "paid_partially", "in_progress", "chargeback", "refunded", "unconfirmed", "refunded_partially", "cancelled" ], "default": "open" }, "orderStatus": { "type": "string", "enum": [ "open", "pending", "cancelled", "in_progress", "completed" ], "default": "open" }, "customer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "customerNote": { "type": "string" }, "address": { "$ref": "#/components/schemas/common_address" }, "ebayOrderLink": { "type": "string" }, "discordCustomerMessageId": { "type": "string" }, "discordThreadId": { "type": "string" }, "discordMessageId": { "type": "string" }, "discordDealsMessageId": { "type": "string" }, "contacts": { "$ref": "#/components/schemas/common_contacts" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/order_line-item" } }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::deal.deal" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceRefId": { "type": "string" }, "sourceNonce": { "type": "string" }, "sourcePaymentStatus": { "type": "string", "enum": [ "reminded", "failed", "open", "paid", "authorized", "paid_partially", "in_progress", "chargeback", "refunded", "unconfirmed", "refunded_partially", "cancelled" ], "default": "open" }, "sourcePaymentMethod": { "type": "string" }, "sourcePaymentMethodTechnicalName": { "type": "string" }, "sourceOrderStatus": { "type": "string", "enum": [ "open", "cancelled", "in_progress", "completed" ], "default": "open" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } } } }, "sourceTimezone": { "type": "string" }, "emitter": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "magicLink": { "type": "string" }, "intercomTicketId": { "type": "string" }, "shippingStatus": { "type": "string", "enum": [ "awaiting", "paused", "shipping_required", "in_shipping", "shipped" ], "default": "awaiting" }, "coinsTransactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::coins-transaction.coins-transaction" }, "orderCurrencyToUSDRate": { "type": "number", "format": "float" }, "orderNumber": { "type": "integer" }, "hasReviewsioReview": { "type": "boolean", "default": false }, "hasTrustpilotReview": { "type": "boolean", "default": false }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::tag.tag" }, "chat": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::chat.chat", "nullable": true }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::ticket.ticket" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "price", "currency", "currencyFactor", "paymentStatus", "orderStatus", "lineItems", "sourceRefId", "sourcePaymentStatus", "sourceOrderStatus", "sourceCreatedAt" ] }, "OrderListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "OrderResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Order" } } }, "OrderRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "price": { "type": "number", "format": "double", "minimum": 0 }, "currency": { "type": "string", "enum": [ "EUR", "USD", "GBP" ] }, "currencyFactor": { "type": "number", "format": "float", "minimum": 0 }, "note": { "type": "string" }, "discount": { "type": "number", "format": "double" }, "discountDetails": { "type": "object", "additionalProperties": true }, "paymentStatus": { "type": "string", "enum": [ "reminded", "failed", "open", "paid", "authorized", "paid_partially", "in_progress", "chargeback", "refunded", "unconfirmed", "refunded_partially", "cancelled" ], "default": "open" }, "orderStatus": { "type": "string", "enum": [ "open", "pending", "cancelled", "in_progress", "completed" ], "default": "open" }, "customer": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "customerNote": { "type": "string" }, "address": { "$ref": "#/components/schemas/common_address" }, "ebayOrderLink": { "type": "string" }, "discordCustomerMessageId": { "type": "string" }, "discordThreadId": { "type": "string" }, "discordMessageId": { "type": "string" }, "discordDealsMessageId": { "type": "string" }, "contacts": { "$ref": "#/components/schemas/common_contacts" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/order_line-item" } }, "deals": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::deal.deal" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceRefId": { "type": "string" }, "sourceNonce": { "type": "string" }, "sourcePaymentStatus": { "type": "string", "enum": [ "reminded", "failed", "open", "paid", "authorized", "paid_partially", "in_progress", "chargeback", "refunded", "unconfirmed", "refunded_partially", "cancelled" ], "default": "open" }, "sourcePaymentMethod": { "type": "string" }, "sourcePaymentMethodTechnicalName": { "type": "string" }, "sourceOrderStatus": { "type": "string", "enum": [ "open", "cancelled", "in_progress", "completed" ], "default": "open" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } } } }, "sourceTimezone": { "type": "string" }, "emitter": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "magicLink": { "type": "string" }, "intercomTicketId": { "type": "string" }, "shippingStatus": { "type": "string", "enum": [ "awaiting", "paused", "shipping_required", "in_shipping", "shipped" ], "default": "awaiting" }, "coinsTransactions": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::coins-transaction.coins-transaction" }, "orderCurrencyToUSDRate": { "type": "number", "format": "float" }, "orderNumber": { "type": "integer" }, "hasReviewsioReview": { "type": "boolean", "default": false }, "hasTrustpilotReview": { "type": "boolean", "default": false }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::tag.tag" }, "chat": { "type": "integer", "description": "ID for api::chat.chat", "nullable": true }, "tickets": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::ticket.ticket" } }, "required": [ "price", "currency", "currencyFactor", "paymentStatus", "orderStatus", "lineItems", "sourceRefId", "sourcePaymentStatus", "sourceOrderStatus", "sourceCreatedAt" ] } }, "required": [ "data" ] }, "Offer": { "type": "object", "description": "⚡️ Offers", "properties": { "id": { "type": "integer", "description": "Primary key" }, "deal": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::deal.deal", "nullable": true }, "applications": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::application.application" }, "status": { "type": "string", "enum": [ "draft", "listed", "delisted", "in_archive" ], "default": "draft" }, "discordMessage": { "$ref": "#/components/schemas/discord_message" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "status" ] }, "OfferListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Offer" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "OfferResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Offer" } } }, "OfferRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deal": { "type": "integer", "description": "ID for api::deal.deal", "nullable": true }, "applications": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::application.application" }, "status": { "type": "string", "enum": [ "draft", "listed", "delisted", "in_archive" ], "default": "draft" }, "discordMessage": { "$ref": "#/components/schemas/discord_message" } }, "required": [ "status" ] } }, "required": [ "data" ] }, "NotificationDeliveryLog": { "type": "object", "description": "Tracks delivery status of notifications across channels", "properties": { "id": { "type": "integer", "description": "Primary key" }, "notification": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::notification.notification" }, "profile": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "channel": { "type": "string", "enum": [ "sound", "browserPush", "discord", "telegram" ] }, "status": { "type": "string", "enum": [ "pending", "sent", "delivered", "failed", "skipped" ], "default": "pending" }, "attemptCount": { "type": "integer", "default": 0 }, "lastAttemptAt": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string" }, "externalId": { "type": "string" }, "source": { "type": "string", "enum": [ "event", "attention" ], "default": "event" }, "meta": { "type": "object", "additionalProperties": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "channel" ] }, "NotificationDeliveryLogListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDeliveryLog" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "NotificationDeliveryLogResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationDeliveryLog" } } }, "NotificationDeliveryLogRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "notification": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::notification.notification" }, "profile": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "channel": { "type": "string", "enum": [ "sound", "browserPush", "discord", "telegram" ] }, "status": { "type": "string", "enum": [ "pending", "sent", "delivered", "failed", "skipped" ], "default": "pending" }, "attemptCount": { "type": "integer", "default": 0 }, "lastAttemptAt": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string" }, "externalId": { "type": "string" }, "source": { "type": "string", "enum": [ "event", "attention" ], "default": "event" }, "meta": { "type": "object", "additionalProperties": true } }, "required": [ "channel" ] } }, "required": [ "data" ] }, "Notification": { "type": "object", "description": "In-app notifications for admin users", "properties": { "id": { "type": "integer", "description": "Primary key" }, "type": { "type": "string", "enum": [ "deal_created", "deal_status_changed", "deal_status_changed:draft", "deal_status_changed:open", "deal_status_changed:assigned", "deal_status_changed:cancelled", "deal_status_changed:on_approval", "deal_status_changed:returned", "deal_status_changed:completed", "deal_status_changed:failed", "deal_deadline", "deal_reminder", "order_created", "order_status_changed", "order_status_changed:open", "order_status_changed:pending", "order_status_changed:cancelled", "order_status_changed:in_progress", "order_status_changed:completed", "order_payment_changed", "order_shipping_changed", "payout_created", "payout_status_changed", "customer_kyc_completed", "customer_kyc_status_changed", "customer_kyc_requested", "profile_kyc_status_changed", "profile_kyc_requested", "customer_coins_adjusted", "customer_manager_assigned", "customer_manager_reassigned", "system_announcement" ] }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "default": "medium" }, "title": { "type": "string" }, "message": { "type": "string" }, "entityUid": { "type": "string" }, "entityId": { "type": "integer" }, "targetProfile": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "aggregationKey": { "type": "string" }, "aggregationCount": { "type": "integer", "default": 1 }, "readAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "meta": { "type": "object", "additionalProperties": true }, "recipientType": { "type": "string", "enum": [ "admin", "customer", "provider" ], "default": "admin" }, "recipientCustomer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "recipientProvider": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "title", "targetProfile" ] }, "NotificationListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "NotificationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Notification" } } }, "NotificationRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "deal_created", "deal_status_changed", "deal_status_changed:draft", "deal_status_changed:open", "deal_status_changed:assigned", "deal_status_changed:cancelled", "deal_status_changed:on_approval", "deal_status_changed:returned", "deal_status_changed:completed", "deal_status_changed:failed", "deal_deadline", "deal_reminder", "order_created", "order_status_changed", "order_status_changed:open", "order_status_changed:pending", "order_status_changed:cancelled", "order_status_changed:in_progress", "order_status_changed:completed", "order_payment_changed", "order_shipping_changed", "payout_created", "payout_status_changed", "customer_kyc_completed", "customer_kyc_status_changed", "customer_kyc_requested", "profile_kyc_status_changed", "profile_kyc_requested", "customer_coins_adjusted", "customer_manager_assigned", "customer_manager_reassigned", "system_announcement" ] }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ], "default": "medium" }, "title": { "type": "string" }, "message": { "type": "string" }, "entityUid": { "type": "string" }, "entityId": { "type": "integer" }, "targetProfile": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "aggregationKey": { "type": "string" }, "aggregationCount": { "type": "integer", "default": 1 }, "readAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "meta": { "type": "object", "additionalProperties": true }, "recipientType": { "type": "string", "enum": [ "admin", "customer", "provider" ], "default": "admin" }, "recipientCustomer": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "recipientProvider": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" } }, "required": [ "type", "title", "targetProfile" ] } }, "required": [ "data" ] }, "MmUserLink": { "type": "object", "description": "Links Mattermost users to platform profiles (one-to-many)", "properties": { "id": { "type": "integer", "description": "Primary key" }, "mattermostUserId": { "type": "string" }, "mattermostUserToken": { "type": "string" }, "primary": { "type": "boolean", "default": false }, "scope": { "type": "string", "enum": [ "admin", "customer", "provider" ] }, "profile": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "mattermostUserId", "scope" ] }, "MmUserLinkListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MmUserLink" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "MmUserLinkResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MmUserLink" } } }, "MmUserLinkRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mattermostUserId": { "type": "string" }, "mattermostUserToken": { "type": "string" }, "primary": { "type": "boolean", "default": false }, "scope": { "type": "string", "enum": [ "admin", "customer", "provider" ] }, "profile": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" } }, "required": [ "mattermostUserId", "scope" ] } }, "required": [ "data" ] }, "Manufacturer": { "type": "object", "description": "📦 Manufacturers", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "notionId": { "type": "string" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::product.product" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "ManufacturerListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Manufacturer" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ManufacturerResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Manufacturer" } } }, "ManufacturerRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "notionId": { "type": "string" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "products": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::product.product" } } } }, "required": [ "data" ] }, "Log": { "type": "object", "description": "⚙️ Log", "properties": { "id": { "type": "integer", "description": "Primary key" }, "entityUid": { "type": "string" }, "action": { "type": "string", "enum": [ "update", "create", "delete" ] }, "diff": { "type": "object", "additionalProperties": true }, "emittedByProfile": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "entityId": { "type": "integer" }, "emittedByAdmin": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to admin::user", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "entityUid", "action", "entityId" ] }, "LogListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Log" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "LogResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Log" } } }, "LogRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "entityUid": { "type": "string" }, "action": { "type": "string", "enum": [ "update", "create", "delete" ] }, "diff": { "type": "object", "additionalProperties": true }, "emittedByProfile": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "entityId": { "type": "integer" }, "emittedByAdmin": { "type": "integer", "description": "ID for admin::user", "nullable": true } }, "required": [ "entityUid", "action", "entityId" ] } }, "required": [ "data" ] }, "EventLog": { "type": "object", "description": "Domain event logging for audit trails, analysis, and visualization", "properties": { "id": { "type": "integer", "description": "Primary key" }, "domain": { "type": "string", "enum": [ "deal", "order", "payout", "customer", "provider", "profile", "store", "system" ] }, "eventType": { "type": "string" }, "entityUid": { "type": "string" }, "entityId": { "type": "integer" }, "description": { "type": "string" }, "payload": { "type": "object", "additionalProperties": true }, "context": { "type": "object", "additionalProperties": true }, "emittedByAdmin": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to admin::user", "nullable": true }, "emittedByProfile": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "performedBy": { "type": "string" }, "relatedNotification": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::notification.notification", "nullable": true }, "hasNotification": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "domain", "eventType", "entityUid", "entityId", "description" ] }, "EventLogListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EventLog" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "EventLogResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EventLog" } } }, "EventLogRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "type": "string", "enum": [ "deal", "order", "payout", "customer", "provider", "profile", "store", "system" ] }, "eventType": { "type": "string" }, "entityUid": { "type": "string" }, "entityId": { "type": "integer" }, "description": { "type": "string" }, "payload": { "type": "object", "additionalProperties": true }, "context": { "type": "object", "additionalProperties": true }, "emittedByAdmin": { "type": "integer", "description": "ID for admin::user", "nullable": true }, "emittedByProfile": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "performedBy": { "type": "string" }, "relatedNotification": { "type": "integer", "description": "ID for api::notification.notification", "nullable": true }, "hasNotification": { "type": "boolean" } }, "required": [ "domain", "eventType", "entityUid", "entityId", "description" ] } }, "required": [ "data" ] }, "Deal": { "type": "object", "description": "⚡️ Deals", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "note": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "open", "assigned", "cancelled", "on_approval", "returned", "completed", "failed" ], "default": "draft" }, "price": { "type": "number", "format": "double", "minimum": 0 }, "openedAt": { "type": "string", "format": "date-time" }, "assignedAt": { "type": "string", "format": "date-time" }, "closedAt": { "type": "string", "format": "date-time" }, "provider": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "order": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::order.order" }, "emittedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } } } }, "serviceType": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::service-type.service-type", "nullable": true }, "offer": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::offer.offer", "nullable": true }, "discordOnApprovalMessages": { "type": "array", "items": { "$ref": "#/components/schemas/discord_message" } }, "discordMessage": { "$ref": "#/components/schemas/discord_message" }, "details": { "$ref": "#/components/schemas/deal_details" }, "statusComment": { "type": "string" }, "customer": { "$ref": "#/components/schemas/deal_customer" }, "discordOnAssignMessages": { "type": "array", "items": { "$ref": "#/components/schemas/discord_message" } }, "payout": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::payout.payout" }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::product.product" }, "application": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::application.application", "nullable": true }, "remindAt": { "type": "string", "format": "date-time" }, "isRemindProcessed": { "type": "boolean", "default": false }, "deadlineAt": { "type": "string", "format": "date-time" }, "isDeadlineProcessed": { "type": "boolean", "default": false }, "fastPayout": { "type": "boolean", "default": false }, "fastPayoutEmittedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "walletTransactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::wallet-transaction.wallet-transaction" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::tag.tag" }, "chat": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::chat.chat", "nullable": true }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::ticket.ticket" }, "sessionState": { "type": "string", "enum": [ "available", "in_session", "paused" ], "default": "available" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "status", "details" ] }, "DealListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "DealResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deal" } } }, "DealRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "note": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "open", "assigned", "cancelled", "on_approval", "returned", "completed", "failed" ], "default": "draft" }, "price": { "type": "number", "format": "double", "minimum": 0 }, "openedAt": { "type": "string", "format": "date-time" }, "assignedAt": { "type": "string", "format": "date-time" }, "closedAt": { "type": "string", "format": "date-time" }, "provider": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "order": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::order.order" }, "emittedBy": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "mime": { "type": "string" }, "size": { "type": "number" } } } }, "serviceType": { "type": "integer", "description": "ID for api::service-type.service-type", "nullable": true }, "offer": { "type": "integer", "description": "ID for api::offer.offer", "nullable": true }, "discordOnApprovalMessages": { "type": "array", "items": { "$ref": "#/components/schemas/discord_message" } }, "discordMessage": { "$ref": "#/components/schemas/discord_message" }, "details": { "$ref": "#/components/schemas/deal_details" }, "statusComment": { "type": "string" }, "customer": { "$ref": "#/components/schemas/deal_customer" }, "discordOnAssignMessages": { "type": "array", "items": { "$ref": "#/components/schemas/discord_message" } }, "payout": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::payout.payout" }, "products": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::product.product" }, "application": { "type": "integer", "description": "ID for api::application.application", "nullable": true }, "remindAt": { "type": "string", "format": "date-time" }, "isRemindProcessed": { "type": "boolean", "default": false }, "deadlineAt": { "type": "string", "format": "date-time" }, "isDeadlineProcessed": { "type": "boolean", "default": false }, "fastPayout": { "type": "boolean", "default": false }, "fastPayoutEmittedBy": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "walletTransactions": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::wallet-transaction.wallet-transaction" }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::tag.tag" }, "chat": { "type": "integer", "description": "ID for api::chat.chat", "nullable": true }, "tickets": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::ticket.ticket" }, "sessionState": { "type": "string", "enum": [ "available", "in_session", "paused" ], "default": "available" } }, "required": [ "name", "status", "details" ] } }, "required": [ "data" ] }, "Customer": { "type": "object", "description": "🔖 Customers", "properties": { "id": { "type": "integer", "description": "Primary key" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::order.order" }, "contacts": { "$ref": "#/components/schemas/common_contacts" }, "note": { "type": "string" }, "salesNote": { "type": "string" }, "address": { "$ref": "#/components/schemas/common_address" }, "discordUserId": { "type": "string" }, "discordThreadId": { "type": "string" }, "discordMessageId": { "type": "string" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceRefId": { "type": "string" }, "sourceNonce": { "type": "string" }, "sourceTurnover": { "type": "number", "format": "double", "minimum": 0, "default": 0 }, "sourceNumberOfOrders": { "type": "integer", "minimum": 0, "default": 0 }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "manufacturers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::manufacturer.manufacturer" }, "kycCompleted": { "type": "boolean" }, "kycCompletedAt": { "type": "string", "format": "date-time" }, "kycApplicantId": { "type": "string" }, "kycInspectionId": { "type": "string" }, "discordUsername": { "type": "string" }, "coins": { "type": "string", "default": 0 }, "coinsTransactions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::coins-transaction.coins-transaction" }, "numberOfOrders": { "type": "integer", "minimum": 0, "default": 0 }, "turnover": { "type": "number", "format": "double", "minimum": 0, "default": 0 }, "gclids": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::gclid.gclid" }, "manager": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to admin::user", "nullable": true }, "managerProfile": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::tag.tag" }, "chats": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::chat.chat" }, "tickets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::ticket.ticket" }, "profile": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "firstName", "sourceRefId", "sourceNumberOfOrders" ] }, "CustomerListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Customer" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "CustomerResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Customer" } } }, "CustomerRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "email": { "type": "string", "format": "email" }, "orders": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::order.order" }, "contacts": { "$ref": "#/components/schemas/common_contacts" }, "note": { "type": "string" }, "salesNote": { "type": "string" }, "address": { "$ref": "#/components/schemas/common_address" }, "discordUserId": { "type": "string" }, "discordThreadId": { "type": "string" }, "discordMessageId": { "type": "string" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceRefId": { "type": "string" }, "sourceNonce": { "type": "string" }, "sourceTurnover": { "type": "number", "format": "double", "minimum": 0, "default": 0 }, "sourceNumberOfOrders": { "type": "integer", "minimum": 0, "default": 0 }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "manufacturers": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::manufacturer.manufacturer" }, "kycCompleted": { "type": "boolean" }, "kycCompletedAt": { "type": "string", "format": "date-time" }, "kycApplicantId": { "type": "string" }, "kycInspectionId": { "type": "string" }, "discordUsername": { "type": "string" }, "coins": { "type": "string", "default": 0 }, "coinsTransactions": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::coins-transaction.coins-transaction" }, "numberOfOrders": { "type": "integer", "minimum": 0, "default": 0 }, "turnover": { "type": "number", "format": "double", "minimum": 0, "default": 0 }, "gclids": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::gclid.gclid" }, "manager": { "type": "integer", "description": "ID for admin::user", "nullable": true }, "managerProfile": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::tag.tag" }, "chats": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::chat.chat" }, "tickets": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::ticket.ticket" }, "profile": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" } }, "required": [ "firstName", "sourceRefId", "sourceNumberOfOrders" ] } }, "required": [ "data" ] }, "ConfigSchedule": { "type": "object", "description": "📦 Schedule", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "optionsConfigSchedule": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "active": { "type": "boolean", "default": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "active", "slug" ] }, "ConfigScheduleListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigSchedule" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ConfigScheduleResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigSchedule" } } }, "ConfigScheduleRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "optionsConfigSchedule": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "active": { "type": "boolean", "default": true }, "slug": { "type": "string" } }, "required": [ "name", "active", "slug" ] } }, "required": [ "data" ] }, "ConfigMixin": { "type": "object", "description": "📦 Mixins", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "optionsConfigMixin": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "active": { "type": "boolean", "default": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "active", "slug" ] }, "ConfigMixinListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigMixin" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ConfigMixinResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigMixin" } } }, "ConfigMixinRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "optionsConfigMixin": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "active": { "type": "boolean", "default": true }, "slug": { "type": "string" } }, "required": [ "name", "active", "slug" ] } }, "required": [ "data" ] }, "ConfigExtension": { "type": "object", "description": "📦 Extensions", "properties": { "id": { "type": "integer", "description": "Primary key" }, "name": { "type": "string" }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "active": { "type": "boolean", "default": true }, "slug": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "active", "slug" ] }, "ConfigExtensionListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigExtension" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ConfigExtensionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigExtension" } } }, "ConfigExtensionRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "optionsConfigExtension": { "type": "object", "additionalProperties": true }, "sourceRefId": { "type": "string" }, "store": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::store.store" }, "sourceCreatedAt": { "type": "string", "format": "date-time" }, "sourceDeletedAt": { "type": "string", "format": "date-time" }, "active": { "type": "boolean", "default": true }, "slug": { "type": "string" } }, "required": [ "name", "active", "slug" ] } }, "required": [ "data" ] }, "CoinsTransaction": { "type": "object", "description": "🔖 Coins transaction", "properties": { "id": { "type": "integer", "description": "Primary key" }, "amount": { "type": "string" }, "type": { "type": "string", "enum": [ "accrual", "write-off", "refund", "suspension", "adjustment" ] }, "customer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "order": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::order.order" }, "fingerprint": { "type": "string" }, "comment": { "type": "string" }, "processedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "processing", "processed", "error" ], "default": "pending" }, "metadata": { "type": "object", "additionalProperties": true }, "emittedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "fingerprint" ] }, "CoinsTransactionListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CoinsTransaction" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "CoinsTransactionResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CoinsTransaction" } } }, "CoinsTransactionRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "amount": { "type": "string" }, "type": { "type": "string", "enum": [ "accrual", "write-off", "refund", "suspension", "adjustment" ] }, "customer": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "order": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::order.order" }, "fingerprint": { "type": "string" }, "comment": { "type": "string" }, "processedAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "pending", "processing", "processed", "error" ], "default": "pending" }, "metadata": { "type": "object", "additionalProperties": true }, "emittedBy": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true } }, "required": [ "fingerprint" ] } }, "required": [ "data" ] }, "ChatAssignment": { "type": "object", "description": "Links chats to profiles or teams for notification subscriptions", "properties": { "id": { "type": "integer", "description": "Primary key" }, "chat": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::chat.chat" }, "profile": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::profile.profile" }, "team": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::team.team" }, "assignedAt": { "type": "string", "format": "date-time" }, "assignedBy": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to admin::user" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "assignedAt" ] }, "ChatAssignmentListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ChatAssignment" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ChatAssignmentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ChatAssignment" } } }, "ChatAssignmentRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "chat": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::chat.chat" }, "profile": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::profile.profile" }, "team": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::team.team" }, "assignedAt": { "type": "string", "format": "date-time" }, "assignedBy": { "type": "array", "items": { "type": "integer" }, "description": "IDs for admin::user" } }, "required": [ "assignedAt" ] } }, "required": [ "data" ] }, "Chat": { "type": "object", "description": "Chat", "properties": { "id": { "type": "integer", "description": "Primary key" }, "chatProvider": { "type": "string", "enum": [ "mattermost" ], "default": "mattermost" }, "channelId": { "type": "string" }, "channelUrl": { "type": "string" }, "isArchived": { "type": "boolean", "default": false }, "lastMessageAt": { "type": "string", "format": "date-time" }, "order": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::order.order", "nullable": true }, "deal": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::deal.deal", "nullable": true }, "ticket": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::ticket.ticket", "nullable": true }, "provider": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "customer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::customer.customer" }, "createdByAdmin": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to admin::user", "nullable": true }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::chat-assignment.chat-assignment" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "chatProvider", "channelId" ] }, "ChatListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Chat" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ChatResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Chat" } } }, "ChatRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "chatProvider": { "type": "string", "enum": [ "mattermost" ], "default": "mattermost" }, "channelId": { "type": "string" }, "channelUrl": { "type": "string" }, "isArchived": { "type": "boolean", "default": false }, "lastMessageAt": { "type": "string", "format": "date-time" }, "order": { "type": "integer", "description": "ID for api::order.order", "nullable": true }, "deal": { "type": "integer", "description": "ID for api::deal.deal", "nullable": true }, "ticket": { "type": "integer", "description": "ID for api::ticket.ticket", "nullable": true }, "provider": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "customer": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::customer.customer" }, "createdByAdmin": { "type": "integer", "description": "ID for admin::user", "nullable": true }, "assignments": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::chat-assignment.chat-assignment" } }, "required": [ "chatProvider", "channelId" ] } }, "required": [ "data" ] }, "AttentionEventLog": { "type": "object", "description": "Audit trail for attention event state changes", "properties": { "id": { "type": "integer", "description": "Primary key" }, "event": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::attention-event.attention-event" }, "action": { "type": "string", "enum": [ "created", "dismissed", "snoozed", "re_raised", "auto_resolved" ] }, "actorId": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "actorType": { "type": "string", "enum": [ "user", "system", "worker", "reconcile" ] }, "metadata": { "type": "object", "additionalProperties": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "action", "actorType" ] }, "AttentionEventLogListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AttentionEventLog" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "AttentionEventLogResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AttentionEventLog" } } }, "AttentionEventLogRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "event": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::attention-event.attention-event" }, "action": { "type": "string", "enum": [ "created", "dismissed", "snoozed", "re_raised", "auto_resolved" ] }, "actorId": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "actorType": { "type": "string", "enum": [ "user", "system", "worker", "reconcile" ] }, "metadata": { "type": "object", "additionalProperties": true } }, "required": [ "action", "actorType" ] } }, "required": [ "data" ] }, "AttentionEvent": { "type": "object", "description": "Persistent attention queue events with dismiss/snooze support", "properties": { "id": { "type": "integer", "description": "Primary key" }, "entityType": { "type": "string", "enum": [ "deal", "order" ] }, "entityId": { "type": "integer" }, "section": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "dismissed", "snoozed", "resolved" ], "default": "active" }, "resolvedCount": { "type": "integer", "default": 0 }, "dismissedCycle": { "type": "integer" }, "dismissedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "dismissedAt": { "type": "string", "format": "date-time" }, "snoozeUntil": { "type": "string", "format": "date-time" }, "snoozedBy": { "type": "object", "properties": { "id": { "type": "integer" } }, "description": "Relation to api::profile.profile", "nullable": true }, "comment": { "type": "string" }, "resolvedAt": { "type": "string", "format": "date-time" }, "resolvedReason": { "type": "string", "enum": [ "entity_state_ok", "entity_deleted", "reconcile", "field_already_cleared" ] }, "metadata": { "type": "object", "additionalProperties": true }, "logs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::attention-event-log.attention-event-log" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "entityType", "entityId", "section", "status", "resolvedCount" ] }, "AttentionEventListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AttentionEvent" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "AttentionEventResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AttentionEvent" } } }, "AttentionEventRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "entityType": { "type": "string", "enum": [ "deal", "order" ] }, "entityId": { "type": "integer" }, "section": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "dismissed", "snoozed", "resolved" ], "default": "active" }, "resolvedCount": { "type": "integer", "default": 0 }, "dismissedCycle": { "type": "integer" }, "dismissedBy": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "dismissedAt": { "type": "string", "format": "date-time" }, "snoozeUntil": { "type": "string", "format": "date-time" }, "snoozedBy": { "type": "integer", "description": "ID for api::profile.profile", "nullable": true }, "comment": { "type": "string" }, "resolvedAt": { "type": "string", "format": "date-time" }, "resolvedReason": { "type": "string", "enum": [ "entity_state_ok", "entity_deleted", "reconcile", "field_already_cleared" ] }, "metadata": { "type": "object", "additionalProperties": true }, "logs": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::attention-event-log.attention-event-log" } }, "required": [ "entityType", "entityId", "section", "status", "resolvedCount" ] } }, "required": [ "data" ] }, "Application": { "type": "object", "description": "⚡️ Applications", "properties": { "id": { "type": "integer", "description": "Primary key" }, "provider": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::provider.provider" }, "offer": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" } } }, "description": "Relation to api::offer.offer" }, "active": { "type": "boolean", "default": true }, "comment": { "type": "string", "maxLength": 256 }, "price": { "type": "number", "format": "double", "minimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "active" ] }, "ApplicationListResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Application" } }, "meta": { "type": "object", "properties": { "pagination": { "type": "object", "properties": { "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "pageCount": { "type": "integer" }, "total": { "type": "integer" } } } } } } }, "ApplicationResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Application" } } }, "ApplicationRequest": { "type": "object", "properties": { "data": { "type": "object", "properties": { "provider": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::provider.provider" }, "offer": { "type": "array", "items": { "type": "integer" }, "description": "IDs for api::offer.offer" }, "active": { "type": "boolean", "default": true }, "comment": { "type": "string", "maxLength": 256 }, "price": { "type": "number", "format": "double", "minimum": 0 } }, "required": [ "active" ] } }, "required": [ "data" ] }, "GlobalSettings": { "type": "object", "description": "Global platform configuration settings", "properties": { "id": { "type": "integer", "description": "Settings ID" }, "autoDealRate": { "type": "number", "format": "double", "nullable": true, "description": "Auto-deal assignment rate" }, "payoutBasicFee": { "type": "integer", "description": "Standard payout fee percentage", "default": 2 }, "payoutBasicFixedFee": { "type": "number", "format": "double", "description": "Standard payout fixed fee amount", "default": 1, "minimum": 0 }, "payoutPriorityFee": { "type": "integer", "description": "Priority payout fee percentage", "default": 5 }, "payoutPriorityFixedFee": { "type": "number", "format": "double", "description": "Priority payout fixed fee amount", "default": 1, "minimum": 0 }, "payoutFastFee": { "type": "integer", "description": "Fast payout fee percentage", "default": 10 }, "payoutFastFixedFee": { "type": "number", "format": "double", "description": "Fast payout fixed fee amount", "default": 1, "minimum": 0 }, "payoutUrgentFee": { "type": "integer", "description": "Urgent payout fee percentage", "default": 15 }, "payoutUrgentFixedFee": { "type": "number", "format": "double", "description": "Urgent payout fixed fee amount", "default": 1, "minimum": 0 }, "payoutFixedFee": { "type": "number", "format": "double", "description": "Legacy global fixed fee (deprecated, use per-type fixed fees)", "default": 1, "deprecated": true }, "payoutMinAmount": { "type": "number", "format": "double", "description": "Minimum payout amount", "default": 20 }, "coinsWriteOffRate": { "type": "integer", "nullable": true, "description": "Coins write-off rate" }, "coinsAccrualRate": { "type": "integer", "nullable": true, "description": "Coins accrual rate" }, "coinsFirstOrderAccrualRate": { "type": "integer", "nullable": true, "description": "Coins accrual rate for first order" }, "coinsNewCustomerBalance": { "type": "integer", "nullable": true, "description": "Initial coins balance for new customers" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "GlobalSettingsRequest": { "type": "object", "description": "Request body for updating global settings", "properties": { "data": { "type": "object", "properties": { "autoDealRate": { "type": "number", "format": "double", "nullable": true }, "payoutBasicFee": { "type": "integer" }, "payoutBasicFixedFee": { "type": "number", "format": "double", "minimum": 0 }, "payoutPriorityFee": { "type": "integer" }, "payoutPriorityFixedFee": { "type": "number", "format": "double", "minimum": 0 }, "payoutFastFee": { "type": "integer" }, "payoutFastFixedFee": { "type": "number", "format": "double", "minimum": 0 }, "payoutUrgentFee": { "type": "integer" }, "payoutUrgentFixedFee": { "type": "number", "format": "double", "minimum": 0 }, "payoutFixedFee": { "type": "number", "format": "double", "deprecated": true }, "payoutMinAmount": { "type": "number", "format": "double" }, "coinsWriteOffRate": { "type": "integer", "nullable": true }, "coinsAccrualRate": { "type": "integer", "nullable": true }, "coinsFirstOrderAccrualRate": { "type": "integer", "nullable": true }, "coinsNewCustomerBalance": { "type": "integer", "nullable": true } } } } }, "WebhookPayload": { "type": "object", "description": "Standard webhook payload envelope. All webhook deliveries use this structure.", "required": [ "id", "type", "timestamp", "subscription", "event", "data", "_meta" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique webhook delivery ID" }, "type": { "type": "string", "description": "Event type in dot notation (domain.eventType)", "example": "deal.status_changed" }, "timestamp": { "type": "string", "format": "date-time", "description": "ISO 8601 timestamp when event occurred" }, "subscription": { "$ref": "#/components/schemas/WebhookSubscriptionRef" }, "event": { "$ref": "#/components/schemas/WebhookEventMeta" }, "changes": { "type": "object", "nullable": true, "description": "Structured field changes as { fieldName: { old, new } }. Null if no oldValues/newValues in event.", "additionalProperties": { "type": "object", "properties": { "old": {}, "new": {} } } }, "entity": { "type": "object", "nullable": true, "description": "Sanitized entity snapshot. Null if entity type has no webhook schema, payload exceeds 50KB, or relation count exceeds threshold." }, "entityUrl": { "type": "string", "description": "Full URL to fetch entity via API", "example": "https://stgadm.mmonster.co/api/deals/123" }, "data": { "type": "object", "description": "Event-specific payload data. Schema varies per event type.", "additionalProperties": true }, "_meta": { "$ref": "#/components/schemas/WebhookPayloadMeta" } } }, "WebhookSubscriptionRef": { "type": "object", "description": "Reference to the webhook subscription that triggered this delivery", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "description": "Subscription ID" }, "name": { "type": "string", "description": "Subscription name" } } }, "WebhookEventMeta": { "type": "object", "description": "Metadata about the source event from the event log", "required": [ "id", "domain", "eventType", "entityUid", "entityId", "description" ], "properties": { "id": { "type": "integer", "description": "Event log entry ID" }, "domain": { "type": "string", "description": "Event domain", "enum": [ "deal", "order", "payout", "customer", "provider", "product", "profile", "system" ] }, "eventType": { "type": "string", "description": "Event type within domain", "example": "status_changed" }, "entityUid": { "type": "string", "description": "Strapi content-type UID", "example": "api::deal.deal" }, "entityId": { "type": "integer", "description": "Entity record ID" }, "description": { "type": "string", "description": "Human-readable event description" } } }, "WebhookPayloadMeta": { "type": "object", "description": "Metadata about entity inclusion in the payload", "required": [ "entityIncluded", "entityTruncated" ], "properties": { "entityIncluded": { "type": "boolean", "description": "Whether entity snapshot is present" }, "entityTruncated": { "type": "boolean", "description": "Whether entity was truncated (size limit or relation threshold)" }, "truncationReason": { "type": "string", "nullable": true, "description": "Reason entity was not included (e.g., 'Entity has too many related items', 'No webhook schema')" } } }, "WebhookHeaders": { "type": "object", "description": "HTTP headers included with every webhook delivery", "properties": { "X-Webhook-ID": { "type": "string", "description": "Unique delivery ID (same as payload.id)" }, "X-Webhook-Timestamp": { "type": "string", "description": "Unix timestamp (seconds) for replay protection" }, "X-Webhook-Signature": { "type": "string", "description": "HMAC-SHA256 signature: sha256={hex}", "example": "sha256=a1b2c3d4..." }, "Content-Type": { "type": "string", "example": "application/json" } } }, "WebhookSignatureVerification": { "type": "object", "description": "How to verify webhook signatures. Concatenate timestamp + '.' + raw body, compute HMAC-SHA256 with shared secret, compare with X-Webhook-Signature header. Reject if timestamp is more than 5 minutes old.", "properties": { "algorithm": { "type": "string", "example": "HMAC-SHA256" }, "signedContent": { "type": "string", "description": "Content that is signed", "example": "timestamp.rawBody" }, "verification": { "type": "string", "description": "Verification pseudocode", "example": "hmac = crypto.createHmac('sha256', secret).update(timestamp + '.' + rawBody).digest('hex'); assert(hmac === signatureFromHeader)" }, "replayProtection": { "type": "string", "description": "Reject if X-Webhook-Timestamp is more than 5 minutes old" } } }, "WebhookGenericChangeData": { "type": "object", "description": "Generic change data with old/new values. Used by events that follow the standard change tracking pattern.", "properties": { "oldValues": { "type": "object", "description": "Previous field values", "additionalProperties": true }, "newValues": { "type": "object", "description": "New field values", "additionalProperties": true } } }, "WebhookOrderChangeData": { "type": "object", "description": "Order change data with old/new values plus order identifiers", "properties": { "oldValues": { "type": "object", "description": "Previous field values", "additionalProperties": true }, "newValues": { "type": "object", "description": "New field values", "additionalProperties": true }, "sourceNonce": { "type": "string", "description": "External order nonce" }, "orderNumber": { "type": "string", "description": "Order number (e.g., SW-12345)" } } }, "WebhookDealCreatedData": { "type": "object", "description": "Data payload for deal.created events", "properties": { "name": { "type": "string", "description": "Deal name" }, "status": { "type": "string", "description": "Initial deal status" }, "price": { "type": "number", "nullable": true, "description": "Deal price" } } }, "WebhookDealStatusChangedData": { "type": "object", "description": "Data payload for deal.status_changed events", "properties": { "oldStatus": { "type": "string", "description": "Previous status" }, "newStatus": { "type": "string", "description": "New status", "enum": [ "open", "assigned", "on_approval", "completed", "failed", "cancelled", "returned" ] }, "statusComment": { "type": "string", "nullable": true, "description": "Comment for status change (cancelled/failed/returned)" }, "fastPayout": { "type": "boolean", "description": "Whether fast payout was requested (on_approval)" }, "dealName": { "type": "string", "description": "Deal name" }, "oldValues": { "type": "object", "description": "Previous field values", "additionalProperties": true }, "newValues": { "type": "object", "description": "New field values", "additionalProperties": true } } }, "WebhookDealProviderAssignedData": { "type": "object", "description": "Data payload for deal.provider_assigned and deal.provider_reassigned events", "properties": { "oldStatus": { "type": "string", "description": "Previous status" }, "newStatus": { "type": "string", "description": "New status (assigned)", "example": "assigned" }, "providerId": { "type": "integer", "description": "Assigned provider ID" }, "providerName": { "type": "string", "description": "Assigned provider name" }, "price": { "type": "number", "description": "Deal price" }, "dealName": { "type": "string", "description": "Deal name" } } }, "WebhookDealCompletedData": { "type": "object", "description": "Data payload for deal.completed events", "properties": { "oldStatus": { "type": "string", "description": "Previous status" }, "newStatus": { "type": "string", "description": "New status (completed)", "example": "completed" }, "price": { "type": "number", "description": "Deal price" }, "providerId": { "type": "integer", "description": "Provider ID" }, "providerName": { "type": "string", "description": "Provider name" }, "dealName": { "type": "string", "description": "Deal name" }, "oldValues": { "type": "object", "additionalProperties": true }, "newValues": { "type": "object", "additionalProperties": true } } }, "WebhookDealReturnedData": { "type": "object", "description": "Data payload for deal.returned events", "properties": { "oldStatus": { "type": "string", "description": "Previous status" }, "newStatus": { "type": "string", "description": "New status (returned)", "example": "returned" }, "statusComment": { "type": "string", "nullable": true, "description": "Reason for return" }, "dealName": { "type": "string", "description": "Deal name" }, "oldValues": { "type": "object", "additionalProperties": true }, "newValues": { "type": "object", "additionalProperties": true } } }, "WebhookDealNoteUpdatedData": { "type": "object", "description": "Data payload for deal.note_updated events", "properties": { "oldNote": { "type": "string", "nullable": true, "description": "Previous note content" }, "newNote": { "type": "string", "nullable": true, "description": "New note content" }, "dealName": { "type": "string", "description": "Deal name" }, "oldValues": { "type": "object", "additionalProperties": true }, "newValues": { "type": "object", "additionalProperties": true } } }, "WebhookDealReminderData": { "type": "object", "description": "Data payload for deal.reminder_triggered and deal.deadline_triggered events", "properties": { "dealName": { "type": "string", "description": "Deal name" }, "remindAt": { "type": "integer", "nullable": true, "description": "Reminder timestamp (milliseconds)" }, "deadlineAt": { "type": "integer", "nullable": true, "description": "Deadline timestamp (milliseconds)" }, "orderId": { "type": "integer", "description": "Related order ID" } } }, "WebhookDealMessageSentData": { "type": "object", "description": "Data payload for deal.message_sent events", "properties": { "dealName": { "type": "string", "description": "Deal name" }, "messagePreview": { "type": "string", "description": "First 100 characters of the message" } } }, "WebhookDealReportOfflineData": { "type": "object", "description": "Data payload for deal.report_offline events", "properties": { "dealName": { "type": "string", "description": "Deal name" }, "customerId": { "type": "integer", "description": "Customer ID" }, "customerName": { "type": "string", "description": "Customer full name" }, "orderId": { "type": "integer", "description": "Order ID" } } }, "WebhookDealReportProblemData": { "type": "object", "description": "Data payload for deal.report_problem events", "properties": { "dealName": { "type": "string", "description": "Deal name" }, "message": { "type": "string", "description": "Problem description" }, "customerId": { "type": "integer", "description": "Customer ID" }, "customerName": { "type": "string", "description": "Customer full name" }, "orderId": { "type": "integer", "description": "Order ID" } } }, "WebhookOrderCreatedData": { "type": "object", "description": "Data payload for order.created events", "properties": { "orderStatus": { "type": "string", "description": "Initial order status" }, "paymentStatus": { "type": "string", "description": "Initial payment status" }, "price": { "type": "number", "description": "Order price" }, "currency": { "type": "string", "description": "Currency code (EUR, USD, GBP)", "enum": [ "EUR", "USD", "GBP" ] }, "sourceNonce": { "type": "string", "description": "External order nonce" }, "storeCode": { "type": "string", "description": "Store code identifier" }, "orderNumber": { "type": "string", "description": "Order number" } } }, "WebhookOrderCoinsTransactionData": { "type": "object", "description": "Data payload for order.coins_transaction events", "properties": { "amount": { "type": "number", "description": "Coins amount (positive for credit, negative for debit)" }, "type": { "type": "string", "description": "Transaction type" }, "itemName": { "type": "string", "description": "Item name for the transaction" }, "price": { "type": "number", "description": "Price in currency" }, "currency": { "type": "string", "description": "Currency code", "example": "EUR" }, "discountRate": { "type": "number", "nullable": true, "description": "Discount rate applied" } } }, "WebhookPayoutCreatedData": { "type": "object", "description": "Data payload for payout.created events", "properties": { "amount": { "type": "number", "description": "Payout amount" }, "mode": { "type": "string", "description": "Payout mode (free, standard, fast, priority, urgent)" }, "status": { "type": "string", "description": "Initial payout status" } } }, "WebhookCustomerCreatedData": { "type": "object", "description": "Data payload for customer.created events", "properties": { "fullName": { "type": "string", "nullable": true, "description": "Customer full name" }, "email": { "type": "string", "nullable": true, "description": "Customer email" }, "storeCode": { "type": "string", "nullable": true, "description": "Store code" } } }, "WebhookCustomerKycCompletedData": { "type": "object", "description": "Data payload for customer.kyc_completed events", "properties": { "oldValues": { "type": "object", "properties": { "kycCompleted": { "type": "boolean" } } }, "newValues": { "type": "object", "properties": { "kycCompleted": { "type": "boolean" } } }, "customerName": { "type": "string", "description": "Customer name" } } }, "WebhookCustomerCoinsAdjustedData": { "type": "object", "description": "Data payload for customer.coins_adjusted events", "properties": { "oldValues": { "type": "object", "properties": { "coins": { "type": "number" } } }, "newValues": { "type": "object", "properties": { "coins": { "type": "number" } } }, "adjustment": { "type": "number", "description": "Coins difference (positive for added, negative for deducted)" }, "customerName": { "type": "string", "description": "Customer name" } } }, "WebhookCustomerManagerData": { "type": "object", "description": "Data payload for customer.manager_assigned and customer.manager_reassigned events", "properties": { "oldValues": { "type": "object", "properties": { "managerProfile": { "type": "integer", "nullable": true } } }, "newValues": { "type": "object", "properties": { "managerProfile": { "type": "integer", "nullable": true } } }, "customerName": { "type": "string", "description": "Customer name" } } }, "WebhookProviderCreatedData": { "type": "object", "description": "Data payload for provider.created events", "properties": { "initialData": { "type": "object", "properties": { "nickname": { "type": "string", "nullable": true } } } } }, "WebhookProductCreatedData": { "type": "object", "description": "Data payload for product.created events", "properties": { "name": { "type": "string", "description": "Product name" }, "storeCode": { "type": "string", "description": "Store code" }, "sourceRefId": { "type": "string", "description": "External reference ID" }, "autoDeal": { "type": "boolean", "description": "Auto-deal enabled" }, "minPrice": { "type": "number", "description": "Minimum price" } } }, "WebhookProductPricingChangedData": { "type": "object", "description": "Data payload for product.pricing_changed events", "properties": { "name": { "type": "string", "description": "Product name" }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "List of pricing fields that changed" }, "oldPricing": { "type": "object", "description": "Previous pricing values", "additionalProperties": { "type": "number" } }, "newPricing": { "type": "object", "description": "New pricing values", "additionalProperties": { "type": "number" } } } }, "WebhookProductAutodealChangedData": { "type": "object", "description": "Data payload for product.autodeal_changed events", "properties": { "name": { "type": "string", "description": "Product name" }, "changedFields": { "type": "array", "items": { "type": "string" }, "description": "List of auto-deal fields that changed" }, "autoDeal": { "type": "boolean", "description": "Current auto-deal enabled status" }, "autoDealRate": { "type": "number", "description": "Current auto-deal rate" }, "autoDealName": { "type": "string", "description": "Current auto-deal name" }, "previousAutoDeal": { "type": "boolean", "description": "Previous auto-deal enabled status" }, "previousAutoDealRate": { "type": "number", "description": "Previous auto-deal rate" } } }, "WebhookProfileCreatedData": { "type": "object", "description": "Data payload for profile.created events", "properties": { "initialData": { "type": "object", "properties": { "username": { "type": "string" } } } } }, "WebhookDealEntity": { "type": "object", "description": "Sanitized deal entity snapshot included in webhook payloads. Whitelist-only: only listed fields are included.", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "open", "assigned", "on_approval", "completed", "failed", "cancelled", "returned" ] }, "price": { "type": "number", "nullable": true }, "note": { "type": "string", "nullable": true }, "statusComment": { "type": "string", "nullable": true }, "sessionState": { "type": "string", "nullable": true }, "fastPayout": { "type": "boolean" }, "openedAt": { "type": "string", "format": "date-time", "nullable": true }, "assignedAt": { "type": "string", "format": "date-time", "nullable": true }, "closedAt": { "type": "string", "format": "date-time", "nullable": true }, "remindAt": { "type": "string", "format": "date-time", "nullable": true }, "deadlineAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "provider": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "order": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "orderNumber": { "type": "string" } } }, "serviceType": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } }, "details": { "type": "object", "description": "Deal details component (full copy)" }, "customer": { "type": "object", "description": "Deal customer component (full copy)" }, "transcriptsCount": { "type": "integer", "description": "Computed: number of transcripts" } } }, "WebhookOrderEntity": { "type": "object", "description": "Sanitized order entity snapshot. Whitelist-only.", "properties": { "id": { "type": "integer" }, "orderNumber": { "type": "string" }, "price": { "type": "number" }, "currency": { "type": "string" }, "currencyFactor": { "type": "number" }, "orderCurrencyToUSDRate": { "type": "number" }, "orderStatus": { "type": "string" }, "paymentStatus": { "type": "string" }, "shippingStatus": { "type": "string" }, "note": { "type": "string", "nullable": true }, "customerNote": { "type": "string", "nullable": true }, "discount": { "type": "number", "nullable": true }, "sourceRefId": { "type": "string" }, "sourcePaymentStatus": { "type": "string", "nullable": true }, "sourceOrderStatus": { "type": "string", "nullable": true }, "sourcePaymentMethod": { "type": "string", "nullable": true }, "sourceCreatedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "customer": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "email": { "type": "string" } } }, "store": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "lineItems": { "type": "array", "description": "Order line items component (full copy)" }, "address": { "type": "object", "description": "Address component (full copy)" }, "contacts": { "type": "object", "description": "Contacts component (full copy)" }, "transcriptsCount": { "type": "integer", "description": "Computed: number of transcripts" }, "dealsCount": { "type": "integer", "description": "Computed: number of deals" } } }, "WebhookPayoutEntity": { "type": "object", "description": "Sanitized payout entity snapshot. Whitelist-only.", "properties": { "id": { "type": "integer" }, "uid": { "type": "string" }, "status": { "type": "string" }, "mode": { "type": "string" }, "amount": { "type": "number" }, "fee": { "type": "number" }, "feePercent": { "type": "number" }, "feeFixed": { "type": "number" }, "total": { "type": "number" }, "isInstallment": { "type": "boolean" }, "comment": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true }, "dueDateAt": { "type": "string", "format": "date-time", "nullable": true }, "closedAt": { "type": "string", "format": "date-time", "nullable": true }, "processedAt": { "type": "string", "format": "date-time", "nullable": true }, "cancelledAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "provider": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "requestedBy": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "username": { "type": "string" } } }, "transcriptsCount": { "type": "integer", "description": "Computed: number of transcripts" }, "dealsCount": { "type": "integer", "description": "Computed: number of deals" } } }, "WebhookCustomerEntity": { "type": "object", "description": "Sanitized customer entity snapshot. Whitelist-only.", "properties": { "id": { "type": "integer" }, "publicId": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "coins": { "type": "number" }, "kycCompleted": { "type": "boolean" }, "kycCompletedAt": { "type": "string", "format": "date-time", "nullable": true }, "numberOfOrders": { "type": "integer" }, "turnover": { "type": "number" }, "sourceRefId": { "type": "string", "nullable": true }, "sourceCreatedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "managerProfile": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "username": { "type": "string" } } }, "store": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "contacts": { "type": "object", "description": "Contacts component (full copy)" }, "address": { "type": "object", "description": "Address component (full copy)" }, "tagsCount": { "type": "integer", "description": "Computed: number of tags" } } }, "WebhookProviderEntity": { "type": "object", "description": "Sanitized provider entity snapshot. Whitelist-only.", "properties": { "id": { "type": "integer" }, "publicId": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "type": { "type": "string" }, "sellerType": { "type": "string" }, "skill": { "type": "string", "nullable": true }, "status": { "type": "string" }, "financialStatus": { "type": "string", "nullable": true }, "isImportant": { "type": "boolean" }, "isPublic": { "type": "boolean" }, "comment": { "type": "string", "nullable": true }, "lastApplicationAt": { "type": "string", "format": "date-time", "nullable": true }, "lastDealAt": { "type": "string", "format": "date-time", "nullable": true }, "activatedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "serviceTypes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } }, "owner": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "username": { "type": "string" } } }, "membersCount": { "type": "integer", "description": "Computed: number of members" } } }, "WebhookOfferEntity": { "type": "object", "description": "Sanitized offer entity snapshot. Whitelist-only.", "properties": { "id": { "type": "integer" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deal": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "status": { "type": "string" } } }, "applicationsCount": { "type": "integer", "description": "Computed: number of applications" } } }, "WebhookApplicationEntity": { "type": "object", "description": "Sanitized application entity snapshot. Whitelist-only.", "properties": { "id": { "type": "integer" }, "active": { "type": "boolean" }, "comment": { "type": "string", "nullable": true }, "price": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "provider": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } }, "offer": { "type": "object", "nullable": true, "properties": { "id": { "type": "integer" }, "status": { "type": "string" } } } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "JWT token from /auth/local endpoint" }, "apiKey": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "API key with Bearer prefix" }, "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "better-auth.session_token", "description": "Session cookie from Better Auth. Used by Provider App for same-domain requests." }, "adminAuth": { "type": "apiKey", "in": "cookie", "name": "jwtToken", "description": "Admin panel JWT cookie. Used by helper plugin admin routes." } } }, "tags": [ { "name": "WalletTransaction", "description": "wallet-transaction management endpoints" }, { "name": "Wallet", "description": "wallet management endpoints" }, { "name": "Ticket", "description": "ticket management endpoints" }, { "name": "Team", "description": "Team management endpoints" }, { "name": "Tag", "description": "tag management endpoints" }, { "name": "Store", "description": "store management endpoints" }, { "name": "ServiceType", "description": "service-type management endpoints" }, { "name": "Schedule", "description": "schedule management endpoints" }, { "name": "SalesChannel", "description": "sales-channel management endpoints" }, { "name": "PushSubscription", "description": "push-subscription management endpoints" }, { "name": "Provider", "description": "provider management endpoints" }, { "name": "Profile", "description": "profile management endpoints" }, { "name": "Product", "description": "product management endpoints" }, { "name": "Payout", "description": "payout management endpoints" }, { "name": "Order", "description": "order management endpoints" }, { "name": "Offer", "description": "offer management endpoints" }, { "name": "NotificationDeliveryLog", "description": "notification-delivery-log management endpoints" }, { "name": "Notification", "description": "User notification management" }, { "name": "MmUserLink", "description": "mm-user-link management endpoints" }, { "name": "Manufacturer", "description": "manufacturer management endpoints" }, { "name": "Log", "description": "log management endpoints" }, { "name": "EventLog", "description": "Event logging and audit trail for entity changes" }, { "name": "Deal", "description": "deal management endpoints" }, { "name": "Customer", "description": "customer management endpoints" }, { "name": "ConfigSchedule", "description": "config-schedule management endpoints" }, { "name": "ConfigMixin", "description": "config-mixin management endpoints" }, { "name": "ConfigExtension", "description": "config-extension management endpoints" }, { "name": "CoinsTransaction", "description": "coins-transaction management endpoints" }, { "name": "ChatAssignment", "description": "chat-assignment management endpoints" }, { "name": "Chat", "description": "chat management endpoints" }, { "name": "AttentionEventLog", "description": "attention-event-log management endpoints" }, { "name": "AttentionEvent", "description": "attention-event management endpoints" }, { "name": "Application", "description": "application management endpoints" }, { "name": "Chat Assignment", "description": "Chat assignment and follow operations" }, { "name": "Chat Notifications", "description": "Chat notification and unread tracking endpoints" }, { "name": "Settings", "description": "Global platform settings management" }, { "name": "Mattermost", "description": "Mattermost chat integration for order/deal communication" }, { "name": "Shopware", "description": "Shopware e-commerce integration for customer and product data" }, { "name": "Telemetry", "description": "Health checks and metrics endpoints" }, { "name": "WebhookDelivery", "description": "Webhook delivery tracking and management" }, { "name": "WebhookSubscription", "description": "Webhook subscription management for external integrations" }, { "name": "Provider Applications", "description": "Application management endpoints for providers.\nApplications are submitted by providers to offers (service requests).\nAll endpoints require an authenticated session and enforce RLS.\n" }, { "name": "Provider Auth", "description": "Authentication endpoints for the Provider App.\nProxies requests to Better Auth for session-based authentication.\n\n**Supported flows:**\n- Email/password sign up and sign in\n- Discord OAuth integration\n- Session management (get session, sign out)\n\n**Cookie-based auth:** All auth state is managed via HTTP-only cookies.\nClients must include credentials in requests.\n" }, { "name": "Provider Deals", "description": "Deal management endpoints for providers.\nAll endpoints require an authenticated session and enforce RLS\n(Row Level Security) - providers can only access their own deals.\n" }, { "name": "Provider Onboarding", "description": "Provider onboarding workflow endpoints.\nHandles the initial setup process for new providers including\nprofile completion and service type selection.\n" }, { "name": "Provider Payouts", "description": "Payout management endpoints for providers.\nPayouts represent compensation for completed deals.\nAll endpoints require an authenticated session and enforce RLS.\n" }, { "name": "Provider Profile", "description": "Provider profile and dashboard endpoints.\nAll endpoints require an authenticated session (cookie-based auth).\n" } ], "security": [ { "bearerAuth": [] } ], "x-webhooks": { "deal.created": { "post": { "summary": "Deal created", "description": "Fired when a new deal is created\n\n**Data schema:** [`WebhookDealCreatedData`](#model/webhookdealcreateddata)", "operationId": "webhook-deal-created", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.status_changed": { "post": { "summary": "Deal status changed", "description": "Fired when a deal transitions to a new status (draft → open → assigned → on_approval → completed/failed/cancelled/returned)\n\n**Data schema:** [`WebhookDealStatusChangedData`](#model/webhookdealstatuschangeddata)", "operationId": "webhook-deal-status-changed", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" }, "example": { "id": "550e8400-e29b-41d4-a716-446655440000", "type": "deal.status_changed", "timestamp": "2025-01-15T10:30:00.000Z", "subscription": { "id": 1, "name": "My Integration" }, "event": { "id": 456, "domain": "deal", "eventType": "status_changed", "entityUid": "api::deal.deal", "entityId": 12345, "description": "Status changed from \"assigned\" to \"on_approval\"" }, "changes": { "status": { "old": "assigned", "new": "on_approval" } }, "entity": { "id": 12345, "name": "Mythic+ Boost #12345", "status": "on_approval", "price": 49.99 }, "entityUrl": "https://stgadm.mmonster.co/api/deals/12345", "data": { "oldStatus": "assigned", "newStatus": "on_approval", "fastPayout": false, "dealName": "Mythic+ Boost #12345", "oldValues": { "status": "assigned" }, "newValues": { "status": "on_approval" } }, "_meta": { "entityIncluded": true, "entityTruncated": false, "truncationReason": null } } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.provider_assigned": { "post": { "summary": "Provider assigned to deal", "description": "Fired when a provider is assigned to a draft deal\n\n**Data schema:** [`WebhookDealProviderAssignedData`](#model/webhookdealproviderassigneddata)", "operationId": "webhook-deal-provider-assigned", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" }, "example": { "id": "550e8400-e29b-41d4-a716-446655440001", "type": "deal.provider_assigned", "timestamp": "2025-01-15T10:30:00.000Z", "subscription": { "id": 1, "name": "My Integration" }, "event": { "id": 457, "domain": "deal", "eventType": "provider_assigned", "entityUid": "api::deal.deal", "entityId": 12345, "description": "Provider \"ProBooster\" assigned to deal" }, "changes": null, "entity": { "id": 12345, "name": "Mythic+ Boost #12345", "status": "assigned", "price": 49.99 }, "entityUrl": "https://stgadm.mmonster.co/api/deals/12345", "data": { "oldStatus": "draft", "newStatus": "assigned", "providerId": 42, "providerName": "ProBooster", "price": 49.99, "dealName": "Mythic+ Boost #12345" }, "_meta": { "entityIncluded": true, "entityTruncated": false, "truncationReason": null } } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.provider_reassigned": { "post": { "summary": "Provider reassigned to deal", "description": "Fired when a provider is reassigned to an existing deal (replacing previous provider)\n\n**Data schema:** [`WebhookDealProviderAssignedData`](#model/webhookdealproviderassigneddata)", "operationId": "webhook-deal-provider-reassigned", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.completed": { "post": { "summary": "Deal completed", "description": "Fired when a deal is marked as completed\n\n**Data schema:** [`WebhookDealCompletedData`](#model/webhookdealcompleteddata)", "operationId": "webhook-deal-completed", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" }, "example": { "id": "550e8400-e29b-41d4-a716-446655440002", "type": "deal.completed", "timestamp": "2025-01-15T14:00:00.000Z", "subscription": { "id": 1, "name": "My Integration" }, "event": { "id": 500, "domain": "deal", "eventType": "completed", "entityUid": "api::deal.deal", "entityId": 12345, "description": "Deal completed successfully" }, "changes": { "status": { "old": "on_approval", "new": "completed" } }, "entity": { "id": 12345, "name": "Mythic+ Boost #12345", "status": "completed", "price": 49.99 }, "entityUrl": "https://stgadm.mmonster.co/api/deals/12345", "data": { "oldStatus": "on_approval", "newStatus": "completed", "price": 49.99, "providerId": 42, "providerName": "ProBooster", "dealName": "Mythic+ Boost #12345", "oldValues": { "status": "on_approval" }, "newValues": { "status": "completed" } }, "_meta": { "entityIncluded": true, "entityTruncated": false, "truncationReason": null } } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.returned": { "post": { "summary": "Deal returned for revision", "description": "Fired when a deal is returned for revision (from on_approval back to assigned)\n\n**Data schema:** [`WebhookDealReturnedData`](#model/webhookdealreturneddata)", "operationId": "webhook-deal-returned", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.note_updated": { "post": { "summary": "Deal note updated", "description": "Fired when deal notes are updated\n\n**Data schema:** [`WebhookDealNoteUpdatedData`](#model/webhookdealnoteupdateddata)", "operationId": "webhook-deal-note-updated", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.reminder_triggered": { "post": { "summary": "Deal reminder triggered", "description": "Fired when a deal reminder deadline fires (from cron processDealNotifications)\n\n**Data schema:** [`WebhookDealReminderData`](#model/webhookdealreminderdata)", "operationId": "webhook-deal-reminder-triggered", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.deadline_triggered": { "post": { "summary": "Deal deadline triggered", "description": "Fired when a deal actual deadline fires (from cron processDealNotifications)\n\n**Data schema:** [`WebhookDealReminderData`](#model/webhookdealreminderdata)", "operationId": "webhook-deal-deadline-triggered", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.message_sent": { "post": { "summary": "Deal message sent", "description": "Fired when a message is sent in deal context\n\n**Data schema:** [`WebhookDealMessageSentData`](#model/webhookdealmessagesentdata)", "operationId": "webhook-deal-message-sent", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.report_offline": { "post": { "summary": "Client reported offline", "description": "Fired when a client is reported as offline in deal context\n\n**Data schema:** [`WebhookDealReportOfflineData`](#model/webhookdealreportofflinedata)", "operationId": "webhook-deal-report-offline", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "deal.report_problem": { "post": { "summary": "Deal problem reported", "description": "Fired when a problem is reported in deal context\n\n**Data schema:** [`WebhookDealReportProblemData`](#model/webhookdealreportproblemdata)", "operationId": "webhook-deal-report-problem", "tags": [ "Webhooks", "Deal" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "order.created": { "post": { "summary": "Order created", "description": "Fired when a new order is created (from Shopware sync or manual)\n\n**Data schema:** [`WebhookOrderCreatedData`](#model/webhookordercreateddata)", "operationId": "webhook-order-created", "tags": [ "Webhooks", "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" }, "example": { "id": "660e8400-e29b-41d4-a716-446655440010", "type": "order.created", "timestamp": "2025-01-15T10:30:00.000Z", "subscription": { "id": 1, "name": "My Integration" }, "event": { "id": 600, "domain": "order", "eventType": "created", "entityUid": "api::order.order", "entityId": 67890, "description": "Order #SW-12345 created" }, "changes": null, "entity": { "id": 67890, "orderNumber": "SW-12345", "price": 49.99, "currency": "EUR", "orderStatus": "open" }, "entityUrl": "https://stgadm.mmonster.co/api/orders/67890", "data": { "orderStatus": "open", "paymentStatus": "open", "price": 49.99, "currency": "EUR", "sourceNonce": "abc123", "storeCode": "shopware", "orderNumber": "SW-12345" }, "_meta": { "entityIncluded": true, "entityTruncated": false, "truncationReason": null } } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "order.status_changed": { "post": { "summary": "Order status changed", "description": "Fired when order status changes (open → in_progress → completed)\n\n**Data schema:** [`WebhookOrderChangeData`](#model/webhookorderchangedata)", "operationId": "webhook-order-status-changed", "tags": [ "Webhooks", "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "order.payment_status_changed": { "post": { "summary": "Order payment status changed", "description": "Fired when payment status changes (open → paid, refunded, etc.)\n\n**Data schema:** [`WebhookOrderChangeData`](#model/webhookorderchangedata)", "operationId": "webhook-order-payment-status-changed", "tags": [ "Webhooks", "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "order.shipping_status_changed": { "post": { "summary": "Order shipping status changed", "description": "Fired when shipping status changes\n\n**Data schema:** [`WebhookOrderChangeData`](#model/webhookorderchangedata)", "operationId": "webhook-order-shipping-status-changed", "tags": [ "Webhooks", "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "order.note_updated": { "post": { "summary": "Order note updated", "description": "Fired when order notes are updated\n\n**Data schema:** [`WebhookOrderChangeData`](#model/webhookorderchangedata)", "operationId": "webhook-order-note-updated", "tags": [ "Webhooks", "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "order.coins_transaction": { "post": { "summary": "Order coins transaction", "description": "Fired when a coins transaction occurs for an order\n\n**Data schema:** [`WebhookOrderCoinsTransactionData`](#model/webhookordercoinstransactiondata)", "operationId": "webhook-order-coins-transaction", "tags": [ "Webhooks", "Order" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "payout.created": { "post": { "summary": "Payout requested", "description": "Fired when a provider requests a payout\n\n**Data schema:** [`WebhookPayoutCreatedData`](#model/webhookpayoutcreateddata)", "operationId": "webhook-payout-created", "tags": [ "Webhooks", "Payout" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "payout.status_changed": { "post": { "summary": "Payout status changed", "description": "Fired when a payout status changes (pending → processing → completed/rejected)\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-payout-status-changed", "tags": [ "Webhooks", "Payout" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "payout.note_updated": { "post": { "summary": "Payout note updated", "description": "Fired when payout notes are updated\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-payout-note-updated", "tags": [ "Webhooks", "Payout" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "customer.created": { "post": { "summary": "Customer created", "description": "Fired when a new customer is created\n\n**Data schema:** [`WebhookCustomerCreatedData`](#model/webhookcustomercreateddata)", "operationId": "webhook-customer-created", "tags": [ "Webhooks", "Customer" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "customer.kyc_completed": { "post": { "summary": "Customer KYC completed", "description": "Fired when a customer completes KYC verification\n\n**Data schema:** [`WebhookCustomerKycCompletedData`](#model/webhookcustomerkyccompleteddata)", "operationId": "webhook-customer-kyc-completed", "tags": [ "Webhooks", "Customer" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "customer.coins_adjusted": { "post": { "summary": "Customer coins adjusted", "description": "Fired when a customer's coin balance is adjusted\n\n**Data schema:** [`WebhookCustomerCoinsAdjustedData`](#model/webhookcustomercoinsadjusteddata)", "operationId": "webhook-customer-coins-adjusted", "tags": [ "Webhooks", "Customer" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "customer.manager_assigned": { "post": { "summary": "Customer manager assigned", "description": "Fired when a manager is first assigned to a customer\n\n**Data schema:** [`WebhookCustomerManagerData`](#model/webhookcustomermanagerdata)", "operationId": "webhook-customer-manager-assigned", "tags": [ "Webhooks", "Customer" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "customer.manager_reassigned": { "post": { "summary": "Customer manager reassigned", "description": "Fired when a customer's manager is reassigned\n\n**Data schema:** [`WebhookCustomerManagerData`](#model/webhookcustomermanagerdata)", "operationId": "webhook-customer-manager-reassigned", "tags": [ "Webhooks", "Customer" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "customer.updated": { "post": { "summary": "Customer updated", "description": "Fired when customer notes or salesNote are updated\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-customer-updated", "tags": [ "Webhooks", "Customer" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "provider.created": { "post": { "summary": "Provider created", "description": "Fired when a new provider is created\n\n**Data schema:** [`WebhookProviderCreatedData`](#model/webhookprovidercreateddata)", "operationId": "webhook-provider-created", "tags": [ "Webhooks", "Provider" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "provider.status_changed": { "post": { "summary": "Provider status changed", "description": "Fired when a provider status changes\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-provider-status-changed", "tags": [ "Webhooks", "Provider" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "provider.note_updated": { "post": { "summary": "Provider note updated", "description": "Fired when provider notes are updated\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-provider-note-updated", "tags": [ "Webhooks", "Provider" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "product.created": { "post": { "summary": "Product created", "description": "Fired when a new product is created\n\n**Data schema:** [`WebhookProductCreatedData`](#model/webhookproductcreateddata)", "operationId": "webhook-product-created", "tags": [ "Webhooks", "Product" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "product.pricing_changed": { "post": { "summary": "Product pricing changed", "description": "Fired when product pricing fields change (minPrice, ghostPrice, discountPrice, etc.)\n\n**Data schema:** [`WebhookProductPricingChangedData`](#model/webhookproductpricingchangeddata)", "operationId": "webhook-product-pricing-changed", "tags": [ "Webhooks", "Product" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "product.autodeal_changed": { "post": { "summary": "Product auto-deal config changed", "description": "Fired when product auto-deal configuration changes\n\n**Data schema:** [`WebhookProductAutodealChangedData`](#model/webhookproductautodealchangeddata)", "operationId": "webhook-product-autodeal-changed", "tags": [ "Webhooks", "Product" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "profile.created": { "post": { "summary": "Profile created", "description": "Fired when a new user profile is created\n\n**Data schema:** [`WebhookProfileCreatedData`](#model/webhookprofilecreateddata)", "operationId": "webhook-profile-created", "tags": [ "Webhooks", "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "profile.kyc_status_changed": { "post": { "summary": "Profile KYC status changed", "description": "Fired when a profile KYC status changes\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-profile-kyc-status-changed", "tags": [ "Webhooks", "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "profile.username_changed": { "post": { "summary": "Profile username changed", "description": "Fired when a profile username changes\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-profile-username-changed", "tags": [ "Webhooks", "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } }, "profile.updated": { "post": { "summary": "Profile updated", "description": "Fired when other profile fields change\n\n**Data schema:** [`WebhookGenericChangeData`](#model/webhookgenericchangedata)", "operationId": "webhook-profile-updated", "tags": [ "Webhooks", "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayload" } } } }, "responses": { "200": { "description": "Webhook received successfully" }, "400": { "description": "Invalid payload" }, "401": { "description": "Invalid signature" } } } } } }