{ "openapi": "3.0.0", "info": { "title": "CHIP API Documentation", "description": "Comprehensive API documentation for the CHIP platform - a professional networking and matching application that connects consumers with healthcare professionals, benefits providers, and educational opportunities.", "contact": { "name": "CHIP API Support", "url": "https://chipprofessionals.com/support", "email": "support@chipprofessionals.com" }, "license": { "name": "Proprietary", "url": "https://chipprofessionals.com/license" }, "version": "1.0.0" }, "servers": [ { "url": "https://api.chipprofessionals.com", "description": "Production API Server" }, { "url": "https://api.staging.chipprofessionals.com", "description": "Staging API Server" }, { "url": "http://localhost:8000", "description": "Local Development Server" } ], "paths": { "/api/activity": { "get": { "tags": [ "Activity" ], "summary": "Get a listing of the activity for the current user.", "operationId": "40a6e28becef43434d0b976f18166d86", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "current_page": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } }, "first_page_url": { "type": "string", "nullable": true }, "from": { "type": "integer", "nullable": true }, "last_page": { "type": "integer" }, "last_page_url": { "type": "string" }, "links": { "type": "array", "items": { "type": "object" } }, "next_page_url": { "type": "string", "nullable": true }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "nullable": true }, "total": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Activity" ], "operationId": "fe781cc573137dd146e327d220972ec4", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Activity created", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/forgot-password": { "post": { "tags": [ "Auth" ], "summary": "Send a password reset link", "operationId": "8edff628e5b7d9b6456312285c8141bf", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } }, "type": "object" } } } }, "responses": { "200": { "description": "Reset link sent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Reset link could not be sent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/auth/reset-password": { "put": { "tags": [ "Auth" ], "summary": "Reset a password", "operationId": "47d1f9ae2dae55f411fc2ec5f44c4f62", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "token", "password", "password_confirmation" ], "properties": { "email": { "type": "string", "format": "email" }, "token": { "type": "string" }, "password": { "type": "string", "format": "password" }, "password_confirmation": { "type": "string", "format": "password" } }, "type": "object" } } } }, "responses": { "200": { "description": "Password reset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Password could not be reset", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/auth/login": { "post": { "tags": [ "Auth" ], "summary": "Log in", "operationId": "1468a0a7f71c9041836c0c3da9811df1", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "login", "password", "device_name" ], "properties": { "login": { "type": "string" }, "password": { "type": "string", "format": "password" }, "device_name": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful login", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "token": { "type": "string" }, "user": { "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "email": { "type": "string", "format": "email" }, "username": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/auth/password/first": { "post": { "tags": [ "Auth" ], "summary": "Set the authenticated user's first password", "operationId": "7424ee3ca8a0b81a83aac4a455b1a8da", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "password", "password_confirmation" ], "properties": { "password": { "type": "string", "format": "password" }, "password_confirmation": { "type": "string", "format": "password" } }, "type": "object" } } } }, "responses": { "200": { "description": "Password set", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Validation failed or password already set", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/register": { "post": { "tags": [ "Auth" ], "summary": "Register a new user", "operationId": "78ca0a452d6472988e303771c2606d0e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "terms" ], "properties": { "email": { "type": "string", "format": "email" }, "username": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string", "format": "password" }, "password_confirmation": { "type": "string", "format": "password" }, "terms": { "type": "boolean" }, "device_name": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful registration", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "token": { "type": "string" }, "user": { "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "email": { "type": "string", "format": "email" }, "username": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } } } }, "/auth/register/form-config": { "get": { "tags": [ "Auth" ], "summary": "Get registration form configuration", "operationId": "d6ae6b1b71e1dc877e692b920b31b670", "responses": { "200": { "description": "Registration form configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/auth/social/{provider}/start/{type}": { "get": { "tags": [ "SocialAuth" ], "summary": "Start social authentication", "description": "Class SocialProviderController\n\nUsed for documentation only!\n\nNo registered route targets an action implemented by this controller. The\nsocial routes in routes/auth.php reference actions absent from this class.", "operationId": "6c18277496181449a5964859306cb371", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/auth/social/{provider}/start/{type}/{userType}": { "get": { "tags": [ "SocialAuth" ], "summary": "Start social authentication for a user type", "operationId": "c42ec8f2f320b6a1c458ccaf94bd114e", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/auth/social/{provider}/web": { "get": { "tags": [ "SocialAuth" ], "summary": "Complete web social authentication", "operationId": "8e31c3ac631c9b753902411ee9b78a8c", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/auth/email/resend-verification": { "post": { "tags": [ "Auth" ], "summary": "Resend a verification email", "operationId": "239f1520e7ce620e66d8f7b10626feee", "responses": { "200": { "description": "Verification email sent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/email/verify/{id}/{hash}": { "post": { "tags": [ "Auth" ], "summary": "Verify an email address", "operationId": "191a5f7f4340caf4d2bd7149b2852c65", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "hash", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Email verified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "500": { "description": "Unknown verification user causes an application error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/benefits": { "get": { "tags": [ "Benefit" ], "summary": "List benefits", "operationId": "58c4c75a97ad0cddd0e521b348c228fb", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated benefits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/benefits/index-config": { "get": { "tags": [ "Benefit" ], "summary": "Get benefit index configuration", "operationId": "2aee3ad24d614e0c0e48b6b4e5d3d451", "responses": { "200": { "description": "Benefit index configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/benefits/{benefit}": { "get": { "tags": [ "Benefit" ], "summary": "Get a benefit", "operationId": "0b1a2910ff1fe2084c285618dd4b04f4", "parameters": [ { "name": "benefit", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Benefit retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Benefit not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/categories": { "get": { "tags": [ "Category" ], "summary": "List categories", "operationId": "9c384bece2c8ce7874a481f3f0ad19c8", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated categories", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/comments/{contentType}/{contentId}": { "get": { "tags": [ "Comment" ], "summary": "Get a listing of the Comments.", "description": "Get all Comments", "operationId": "d214c5db97297dfc5a0565b5e5e698af", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "next_cursor": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "prev_cursor": { "type": "string", "nullable": true }, "prev_page_url": { "type": "string", "nullable": true } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Comment" ], "summary": "Store a newly created Comment in storage", "description": "Store Comment", "operationId": "15fa2b8fb787761bce78f6f2844fc2d4", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/comments": { "get": { "tags": [ "Comment" ], "summary": "Get the authenticated user's comments.", "operationId": "151a4f5af59df3159255b1fbfc0eae6b", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "next_cursor": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "prev_cursor": { "type": "string", "nullable": true }, "prev_page_url": { "type": "string", "nullable": true } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Comment" ], "summary": "Store a comment for the authenticated user.", "operationId": "78c4519867af4ea6924bb23b3ae4ea1d", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/comments/{comment}": { "get": { "tags": [ "Comment" ], "summary": "Display the specified Comment", "description": "Get Comment", "operationId": "033cd2b3273a3aad69dae28b3a0ca969", "parameters": [ { "name": "comment", "in": "path", "description": "id of Comment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Comment" ], "summary": "Update the specified Comment in storage", "description": "Update Comment", "operationId": "8e91041dabfd9e6b55ed1a074b78057d", "parameters": [ { "name": "comment", "in": "path", "description": "id of Comment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Comment" ], "summary": "Remove the specified Comment from storage", "description": "Delete Comment", "operationId": "649adcc71453bb2c55932a2b4c2ce5c3", "parameters": [ { "name": "comment", "in": "path", "description": "id of Comment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Comment" ], "summary": "Update the specified Comment in storage", "operationId": "d4c18b74390140070c57b5aa82fb8918", "parameters": [ { "name": "comment", "in": "path", "description": "id of Comment", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matching-criteria/consumer/{consumer}": { "get": { "tags": [ "ConsumerMatchingCriteria" ], "summary": "getConsumerMatchingCriteriaItem", "description": "Get ConsumerMatchingCriteria", "operationId": "10f0b1b694cc7355a5fda147a46c0435", "parameters": [ { "name": "consumer", "in": "path", "description": "id of ConsumerMatchingCriteria", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ConsumerMatchingCriteria" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "ConsumerMatchingCriteria" ], "summary": "updateConsumerMatchingCriteria", "description": "Update ConsumerMatchingCriteria", "operationId": "21e17d750f71383b2f8af51a4ef14662", "parameters": [ { "name": "consumer", "in": "path", "description": "id of ConsumerMatchingCriteria", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "" ], "properties": { "name": { "description": "desc", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ConsumerMatchingCriteria" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "ConsumerMatchingCriteria" ], "summary": "deleteConsumerMatchingCriteria", "description": "Delete ConsumerMatchingCriteria", "operationId": "9f181e0dd6c44ae5c063bbfb2f8e5ed9", "parameters": [ { "name": "consumer", "in": "path", "description": "id of ConsumerMatchingCriteria", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "ConsumerMatchingCriteria" ], "summary": "Update consumer matching criteria (PATCH alias)", "operationId": "0b239f561dd8eaa8882a526954897e7c", "parameters": [ { "name": "consumer", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumerMatchingCriteria" } } } }, "responses": { "200": { "description": "Consumer matching criteria updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Consumer matching criteria not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matching-criteria/consumer": { "get": { "tags": [ "ConsumerMatchingCriteria" ], "summary": "getConsumerMatchingCriteriaList", "description": "Get all ConsumerMatchingCriterias", "operationId": "b097e92b21f3b8fbf5a84e09f635160a", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConsumerMatchingCriteria" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "ConsumerMatchingCriteria" ], "summary": "createConsumerMatchingCriteria", "description": "Create ConsumerMatchingCriteria", "operationId": "1e389fe1ada1d822153dd4a23ceeef0e", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "" ], "properties": { "name": { "description": "desc", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ConsumerMatchingCriteria" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/onboarding-choices": { "get": { "tags": [ "Onboarding" ], "summary": "Get canonical consumer onboarding choices", "description": "Requires an authenticated Consumer with password setup complete. Reads the catalog without provisioning it or returning saved answers or personal data. Options are ordered canonical ID/label pairs. business_stage_id, investment_range_id, emergency_savings_range_id, fee_transparency_preference_id and fee_structure_preference_id have multiple=false; the remaining fields have multiple=true. The inherited _fields/_relations projection can omit data.fields; without projection all catalog fields are returned.", "operationId": "84b121a3d4a8a810b265683137518eed", "responses": { "200": { "description": "Onboarding choices retrieved successfully", "content": { "application/json": { "schema": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "oneOf": [ { "required": [ "fields" ], "properties": { "fields": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceFields" } }, "type": "object" }, { "description": "Empty when inherited field projection excludes fields", "type": "array", "items": { "type": "object" }, "maxItems": 0 } ] }, "message": { "type": "string", "example": "Onboarding choices retrieved successfully" } }, "type": "object" } } } }, "401": { "description": "Authentication required" }, "403": { "description": "Consumer role required" }, "428": { "description": "Password setup required", "content": { "application/json": { "schema": { "required": [ "code", "message" ], "properties": { "code": { "type": "string", "enum": [ "password_setup_required" ] }, "message": { "type": "string", "example": "Set a password to continue." } }, "type": "object" } } } }, "503": { "description": "Canonical catalog unavailable; internal failure details are not exposed", "content": { "application/json": { "schema": { "required": [ "success", "message" ], "properties": { "success": { "type": "boolean", "enum": [ false ] }, "message": { "type": "string", "example": "Onboarding choices are unavailable." } }, "type": "object", "additionalProperties": false } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/criteria/role/{role}": { "get": { "tags": [ "Onboarding" ], "summary": "Get onboarding criteria by role", "description": "Fetch active onboarding criteria configuration for the provided role", "operationId": "23bcc12b38b236af19147ba1be2573c0", "parameters": [ { "name": "role", "in": "path", "description": "Role name (e.g., 'Consumer', 'Professional')", "required": true, "schema": { "type": "string", "enum": [ "Consumer", "Professional" ] } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Role must be Consumer or Professional" }, "404": { "description": "No onboarding criteria found" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/sessions": { "get": { "tags": [ "Conversational onboarding" ], "summary": "List the authenticated user's onboarding sessions", "description": "Class ConversationalOnboardingSessionAPIController", "operationId": "411c27e68f6671dad5395ec0a387cc89", "parameters": [ { "name": "role_id", "in": "query", "schema": { "type": "integer" } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "in_progress", "awaiting_transcription", "transcription_failed", "awaiting_completion", "completion_failed", "force_reprocess", "completed", "abandoned" ] } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated sessions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Invalid status filter" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/start": { "post": { "tags": [ "Conversational onboarding" ], "summary": "Start an onboarding session", "operationId": "76edd9bff2def918679c2239790e6a64", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "role_id" ], "properties": { "role_id": { "description": "Existing Consumer or Professional role ID", "type": "integer" }, "force": { "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "201": { "description": "Session created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "200": { "description": "Existing session returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Invalid role or request body" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/start/{sessionId}": { "post": { "tags": [ "Conversational onboarding" ], "summary": "Resume an onboarding session", "operationId": "eb6d35644a56801f42ea63070af03ef4", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Session returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Session not found or inaccessible" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/sessions/{sessionId}": { "get": { "tags": [ "Conversational onboarding" ], "summary": "Get an onboarding session", "operationId": "ffbceaaf84f80c7c8418d337cb0d576c", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Session with current question", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Session not found or inaccessible" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/sessions/{sessionId}/{questionIndex}": { "get": { "tags": [ "Conversational onboarding" ], "summary": "Get an onboarding session at a question index", "operationId": "6ecc87480b1ee18bc2d96a5b02f457c1", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "questionIndex", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "Session with requested question", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Session not found or inaccessible" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/answer/text": { "post": { "tags": [ "Conversational onboarding" ], "summary": "Submit a text answer", "operationId": "5a2107d0f683a353b887eeaf3d4772c6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "session_id", "answer_text" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "answer_text": { "type": "string", "maxLength": 5000 } }, "type": "object" } } } }, "responses": { "200": { "description": "Answer recorded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Invalid answer or session state" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/answer/audio": { "post": { "tags": [ "Conversational onboarding" ], "summary": "Submit an audio answer", "operationId": "2830661884f24baa5a957570b33e41c6", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "session_id", "audio" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "question_index": { "description": "Displayed zero-based question index; defaults to the session frontier when omitted", "type": "integer", "minimum": 0 }, "audio": { "description": "mp3, wav, m4a, ogg, or webm; maximum 10 MB", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Audio answer accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "422": { "description": "Invalid audio, question index, transcription failure, or session state" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/complete/{sessionId}": { "post": { "tags": [ "Conversational onboarding" ], "summary": "Queue or retrieve onboarding completion", "operationId": "0f653647d93a37e1f4a15de48808546b", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Cached completion returned, transcriptions pending, or completion queued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Session not found or inaccessible" }, "422": { "description": "Session is not completable, transcription is pending, or no usable answers remain after a failed transcription" }, "429": { "description": "Too many completion requests" } }, "security": [ { "bearer_token": [] } ] } }, "/api/onboarding/conversational/answer/audio/retry": { "post": { "tags": [ "Conversational onboarding" ], "summary": "Retry transcription of a saved audio answer", "description": "Retries the saved recording for the owned question; the request does not upload or replace audio.", "operationId": "7d4549bfdd01075bc963f9099a2bb23e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "session_id", "question_index" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "question_index": { "type": "integer", "minimum": 0 } }, "type": "object" } } } }, "responses": { "200": { "description": "Saved audio retry status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Session not found or inaccessible" }, "409": { "description": "Session is being processed" }, "422": { "description": "Invalid request, session state, question index, or no saved recording" } }, "security": [ { "bearer_token": [] } ] } }, "/api/dashboard/me": { "get": { "tags": [ "Dashboard" ], "summary": "Get the current user's dashboard", "operationId": "9450c797392a0dd505f208c26e450774", "responses": { "200": { "description": "Dashboard retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/events": { "get": { "tags": [ "Event" ], "summary": "List events", "operationId": "7df0498352b1d2fb65f2fe45656247bd", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated events", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Event" ], "summary": "Create an event", "operationId": "3fffc0df50988d38077783c4cd8f75c0", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "responses": { "200": { "description": "Event saved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/events/{event}": { "get": { "tags": [ "Event" ], "summary": "Get an event", "operationId": "5f75d54b3b3a2110a16080552ac9b976", "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Event retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Event not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Event" ], "summary": "Update an event", "operationId": "b2d225a8e1a2ca1626fec4c094379942", "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "responses": { "200": { "description": "Event updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Event not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Event" ], "summary": "Delete an event", "operationId": "40c21e0090a73fc647327d3ca666c595", "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Event deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Event not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Event" ], "summary": "Update an event (PATCH alias)", "operationId": "4f7e321f518867ecd3189f7fbbc22519", "parameters": [ { "name": "event", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "responses": { "200": { "description": "Event updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Event not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/faqs": { "get": { "tags": [ "FAQ" ], "summary": "List FAQs", "operationId": "dc8175070e9b02d18a81c38241de1f7b", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated FAQs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/faqs/index-config": { "get": { "tags": [ "FAQ" ], "summary": "Get FAQ index configuration", "operationId": "362fec1cf4cff3367bb99488cd2d617d", "responses": { "200": { "description": "FAQ index configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/faqs/{faq}": { "get": { "tags": [ "FAQ" ], "summary": "Get an FAQ", "operationId": "b43948c389a9df8ed1924dc17ac25aac", "parameters": [ { "name": "faq", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "FAQ retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "FAQ not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/public/faqs": { "get": { "tags": [ "FAQ" ], "summary": "List public FAQs", "operationId": "354c0ffb06f47d0697a2a70a044e2726", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated public FAQs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } } } } }, "/public/faqs/index-config": { "get": { "tags": [ "FAQ" ], "summary": "Get public FAQ index configuration", "operationId": "60c39a535bf80682bba473e57e4c6b43", "responses": { "200": { "description": "FAQ index configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/api/user/favorites/index-config": { "get": { "tags": [ "Favorite" ], "summary": "Get Favorite index configuration", "description": "Class FavoriteController", "operationId": "e4db2bf1dd356a591d0ccb3aa9b161a1", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/favorites": { "get": { "tags": [ "Favorite" ], "summary": "Get a listing of the Favorites.", "operationId": "e6980e879f0780b160bef546422c0aa7", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Favorite" ], "summary": "Store a newly created Favorite in storage", "operationId": "10eea48e4bad8c444e71b52fcb5249d0", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/favorites/{contentType}/{contentId}": { "get": { "tags": [ "Favorite" ], "summary": "List Favorites for content", "operationId": "0f25983e1e58919e60dc72462777876d", "parameters": [ { "name": "contentType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Favorite" ], "summary": "Create a Favorite for content", "operationId": "fdc9cb8d8cf0e95899694200df88d67a", "parameters": [ { "name": "contentType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Favorite" ], "summary": "Remove a Favorite", "operationId": "c157840dc56e2c93768b2f607618986c", "parameters": [ { "name": "contentType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/favorites/{favorite}": { "get": { "tags": [ "Favorite" ], "summary": "Get a Favorite", "operationId": "8e93f11233e173868d8ebe818f41cc77", "parameters": [ { "name": "favorite", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Favorite" ], "summary": "Update a Favorite", "operationId": "1a0e332fbb3245c270a7dc17bf648890", "parameters": [ { "name": "favorite", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Favorite" ], "summary": "Delete a Favorite", "operationId": "6c439aeaca171ad5807f2423950ebe9c", "parameters": [ { "name": "favorite", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Favorite" ], "summary": "Update a Favorite", "operationId": "b4d21b2ea99c78278ac0dfccd770ae4b", "parameters": [ { "name": "favorite", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/feed": { "get": { "tags": [ "Feed" ], "summary": "Get the Feed.", "description": "Get the Feed", "operationId": "c105c423429b21deaf12148e0b7dca42", "parameters": [ { "name": "sort", "in": "query", "description": "Sort feed by", "required": false, "schema": { "type": "string" } }, { "name": "filter[type]", "in": "query", "description": "Type of Content", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "current_page": { "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } }, "first_page_url": { "type": "string", "nullable": true }, "from": { "type": "integer", "nullable": true }, "last_page": { "type": "integer" }, "last_page_url": { "type": "string" }, "links": { "type": "array", "items": { "type": "object" } }, "next_page_url": { "type": "string", "nullable": true }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "nullable": true }, "total": { "type": "integer" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/feedback/{contentType}/{contentId}": { "get": { "tags": [ "Feedback" ], "summary": "List feedback for content", "operationId": "674ab8b24c597fc29c4a77c9da8adc00", "parameters": [ { "name": "contentType", "in": "path", "description": "Studly-cased content model name", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "Content identifier", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Cursor-paginated feedback", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "reportable_type": { "type": "string" }, "reportable_id": { "type": "integer" }, "content": { "type": "string", "nullable": true }, "user_id": { "type": "integer", "nullable": true }, "type": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "next_cursor": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "prev_cursor": { "type": "string", "nullable": true }, "prev_page_url": { "type": "string", "nullable": true } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Content type or content item was not found" }, "429": { "description": "Too many requests" } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Feedback" ], "summary": "Create feedback for content", "operationId": "8985422586308228725af9067cd647c5", "parameters": [ { "name": "contentType", "in": "path", "description": "Studly-cased content model name", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "Content identifier", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "content": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Feedback saved", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "id": { "type": "integer" }, "reportable_type": { "type": "string" }, "reportable_id": { "type": "integer" }, "content": { "type": "string", "nullable": true }, "user_id": { "type": "integer", "nullable": true }, "type": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated" }, "404": { "description": "Content type or content item was not found" }, "422": { "description": "The supplied feedback fields are invalid", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "429": { "description": "Too many requests" } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/follows": { "get": { "tags": [ "Follow" ], "summary": "Get a listing of the Follows.", "description": "Get all Follows", "operationId": "b62ae35e67b294b280c851fb34090c54", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Follow" ], "summary": "Store a follow for the authenticated user.", "operationId": "8beaa4792b3cdd17fecd85b38f9ab4c2", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/follows/{contentType}/{contentId}": { "get": { "tags": [ "Follow" ], "summary": "Get follows for content.", "operationId": "94d486573d14877a82b1b8eeef045f7d", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Follow" ], "summary": "Store a newly created Follow in storage", "description": "Store Follow", "operationId": "802396f85b7735488d89ddf209038cf3", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/follows/{type}": { "get": { "tags": [ "Follow" ], "summary": "Get follows by type.", "operationId": "5b48e6601d68d7bf9f3d763f2e1d8221", "parameters": [ { "name": "type", "in": "path", "description": "Follow type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/follows/{type}/{contentType}": { "get": { "tags": [ "Follow" ], "summary": "Get follows by type and content type.", "operationId": "0a00a8c3bf61fffdf67f881870b51ce1", "parameters": [ { "name": "type", "in": "path", "description": "Follow type", "required": true, "schema": { "type": "string" } }, { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/follows/{type}/{contentType}/{contentId}": { "get": { "tags": [ "Follow" ], "summary": "Get follows by type and content.", "operationId": "651559d850ecd2f7a9a0c57259584011", "parameters": [ { "name": "type", "in": "path", "description": "Follow type", "required": true, "schema": { "type": "string" } }, { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/following": { "get": { "tags": [ "Follow" ], "summary": "Get followed users.", "operationId": "41665b7d1785e28e4faba5592070e3b5", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/following/{contentType}": { "get": { "tags": [ "Follow" ], "summary": "Get followed content by type.", "operationId": "7ef9b9d88bb6472a2349ead21bba6d91", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/following/{contentType}/{contentId}": { "get": { "tags": [ "Follow" ], "summary": "Get followed content.", "operationId": "d55b2ca228497a148025fa6fa22ca512", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/followers": { "get": { "tags": [ "Follow" ], "summary": "Get followers.", "operationId": "681ceec69a6c21337d0495b6f09eb9a7", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/followers/{contentType}": { "get": { "tags": [ "Follow" ], "summary": "Get followers by content type.", "operationId": "777fc57534d158f0b8ff872f3f67bcf7", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/followers/{contentType}/{contentId}": { "get": { "tags": [ "Follow" ], "summary": "Get content followers.", "operationId": "bc6b96b23d33d49878e0ead922180f30", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/follows/{follow}": { "put": { "tags": [ "Follow" ], "summary": "Update the specified Follow in storage", "description": "Update Follow", "operationId": "e39c82b4ca5bd55e92170fb0ac338360", "parameters": [ { "name": "follow", "in": "path", "description": "id of Follow", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Follow" ], "summary": "Remove the specified Follow from storage", "description": "Delete Follow", "operationId": "34a40f7c5541cc586bdc4e2a99656e88", "parameters": [ { "name": "follow", "in": "path", "description": "id of Follow", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Follow" ], "summary": "Update the specified Follow in storage", "operationId": "83a8e80c1df06aa52e2fd92be8e792f6", "parameters": [ { "name": "follow", "in": "path", "description": "id of Follow", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/public/invites/redemptions/check/{code}": { "post": { "tags": [ "InviteRedemption" ], "summary": "Check an invitation code", "description": "Public endpoint; authentication is optional.", "operationId": "f459203eded66a45e7d0781d10db0905", "parameters": [ { "name": "code", "in": "path", "description": "Invitation code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "email": { "type": "string", "format": "email", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Invitation code is valid", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "result": { "type": "boolean", "example": true } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Invitation code is invalid", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "result": { "type": "boolean", "example": false } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/public/invites/redemptions/redeem/{code}": { "post": { "tags": [ "InviteRedemption" ], "summary": "Redeem an invitation code", "description": "Public endpoint; authentication is optional.", "operationId": "a8ca762b04e0f9927ba7e15dae96c228", "parameters": [ { "name": "code", "in": "path", "description": "Invitation code", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "email": { "type": "string", "format": "email", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Invitation redeemed", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "result": { "type": "boolean", "example": true } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Invitation could not be redeemed", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "properties": { "result": { "type": "boolean", "example": false } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Unexpected redemption error in local or development environments" } } } }, "/api/likes/{contentType}/{contentId}": { "get": { "tags": [ "Like" ], "summary": "Get a listing of the Likes.", "description": "Get all Likes", "operationId": "00094df1c9bd29e50fdf31c5f36f65d8", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Like" ], "summary": "Store a newly created Like in storage", "description": "Store Like", "operationId": "c6160e3411a91d8e43fd8c1798867814", "parameters": [ { "name": "contentType", "in": "path", "description": "Type of Content", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "description": "id of Content", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/likes": { "get": { "tags": [ "Like" ], "summary": "Get the authenticated user's likes.", "operationId": "25701959ea61ec6dc04a91bb0b5285ab", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Like" ], "summary": "Store a like for the authenticated user.", "operationId": "9063261af5435695665c96cae9e6598c", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/likes/{like}": { "get": { "tags": [ "Like" ], "summary": "Display the specified Like", "description": "Get Like", "operationId": "2e153c496602859dbedee6747cd7a1d3", "parameters": [ { "name": "like", "in": "path", "description": "id of Like", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Like" ], "summary": "Update the specified Like in storage", "description": "Update Like", "operationId": "e6f0765aebe80d54724c2f2e58aa8e2e", "parameters": [ { "name": "like", "in": "path", "description": "id of Like", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Like" ], "summary": "Remove the specified Like from storage", "description": "Delete Like", "operationId": "8790604924714046268fb6f33f534912", "parameters": [ { "name": "like", "in": "path", "description": "id of Like", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Like" ], "summary": "Update the specified Like in storage", "operationId": "3c175dd842da6ade35e891b1e3361fd6", "parameters": [ { "name": "like", "in": "path", "description": "id of Like", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/locations": { "get": { "tags": [ "Location" ], "summary": "List locations", "operationId": "bd9f83f4b67951fe5ac4a50c0a1103ae", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated locations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Location" ], "summary": "Create a location", "operationId": "89e90e745fdfb479e3244828af35b6fc", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "responses": { "200": { "description": "Location saved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/locations/{location}": { "get": { "tags": [ "Location" ], "summary": "Get a location", "operationId": "f4ea7f41a5bae5d015aa5427d45144f7", "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Location retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Location not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Location" ], "summary": "Update a location", "operationId": "06480f2297e8811ed34ed694ccbba5ff", "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "responses": { "200": { "description": "Location updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Location not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Location" ], "summary": "Delete a location", "operationId": "0e6ca6aeb0e210e43c580545e0b187d6", "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Location deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Location not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Location" ], "summary": "Partially update a location", "operationId": "81190cdb0d547e97bfa8729d7f08f1a1", "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Location" } } } }, "responses": { "200": { "description": "Location updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Location not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/location/form-config": { "get": { "tags": [ "Location" ], "summary": "Get location form configuration", "operationId": "acfac19bc7e2ba07a011d99a38a652db", "responses": { "200": { "description": "Location form configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/location/geocode/forward": { "post": { "tags": [ "Location" ], "summary": "Forward geocode an address", "operationId": "d72623da792060280d0baa5936927d8e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "address" ], "properties": { "address": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Forward geocoding result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/location/geocode/reverse": { "post": { "tags": [ "Location" ], "summary": "Reverse geocode coordinates", "operationId": "79091af16e3f392d28d85879febb8944", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "latitude", "longitude" ], "properties": { "latitude": { "type": "number", "format": "float" }, "longitude": { "type": "number", "format": "float" } }, "type": "object" } } } }, "responses": { "200": { "description": "Reverse geocoding result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/meetings": { "get": { "tags": [ "Meeting" ], "summary": "List meetings", "operationId": "3719ee93825e875b595e525003a6ceab", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated meetings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Meeting" ], "summary": "Create a meeting", "operationId": "9044dd5e84f4b491cf4b51f930864649", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meeting" } } } }, "responses": { "200": { "description": "Meeting saved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/meetings/{meeting}": { "get": { "tags": [ "Meeting" ], "summary": "Get a meeting", "operationId": "5c9b0fc47cb110815fa9fa3a057d71b9", "parameters": [ { "name": "meeting", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Meeting retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Meeting not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Meeting" ], "summary": "Update a meeting", "operationId": "26db9ea191e310ed02635fdbdd89db00", "parameters": [ { "name": "meeting", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meeting" } } } }, "responses": { "200": { "description": "Meeting updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Meeting not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Meeting" ], "summary": "Delete a meeting", "operationId": "30da9b9b888a5c79caf5aaa8806e4f89", "parameters": [ { "name": "meeting", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Meeting deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Meeting not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Meeting" ], "summary": "Update a meeting (PATCH alias)", "operationId": "c406f0d19cddc2f2f32019f3b47e9406", "parameters": [ { "name": "meeting", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Meeting" } } } }, "responses": { "200": { "description": "Meeting updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Meeting not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/opportunities": { "get": { "tags": [ "Opportunity" ], "summary": "List active opportunities", "operationId": "b4a8b4f2dc3cf85750fb7bd00de92b83", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated opportunities", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/opportunities/index-config": { "get": { "tags": [ "Opportunity" ], "summary": "Get opportunity index configuration", "operationId": "6605512aacdd2b1c3d4c369960df7175", "responses": { "200": { "description": "Opportunity index configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/opportunities/{opportunity}": { "get": { "tags": [ "Opportunity" ], "summary": "Get an opportunity", "operationId": "030a40ff21552da567b4ab159bf41fb8", "parameters": [ { "name": "opportunity", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Opportunity retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Opportunity not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/partners": { "get": { "tags": [ "Partner" ], "summary": "List partners", "operationId": "7a2a8b18b871d5f1de15c5c82276f073", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated partners", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/partners/index-config": { "get": { "tags": [ "Partner" ], "summary": "Get partner index configuration", "operationId": "0c805bf122063c1352853271ef63cebc", "responses": { "200": { "description": "Partner index configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/partners/{partner}": { "get": { "tags": [ "Partner" ], "summary": "Get a partner", "operationId": "cd2bad7acda0fb8fbb85e46351082cb7", "parameters": [ { "name": "partner", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Partner retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Partner not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matches": { "get": { "tags": [ "ProfessionalMatch" ], "summary": "List matches", "operationId": "04f838b7d1be0e49796296cdfd305164", "parameters": [ { "name": "preview", "in": "query", "schema": { "type": "boolean" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated matches", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Onboarding incomplete", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matches/{match}": { "get": { "tags": [ "ProfessionalMatch" ], "summary": "Get a match", "operationId": "0d34465b3078692be036ba6ed7b3305b", "parameters": [ { "name": "match", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Match retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Match not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "ProfessionalMatch" ], "summary": "Update a match", "operationId": "08dbf6ca5f3f545c02df22db4cd8ba73", "parameters": [ { "name": "match", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfessionalMatch" } } } }, "responses": { "200": { "description": "Match updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Match not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "ProfessionalMatch" ], "summary": "Partially update a match", "operationId": "6798c655e1a7cc0b7a047cc6e54c4757", "parameters": [ { "name": "match", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfessionalMatch" } } } }, "responses": { "200": { "description": "Match updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Match not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matches/generate": { "post": { "tags": [ "ProfessionalMatch" ], "summary": "Generate matches", "operationId": "e45865872cd8e6a2c9dcf099155c83a2", "parameters": [ { "name": "clear_matches", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Matches generated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "400": { "description": "Match generation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matches/{match}/cancel": { "put": { "tags": [ "ProfessionalMatch" ], "summary": "Cancel a match", "operationId": "9f289730b8e76aa12f2c23bc53151691", "parameters": [ { "name": "match", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Match cancelled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Match not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matches/{match}/accept": { "put": { "tags": [ "ProfessionalMatch" ], "summary": "Accept a match", "operationId": "8e8b3161de0ae2dc21dffd2b58f6d570", "parameters": [ { "name": "match", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Match accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Match not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matches/{match}/reject": { "put": { "tags": [ "ProfessionalMatch" ], "summary": "Reject a match", "operationId": "5718ba1b8930665a670af14ffef3c598", "parameters": [ { "name": "match", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Match rejected", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Match not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matching-criteria/professional/{professional}": { "get": { "tags": [ "ProfessionalMatchingCriteria" ], "summary": "getProfessionalMatchingCriteriaItem", "description": "Get ProfessionalMatchingCriteria", "operationId": "5bfa5943e011076b2474eb47022d325d", "parameters": [ { "name": "professional", "in": "path", "description": "id of ProfessionalMatchingCriteria", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ProfessionalMatchingCriteria" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "ProfessionalMatchingCriteria" ], "summary": "updateProfessionalMatchingCriteria", "description": "Update ProfessionalMatchingCriteria", "operationId": "911b1948137cd51448227d4b03934f27", "parameters": [ { "name": "professional", "in": "path", "description": "id of ProfessionalMatchingCriteria", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "" ], "properties": { "name": { "description": "desc", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ProfessionalMatchingCriteria" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "ProfessionalMatchingCriteria" ], "summary": "deleteProfessionalMatchingCriteria", "description": "Delete ProfessionalMatchingCriteria", "operationId": "f8c727aa9070ea68a0052fadd2d0d5d9", "parameters": [ { "name": "professional", "in": "path", "description": "id of ProfessionalMatchingCriteria", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "ProfessionalMatchingCriteria" ], "summary": "Update professional matching criteria (PATCH alias)", "operationId": "b0fd2d3d7bc6fd0b01ea3ef757aa3210", "parameters": [ { "name": "professional", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfessionalMatchingCriteria" } } } }, "responses": { "200": { "description": "Professional matching criteria updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Professional matching criteria not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/matching-criteria/professional": { "get": { "tags": [ "ProfessionalMatchingCriteria" ], "summary": "getProfessionalMatchingCriteriaList", "description": "Get all ProfessionalMatchingCriterias", "operationId": "4b3499340fdbcbbbb32842b33b42038c", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProfessionalMatchingCriteria" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "ProfessionalMatchingCriteria" ], "summary": "createProfessionalMatchingCriteria", "description": "Create ProfessionalMatchingCriteria", "operationId": "e6fa85843e340cb23289c43ff20200d3", "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "required": [ "" ], "properties": { "name": { "description": "desc", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "$ref": "#/components/schemas/ProfessionalMatchingCriteria" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/quiz/archetype/start": { "post": { "tags": [ "Quiz" ], "summary": "Start an archetype quiz", "operationId": "49f1b218a1342690a191c2ae9c5332a8", "responses": { "201": { "description": "Quiz started", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizArchetypeStartSuccess" } } } }, "403": { "description": "Guest credential or origin rejected", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "No active questions", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited: 30 requests per minute per IP", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/season/start": { "post": { "tags": [ "Quiz" ], "summary": "Start a season quiz", "operationId": "9013c43acd18030916a4bf877fdfaadf", "responses": { "201": { "description": "Quiz started", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizSeasonStartSuccess" } } } }, "403": { "description": "Guest credential or origin rejected", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "No active questions", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited: 30 requests per minute per IP", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/archetype/session/{sessionId}": { "get": { "tags": [ "Quiz" ], "summary": "Get an archetype quiz session", "operationId": "8cdaa365f42b1a9a486ac6f499b37f11", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "question_slug", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Quiz session", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizArchetypeSessionSuccess" } } } }, "403": { "description": "Expired guest credential", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Invalid question or path", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited by the API limiter", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/season/session/{sessionId}": { "get": { "tags": [ "Quiz" ], "summary": "Get a season quiz session", "operationId": "4881684dd8970a5523bf4868c390c487", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "question_slug", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Quiz session", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizSeasonSessionSuccess" } } } }, "403": { "description": "Expired guest credential", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Invalid question or path", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited by the API limiter", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/archetype/answer": { "post": { "tags": [ "Quiz" ], "summary": "Answer an archetype question", "operationId": "24795718228275fa0fe771c11c1adafd", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizAnswerRequest" } } } }, "responses": { "200": { "description": "Answer recorded", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizArchetypeAnswerSuccess" } } } }, "403": { "description": "Guest credential or origin rejected", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Invalid answer", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited: 60 requests per minute per IP", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/season/answer": { "post": { "tags": [ "Quiz" ], "summary": "Answer a season question", "operationId": "7b17120cdcab4e3eb056ba6000c8525f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizAnswerRequest" } } } }, "responses": { "200": { "description": "Answer recorded", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizSeasonAnswerSuccess" } } } }, "403": { "description": "Guest credential or origin rejected", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Invalid answer", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited: 60 requests per minute per IP", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/archetype/complete": { "post": { "tags": [ "Quiz" ], "summary": "Complete an archetype quiz", "operationId": "e17f5b426e36525765cb8af241e5a926", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizCompleteRequest" } } } }, "responses": { "200": { "description": "Quiz completed", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizArchetypeCompleteSuccess" } } } }, "403": { "description": "Guest credential or origin rejected", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Quiz cannot be completed", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited: 30 requests per minute per IP", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/season/complete": { "post": { "tags": [ "Quiz" ], "summary": "Complete a season quiz", "operationId": "e40799b80e69b4fa752b0620f35bac79", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizCompleteRequest" } } } }, "responses": { "200": { "description": "Quiz completed", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizSeasonCompleteSuccess" } } } }, "403": { "description": "Guest credential or origin rejected", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Quiz cannot be completed", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited: 30 requests per minute per IP", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/archetype/result/{sessionId}": { "get": { "tags": [ "Quiz" ], "summary": "Get an archetype quiz result", "operationId": "cef0670b6d9689d7061fc43ffba2b663", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Quiz result", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizArchetypeResultSuccess" } } } }, "403": { "description": "Expired guest credential", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Quiz is incomplete or wrong path", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited by the API limiter", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/season/result/{sessionId}": { "get": { "tags": [ "Quiz" ], "summary": "Get a season quiz result", "operationId": "14be7de230d0a59058d81ca956bee468", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Quiz result", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizSeasonResultSuccess" } } } }, "403": { "description": "Expired guest credential", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Quiz is incomplete or wrong path", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited by the API limiter", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/event/dashboard-launched": { "post": { "tags": [ "Quiz" ], "summary": "Record a dashboard launch", "operationId": "18bfab8ce189b88aea69338efb3311ad", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizDashboardEventRequest" } } } }, "responses": { "200": { "description": "Event recorded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizDashboardEventSuccess" } } } }, "403": { "description": "Guest origin rejected", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "404": { "description": "Session not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "422": { "description": "Invalid event", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "429": { "description": "Rate limited by the API limiter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizPublicError" } } } } } } }, "/api/quiz/claim/request": { "post": { "tags": [ "Quiz" ], "summary": "Email a quiz result claim link", "operationId": "8dbadd7735f01358087f40dba94aeff6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimRequest" } } } }, "responses": { "200": { "description": "Claim link sent", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimRequestSuccess" } } } }, "403": { "description": "Untrusted claim host", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "404": { "description": "Session not found", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "422": { "description": "Quiz is not claimable", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "429": { "description": "Rate limited", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } }, "Retry-After": { "schema": { "description": "Seconds to wait before retrying", "type": "integer", "minimum": 1 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimRequestRateLimited" } } } }, "500": { "description": "Unexpected error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } } } } }, "/api/quiz/claim/verify": { "get": { "tags": [ "Quiz" ], "summary": "Verify a signed quiz claim link", "operationId": "f88fd52f2f305377bf0242238471da31", "parameters": [ { "name": "archetype_session", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/QuizClaimVerifyQuery/properties/archetype_session" } }, { "name": "season_session", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/QuizClaimVerifyQuery/properties/season_session" } }, { "name": "claim_email_hash", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/QuizClaimVerifyQuery/properties/claim_email_hash" } }, { "name": "claim_nonce", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/QuizClaimVerifyQuery/properties/claim_nonce" } }, { "name": "expires", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/QuizClaimVerifyQuery/properties/expires" } }, { "name": "signature", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/QuizClaimVerifyQuery/properties/signature" } } ], "responses": { "200": { "description": "Verification token issued", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimVerifySuccess" } } } }, "403": { "description": "Invalid claim link", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "405": { "description": "Claim verification does not support HEAD", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "429": { "description": "Rate limited by the API limiter", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "500": { "description": "Unexpected error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } } } } }, "/api/quiz/claim/confirm": { "post": { "tags": [ "Quiz" ], "summary": "Confirm a quiz result claim", "operationId": "d6db97076d19f3b215bc3ab8e84f2956", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimConfirmRequest" } } } }, "responses": { "200": { "description": "Quiz results claimed", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimConfirmSuccess" } } } }, "403": { "description": "Untrusted host or MFA sign-in required", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "410": { "description": "Verification token expired or consumed", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "422": { "description": "Claim cannot be completed", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "429": { "description": "Rate limited", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } }, "500": { "description": "Unexpected error", "headers": { "Cache-Control": { "schema": { "type": "string", "example": "no-store, private" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuizClaimError" } } } } } } }, "/api/user/collections": { "get": { "tags": [ "SavedCollection" ], "summary": "Get a listing of the SavedCollections.", "description": "Get all SavedCollections", "operationId": "2a2bb3639a6bc8bcc92ec78831ba77e0", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "type": "object" } }, "path": { "type": "string" }, "per_page": { "type": "integer" }, "next_cursor": { "type": "string", "nullable": true }, "next_page_url": { "type": "string", "nullable": true }, "prev_cursor": { "type": "string", "nullable": true }, "prev_page_url": { "type": "string", "nullable": true } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "SavedCollection" ], "summary": "Store a newly created SavedCollection in storage", "description": "Store SavedCollection", "operationId": "aeee958e13663692cbc9e9ced9fd633c", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/collections/{collection}": { "get": { "tags": [ "SavedCollection" ], "summary": "Display the specified SavedCollection", "description": "Get SavedCollection", "operationId": "e1bb9a5b2e3bff1df217ed963b5177c1", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "SavedCollection" ], "summary": "Update the specified SavedCollection in storage", "description": "Update SavedCollection", "operationId": "5ed284f5b6ae41a9c0a2ba7401fcef84", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "SavedCollection" ], "summary": "Remove the specified SavedCollection from storage", "description": "Delete SavedCollection", "operationId": "1e1245827d7fa5f0cf1a32e3b5619338", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "SavedCollection" ], "summary": "Update the specified SavedCollection in storage", "description": "Update SavedCollection", "operationId": "d6e5a44fbe785c995da1d7b98017848e", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/collections/{collection}/items": { "get": { "tags": [ "SavedCollectionItem" ], "summary": "Get a listing of the SavedCollectionItems.", "description": "Get all SavedCollectionItems", "operationId": "d52eaf01aef81238ec079e8af58d52a5", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "SavedCollectionItem" ], "summary": "Store a newly created SavedCollectionItem in storage", "description": "Store SavedCollectionItem", "operationId": "7267eab49feefc21f6f9c85aba39e0f2", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/collections/{collection}/items/{item}": { "get": { "tags": [ "SavedCollectionItem" ], "summary": "Display the specified SavedCollectionItem", "description": "Get SavedCollectionItem", "operationId": "5f7a1cfac784bcda742bc80d023d5029", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } }, { "name": "item", "in": "path", "description": "id of SavedCollectionItem", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "SavedCollectionItem" ], "summary": "Update the specified SavedCollectionItem in storage", "description": "Update SavedCollectionItem", "operationId": "79f3a53dce78156c60d839a7c291d7e0", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } }, { "name": "item", "in": "path", "description": "id of SavedCollectionItem", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "SavedCollectionItem" ], "summary": "Remove the specified SavedCollectionItem from storage", "description": "Delete SavedCollectionItem", "operationId": "5d3a1a6c57d47eb2abfcffaf902be56a", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } }, { "name": "item", "in": "path", "description": "id of SavedCollectionItem", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "SavedCollectionItem" ], "summary": "Update the specified SavedCollectionItem in storage", "description": "Update SavedCollectionItem", "operationId": "c316e9e65fbebf90a80c7b704c7d852d", "parameters": [ { "name": "collection", "in": "path", "description": "id of SavedCollection", "required": true, "schema": { "type": "integer" } }, { "name": "item", "in": "path", "description": "id of SavedCollectionItem", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/shared-items/index-config": { "get": { "tags": [ "SharedItem" ], "summary": "Get SharedItem index configuration", "description": "Class SharedItemController", "operationId": "bbcdf537b0c0f53da6b9eed6a9120140", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/shared-items": { "get": { "tags": [ "SharedItem" ], "summary": "List SharedItems", "operationId": "e505b6768a2703c96853a467e80a88a9", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/shared-items/{shared_item}": { "get": { "tags": [ "SharedItem" ], "summary": "Get a SharedItem", "operationId": "16758d2edcf141ca0283f6b1140f5661", "parameters": [ { "name": "shared_item", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/shared-items/{shared_item}/status": { "post": { "tags": [ "SharedItemStatus" ], "summary": "createSharedItemStatus", "description": "Create SharedItemStatus", "operationId": "8b50a060ad6c05dde44136c9c7f1ede0", "parameters": [ { "name": "shared_item", "in": "path", "description": "id of SharedItem", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "shared_item_id", "user_id" ], "properties": { "shared_item_id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_read": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/shared-items/{shared_item}/status/{status}": { "put": { "tags": [ "SharedItemStatus" ], "summary": "updateSharedItemStatus", "description": "Update SharedItemStatus", "operationId": "1beafd7c23b7c01632dd65eec63123da", "parameters": [ { "name": "shared_item", "in": "path", "description": "id of SharedItem", "required": true, "schema": { "type": "integer" } }, { "name": "status", "in": "path", "description": "id of SharedItemStatus", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "shared_item_id", "user_id" ], "properties": { "shared_item_id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_read": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "SharedItemStatus" ], "summary": "updateSharedItemStatus", "description": "Update SharedItemStatus", "operationId": "b71b2979c163c4507ad555f7af97d84a", "parameters": [ { "name": "shared_item", "in": "path", "description": "id of SharedItem", "required": true, "schema": { "type": "integer" } }, { "name": "status", "in": "path", "description": "id of SharedItemStatus", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "shared_item_id", "user_id" ], "properties": { "shared_item_id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_read": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions": { "get": { "tags": [ "Subscription" ], "summary": "List subscriptions", "description": "Class SubscriptionController", "operationId": "1cfb7d063b19b4c90a40625a90432f3e", "responses": { "200": { "description": "Subscriptions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Subscription" ], "summary": "Create a subscription payment intent", "operationId": "13f2e43a80be5468e3570ab2a2874c93", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "product_id" ], "properties": { "product_id": { "type": "integer" }, "interval": { "type": "string", "enum": [ "month", "year" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Payment intent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/form-config": { "get": { "tags": [ "Subscription" ], "summary": "Get subscription form configuration", "operationId": "662dcb61097f1aa42d4da5ab9a628dfe", "responses": { "200": { "description": "Products with media", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/checkout": { "post": { "tags": [ "Subscription" ], "summary": "Start subscription checkout", "operationId": "5dd3225888615cccafd0be14f67e25e7", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "product_id" ], "properties": { "product_id": { "type": "integer" }, "interval": { "type": "string", "enum": [ "month", "year" ] }, "upgrade": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Checkout URL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/refund/{subscription}": { "post": { "tags": [ "Subscription" ], "summary": "Refund an owned subscription", "description": "Available to the subscription owner or an existing admin.", "operationId": "f6bd8e7558a897e165f695dcff9880ab", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription refunded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "403": { "description": "Not the owner or an admin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/my": { "get": { "tags": [ "Subscription" ], "summary": "Get current subscription", "operationId": "7a3e973c4ac203ebcb5d37c8888523bf", "responses": { "200": { "description": "Current subscription and payment details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/cancel/{subscription}": { "put": { "tags": [ "Subscription" ], "summary": "Cancel an owned subscription", "description": "Available to the subscription owner or an existing admin. cancel_now is a boolean.", "operationId": "c6e0d1d12df101e3273b49b930c82ccd", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "cancel_now": { "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Subscription canceled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "403": { "description": "Not the owner or an admin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "422": { "description": "cancel_now must be boolean", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/resume/{subscription}": { "put": { "tags": [ "Subscription" ], "summary": "Resume an owned subscription", "description": "Available to the subscription owner or an existing admin.", "operationId": "05e18b702cbc79e9886f205fc85e2613", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription resumed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "403": { "description": "Not the owner or an admin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/payment-method/{id}/default": { "put": { "tags": [ "Subscription" ], "summary": "Set default payment method", "operationId": "3e7121b56d6722097f9677fdf80ff99c", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment method updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/payment-method/{id}/default/{subscriptionId}": { "put": { "tags": [ "Subscription" ], "summary": "Set subscription payment method", "operationId": "18a0196c0f6ed3060d486f2a44039215", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Payment method updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/payment-method/{id}": { "delete": { "tags": [ "Subscription" ], "summary": "Delete payment method", "operationId": "2b19e11d37e1315d08d6d6b2169073ce", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Payment method deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/payment-method": { "post": { "tags": [ "Subscription" ], "summary": "Add payment method", "operationId": "c1acb7c82cee871614e8343e3d0896bc", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "payment_method" ], "properties": { "payment_method": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Payment method added", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/payment-method/setup-intent": { "post": { "tags": [ "Subscription" ], "summary": "Create payment method setup intent", "operationId": "24f75147fabed8a90593235ed1597b16", "responses": { "200": { "description": "Setup intent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/{subscription}": { "get": { "tags": [ "Subscription" ], "summary": "Get an owned subscription", "description": "Available to the subscription owner or an existing admin. Stripe identifiers are not returned.", "operationId": "66fb703fa8ff0c54007fd90ab2207dae", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "403": { "description": "Not the owner or an admin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Subscription" ], "summary": "Delete an owned subscription", "description": "Available to the subscription owner or an existing admin.", "operationId": "fb5d490c4c5f271ea2cca676a461d011", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "403": { "description": "Not the owner or an admin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/subscriptions/{contentType}/{contentId}": { "get": { "tags": [ "Subscription" ], "summary": "List subscriptions for content", "operationId": "0890cd5b618241be05a705f139fea64a", "parameters": [ { "name": "contentType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Subscription" ], "summary": "Create a subscription for content", "operationId": "073de99a4ed5f477045c6e9e3c24700a", "parameters": [ { "name": "contentType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/subscriptions": { "get": { "tags": [ "Subscription" ], "summary": "List user subscriptions", "operationId": "6f6e5b8869b3201e17f3a11313ed549e", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Subscription" ], "summary": "Create a user subscription", "operationId": "7749af153d45eee8d89323693c196160", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/subscriptions/{subscription}": { "get": { "tags": [ "Subscription" ], "summary": "Get a user subscription", "operationId": "6ab5a861a43bdcd14992e8512937af94", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Subscription" ], "summary": "Update a user subscription", "operationId": "d688fa47d6655b28f9457c0f45b35d74", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Subscription" ], "summary": "Delete a user subscription", "operationId": "4cad2b47d56c8c7a099653a0f92c9f56", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Subscription" ], "summary": "Update a user subscription", "operationId": "00618d3b17c7ac7240c18b360f67aa4c", "parameters": [ { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/items": { "get": { "tags": [ "SubscriptionItem" ], "summary": "List subscription items", "description": "Class SubscriptionItemController", "operationId": "44c19c29f3581ea90fe42e6602146fac", "parameters": [ { "name": "subscription_id", "in": "query", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription items", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "SubscriptionItem" ], "summary": "Direct creation is disabled", "description": "Subscription items are created only by Stripe/Cashier.", "operationId": "ec61c599a60b1a959c81a74755e55dac", "responses": { "403": { "description": "Direct subscription-item creation is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/subscriptions/items/{item}": { "get": { "tags": [ "SubscriptionItem" ], "summary": "Get a subscription item", "operationId": "0072ec4b7d312e0349a9cf517fcef21a", "parameters": [ { "name": "item", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "subscription_id", "in": "query", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "SubscriptionItem" ], "summary": "Update subscription item quantity", "operationId": "5b6f2bfb6ab1e7376da6953af4e31b97", "parameters": [ { "name": "item", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "subscription_id" ], "properties": { "subscription_id": { "type": "integer" }, "quantity": { "type": "integer", "minimum": 1, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Subscription item updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "SubscriptionItem" ], "summary": "Delete a subscription item", "operationId": "1005caeb1b3e6d1f716cc995c6919509", "parameters": [ { "name": "item", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "subscription_id", "in": "query", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Subscription item deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "SubscriptionItem" ], "summary": "Update subscription item quantity", "operationId": "557822c5710cdf7af4c367469932a8b6", "parameters": [ { "name": "item", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "subscription_id" ], "properties": { "subscription_id": { "type": "integer" }, "quantity": { "type": "integer", "minimum": 1, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Subscription item updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/teams": { "post": { "tags": [ "Team" ], "summary": "Create a team", "description": "Create a team\nInvite a teammember using the JetStream Action", "operationId": "26bd90639dc40a73e4001244e9ec5542", "responses": { "200": { "description": "Team created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/teams/{team}": { "get": { "tags": [ "Team" ], "summary": "Get a team", "description": "Get the given team", "operationId": "77abc6750be78eef897214b1e6935408", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "Team" ], "summary": "Update a team", "operationId": "e0970cd0f25ccbed45ed47d0f3cbef70", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team saved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Team" ], "summary": "Update a team", "description": "Update the given team's name.", "operationId": "2219df117b1a7afbc217115e3b0ff550", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team saved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "Team" ], "summary": "Delete a team", "description": "Destroy the given team.", "operationId": "ff354f9ba092b5773ed74f1ecdf2be5f", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team deleted successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "Team" ], "summary": "Update a team", "operationId": "035f504f6862a9c1636293e9fee1d747", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team saved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/teams/{team}/invitations": { "get": { "tags": [ "TeamInvitation" ], "summary": "List a team's invitations", "operationId": "1568cdb585cf55b94371459f1428f730", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated invitations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Not authorized to view team invitations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Team not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "TeamInvitation" ], "summary": "Invite a user to a team", "operationId": "941f2edebe588857f94db172c9fd851b", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "email": { "description": "Invitee email; no request-level validation rule is defined", "type": "string", "format": "email" }, "role": { "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Invitation created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Not authorized to add team members", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Team not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid role", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/teams/{team}/invitations/{invitation}/accept": { "put": { "tags": [ "TeamInvitation" ], "summary": "Accept a team invitation (PUT alias)", "operationId": "86dd725fbed85de7045ff2d85a73942b", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "invitation", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "expires", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "signature", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invitation accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Invalid signature or invitation cannot be accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Team or invitation not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid invitation update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "TeamInvitation" ], "summary": "Accept a team invitation", "operationId": "0f16798d27ea2f03bc51ede178e630ba", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "invitation", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "expires", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "signature", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invitation accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Invalid signature or invitation cannot be accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Team or invitation not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid invitation update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/teams/{team}/invitations/{invitation}": { "delete": { "tags": [ "TeamInvitation" ], "summary": "Delete a team invitation", "operationId": "ce1b25bad5aa3b7ed08fe36882e4985d", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "invitation", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Invitation deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "403": { "description": "Not authorized to delete invitation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } }, "404": { "description": "Team or invitation not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/public/invitations/{id}": { "get": { "tags": [ "TeamInvitation" ], "summary": "Get public invitation details", "operationId": "7186fb4a6781e8b010a12ca60edb4183", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Invitation email, team, and token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "404": { "description": "Invitation not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } }, "/api/teams/{team}/members": { "get": { "tags": [ "TeamMember" ], "summary": "List team members", "description": "List team members for the given team", "operationId": "5e7c25d8f7d24ce8644b006af89af829", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team members retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/teams/{team}/members/{user}": { "post": { "tags": [ "TeamMember" ], "summary": "Update a team member", "description": "Update the given team member's role.", "operationId": "4983ae90cd08800882879a25bc1ca34a", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team member updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/teams/{team}/members/{member}": { "put": { "tags": [ "TeamMember" ], "summary": "Update a team member", "operationId": "dd79bde9d42e19e662a22054efa1aee7", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "member", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team member updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "TeamMember" ], "summary": "Remove a team member", "description": "Remove the given user from the given team.", "operationId": "fcd168ba3d1e8c68b7db0ace467549d3", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "member", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team member removed successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "302": { "description": "Redirect when the authenticated user removes themselves" } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "TeamMember" ], "summary": "Update a team member", "operationId": "f7bded1404ba79597db05e030bfc23a2", "parameters": [ { "name": "team", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "member", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Team member updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/public/team/{id}": { "get": { "tags": [ "TeamProfile" ], "summary": "getTeamProfileItem", "description": "Get TeamProfile", "operationId": "3342cf1ed9b2074675feb78b64013ec9", "parameters": [ { "name": "id", "in": "path", "description": "id of TeamProfile", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/api/payments/transactions": { "get": { "tags": [ "Payment" ], "summary": "List payment transactions", "description": "Class SocialProviderController\n\nUsed for documentation only!", "operationId": "8a9e0eb43ca3d3ea90f4b0ac2c7397a2", "responses": { "200": { "description": "Transactions", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "Payment" ], "summary": "Create a payment intent", "operationId": "6cef4b261b45cefa7dae1a6e28365845", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "product_id" ], "properties": { "product_id": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Payment intent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/form-config": { "get": { "tags": [ "Payment" ], "summary": "Get payment form configuration", "operationId": "245d853a8abda7520ed2ac40d2542c2e", "responses": { "200": { "description": "Products with media", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/transactions/refund/{transaction}": { "post": { "tags": [ "Payment" ], "summary": "Refund an owned transaction", "description": "Available to the transaction owner or an existing admin.", "operationId": "bd8447630bbfeea945e45f593e6868c5", "parameters": [ { "name": "transaction", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Transaction refunded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "403": { "description": "Not the owner or an admin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/gift/{user}": { "post": { "tags": [ "Payment" ], "summary": "Gift points", "operationId": "51c303b4805d134d769f136579f05890", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "amount" ], "properties": { "amount": { "type": "integer", "minimum": 1000 } }, "type": "object" } } } }, "responses": { "200": { "description": "Points gifted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/payments/gift": { "post": { "tags": [ "Payment" ], "summary": "Gift points", "operationId": "f1ddb4107170df76422e6bae8fab867f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "user", "amount" ], "properties": { "user": { "type": "integer" }, "amount": { "type": "integer", "minimum": 1000 } }, "type": "object" } } } }, "responses": { "200": { "description": "Points gifted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/trending": { "get": { "tags": [ "Trending" ], "summary": "Get a listing of the TrendingTags.", "description": "Get all TrendingTags", "operationId": "84b4069163be8d95212c912ca984779b", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/trending/{tag}": { "get": { "tags": [ "Trending" ], "summary": "Display the specified TrendingTag", "description": "Get TrendingTag", "operationId": "4596ebab8fbd025a3b80bc17c891934f", "parameters": [ { "name": "tag", "in": "path", "description": "id of TrendingTag", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/users": { "get": { "tags": [ "User" ], "summary": "List users", "operationId": "533798e54affa73f110f43d55186c5eb", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/users/{user}": { "get": { "tags": [ "User" ], "summary": "Get a user", "operationId": "7c2b4660be409d117c8cf08e341f28cd", "parameters": [ { "name": "user", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me": { "get": { "tags": [ "User" ], "summary": "Get the authenticated user", "operationId": "db5d660fb437a37a7fe9ed3fe208e80f", "responses": { "200": { "description": "Authenticated user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "User" ], "summary": "Update the authenticated user", "operationId": "2e6606201e61375c3e9801fc67a3051d", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "photo": { "type": "string", "format": "binary" }, "avatar": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Updated user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Invalid update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "User" ], "summary": "Update the authenticated user (POST alias)", "operationId": "68fe2d7579f91e0d7ac8fc3802606f1d", "requestBody": { "$ref": "#/components/requestBodies/UserUpdateRequest" }, "responses": { "200": { "description": "Updated user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Invalid update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me/form-config": { "get": { "tags": [ "User" ], "summary": "Get authenticated user form configuration", "operationId": "6891f9acb763bf180469ce0ade6e9eb1", "responses": { "200": { "description": "Form configuration", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me/{id}": { "put": { "tags": [ "User" ], "summary": "Update the authenticated user (legacy alias)", "operationId": "eca9197a7f6aa8e26a5d8173218d56c9", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/UserUpdateRequest" }, "responses": { "200": { "description": "Updated authenticated user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Invalid update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "User" ], "summary": "Update the authenticated user (legacy POST alias)", "operationId": "0ae90566d88501df6cb9e2f425911571", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/UserUpdateRequest" }, "responses": { "200": { "description": "Updated authenticated user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "Invalid update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me/init-braze": { "put": { "tags": [ "User" ], "summary": "Mark Braze as initialized", "operationId": "8444c3e0afb54f3c4270f9a8e93c7043", "responses": { "200": { "description": "Braze initialized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me/communication-tokens": { "post": { "tags": [ "User" ], "summary": "Create or update an FCM communication token", "description": "Currently fails before controller execution: CreateCommunicationTokenAPIRequest references an undeclared CommunicationToken::$rules property.", "operationId": "5b7a3391359373fd66417cf9df52c0c5", "responses": { "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Request validation cannot resolve CommunicationToken::$rules", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me/communication-tokens/{type}": { "post": { "tags": [ "User" ], "summary": "Create or update a communication token", "description": "Currently fails before controller execution: CreateCommunicationTokenAPIRequest references an undeclared CommunicationToken::$rules property.", "operationId": "171b2e33b88b978c53812ff51cabdb17", "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "default": "fcm" } } ], "responses": { "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "500": { "description": "Request validation cannot resolve CommunicationToken::$rules", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me/communication-tokens/{token}": { "delete": { "tags": [ "User" ], "summary": "Delete a communication token", "operationId": "028d8054d6eb8321e81d0b550fa12df7", "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Boolean data is false when the token does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/auth/me/invitations": { "get": { "tags": [ "TeamInvitation" ], "summary": "List invitations addressed to the authenticated user", "operationId": "28bb45258cfb2a16735353619cedab19", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated invitations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/persona": { "get": { "tags": [ "User" ], "summary": "Get the authenticated consumer persona", "description": "Consumer-only. Returns a complete safe persona or null; it never returns partial persona data.", "operationId": "23b2f1f03949847a3744a25d93ba3d55", "responses": { "200": { "description": "Persona retrieved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPersonaSuccess" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPersonaUnauthorizedResponse" } } } }, "403": { "description": "Consumer role required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPersonaForbiddenResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/interests": { "get": { "tags": [ "UserInterest" ], "summary": "List user interests", "operationId": "1a4e6b11ee88c0d70099c2b38506390c", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated user interests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "post": { "tags": [ "UserInterest" ], "summary": "Create a user interest", "operationId": "6967be3401777ff637de260ca044f61e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "interest_id" ], "properties": { "interest_id": { "type": "integer" }, "interest_type": { "type": "string", "maxLength": 255 } }, "type": "object" } } } }, "responses": { "200": { "description": "Created user interest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "422": { "description": "interest_id is required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/interests/{interest}": { "get": { "tags": [ "UserInterest" ], "summary": "Get a user interest", "operationId": "e0627baa5c48cfbc7bf819afda1ede57", "parameters": [ { "name": "interest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "User interest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "User interest not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "UserInterest" ], "summary": "Update a user interest", "operationId": "5dae9b25d959ae51fd44f69caecd5e5d", "parameters": [ { "name": "interest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "interest_id" ], "properties": { "interest_id": { "type": "integer" }, "interest_type": { "type": "string", "maxLength": 255 } }, "type": "object" } } } }, "responses": { "200": { "description": "Updated user interest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "User interest not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "interest_id is required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "delete": { "tags": [ "UserInterest" ], "summary": "Delete a user interest", "operationId": "88e23ff0e037bf1ed320f03da3852a17", "parameters": [ { "name": "interest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Boolean deletion result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "User interest not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "UserInterest" ], "summary": "Update a user interest (PATCH alias)", "operationId": "955415fb0049d7a63979c13744d3d485", "parameters": [ { "name": "interest", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "interest_id" ], "properties": { "interest_id": { "type": "integer" }, "interest_type": { "type": "string", "maxLength": 255 } }, "type": "object" } } } }, "responses": { "200": { "description": "Updated user interest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "User interest not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "interest_id is required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/users/profiles": { "get": { "tags": [ "UserProfile" ], "summary": "List user profiles", "operationId": "afa04d18490a082a700a3ad6d536e43a", "parameters": [ { "name": "type", "in": "query", "description": "Use consumers for consumer profiles; all other values return public, approved professional profiles", "schema": { "type": "string", "enum": [ "consumers" ] } }, { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "perPage", "in": "query", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Paginated profiles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedResponse" } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/users/profiles/{profile}": { "get": { "tags": [ "UserProfile" ], "summary": "Get a user profile", "operationId": "bc11d93ba2facb00e2dcea7ec7c742b8", "parameters": [ { "name": "profile", "in": "path", "description": "User ID, username, or email", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Profile", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SuccessResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/UserProfile" } }, "type": "object" } ] } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Eligible profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/users/profiles/index-config": { "get": { "tags": [ "UserProfile" ], "summary": "Get user profile index configuration", "operationId": "94258e23a76731c9c7d90c75e0d027de", "responses": { "200": { "description": "Index configuration", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "data": { "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/api/user/me/{me}": { "get": { "tags": [ "UserProfile" ], "summary": "Get a profile through the authenticated profile route", "operationId": "b68ebfe04c32b5a7145cf2e1db8a9c43", "parameters": [ { "name": "me", "in": "path", "description": "User ID, username, or email", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Profile", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SuccessResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/UserProfile" } }, "type": "object" } ] } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Eligible profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "put": { "tags": [ "UserProfile" ], "summary": "Update a profile through the authenticated profile route", "operationId": "d731e2ec77e1118226cbe24b1ea4ef33", "parameters": [ { "name": "me", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "user_id", "is_public" ], "properties": { "user_id": { "type": "integer" }, "is_public": { "type": "boolean" }, "bio": { "type": "string", "nullable": true }, "dob": { "type": "string", "format": "date", "nullable": true }, "linkedin_url": { "type": "string", "format": "uri", "nullable": true }, "video_url": { "type": "string", "format": "uri", "nullable": true }, "website_url": { "type": "string", "format": "uri", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Updated profile", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SuccessResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/UserProfile" } }, "type": "object" } ] } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "user_id and is_public are required; URLs must be valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] }, "patch": { "tags": [ "UserProfile" ], "summary": "Update a profile through the authenticated profile route (PATCH alias)", "operationId": "f9a1b187bed40cfc5758ec0a5382bd7d", "parameters": [ { "name": "me", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/UserProfileUpdateRequest" }, "responses": { "200": { "description": "Updated profile", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SuccessResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/UserProfile" } }, "type": "object" } ] } } } }, "401": { "description": "Unauthenticated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedResponse" } } } }, "404": { "description": "Profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } }, "422": { "description": "Invalid profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "429": { "description": "Rate limited", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "bearer_token": [] } ] } }, "/public/user/{id}": { "get": { "tags": [ "UserProfile" ], "summary": "Get a public user profile", "operationId": "acd773843b9f071a00286c2824420655", "parameters": [ { "name": "id", "in": "path", "description": "User ID, username, or email", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Profile; authenticated callers receive additional role-specific relations", "content": { "application/json": { "schema": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/SuccessResponse" }, { "properties": { "data": { "$ref": "#/components/schemas/UserProfile" } }, "type": "object" } ] } } } }, "404": { "description": "Eligible profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundResponse" } } } } } } } }, "components": { "schemas": { "ConsumerOnboardingChoiceOption": { "required": [ "id", "label" ], "properties": { "id": { "description": "Canonical catalog identity; IDs are not portable between environments", "type": "integer", "minimum": 1 }, "label": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ConsumerOnboardingChoiceField": { "required": [ "multiple", "options" ], "properties": { "multiple": { "description": "Whether the answer supports multiple selections", "type": "boolean" }, "options": { "description": "Finite canonical choices in catalog order", "type": "array", "items": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceOption" } }, "requires_business_owner": { "description": "Present only for business_stage_id", "type": "boolean", "enum": [ true ] }, "occurrences": { "description": "Present only for life_events", "type": "boolean", "enum": [ true ] }, "supports_other": { "description": "Present only for preferred_language", "type": "boolean", "enum": [ true ] }, "supports_no_preference": { "description": "Present only for preferred_language", "type": "boolean", "enum": [ true ] } }, "type": "object", "additionalProperties": false }, "ConsumerOnboardingChoiceFields": { "required": [ "professional_specialty_ids", "business_stage_id", "current_support_ids", "investment_range_id", "emergency_savings_range_id", "financial_need_ids", "life_events", "fee_transparency_preference_id", "fee_structure_preference_id", "meeting_format_ids", "preferred_language" ], "properties": { "professional_specialty_ids": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "business_stage_id": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "current_support_ids": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "investment_range_id": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "emergency_savings_range_id": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "financial_need_ids": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "life_events": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "fee_transparency_preference_id": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "fee_structure_preference_id": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "meeting_format_ids": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" }, "preferred_language": { "$ref": "#/components/schemas/ConsumerOnboardingChoiceField" } }, "type": "object", "additionalProperties": false }, "QuizClaimRequestData": { "required": [ "ok", "sent_at" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "sent_at": { "type": "string", "format": "date-time" } }, "type": "object", "additionalProperties": false }, "QuizClaimVerifyData": { "required": [ "verify_token", "email_hint", "authentication_mode", "registration_required" ], "properties": { "verify_token": { "type": "string", "maxLength": 255, "minLength": 32 }, "email_hint": { "type": "string" }, "authentication_mode": { "type": "string", "enum": [ "magic_link", "authenticated" ] }, "registration_required": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "QuizClaimRole": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "type": "object", "additionalProperties": true }, "QuizClaimUser": { "required": [ "id", "name", "email", "profile", "role", "team", "is_consumer", "is_verified" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "format": "email" }, "profile": { "type": "object", "nullable": true }, "role": { "$ref": "#/components/schemas/QuizClaimRole" }, "team": { "type": "object", "nullable": true }, "is_consumer": { "type": "boolean", "enum": [ true ] }, "is_verified": { "type": "boolean", "enum": [ true ] } }, "type": "object", "additionalProperties": true }, "QuizClaimPersona": { "required": [ "archetype", "season", "posture" ], "properties": { "archetype": { "type": "string" }, "season": { "type": "string" }, "posture": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizClaimConfirmAuthenticatedData": { "required": [ "user", "persona", "attached", "requires_two_factor" ], "properties": { "user": { "$ref": "#/components/schemas/QuizClaimUser" }, "token": { "description": "Issued for magic_link; omitted for authenticated mode", "type": "string", "nullable": true }, "persona": { "$ref": "#/components/schemas/QuizClaimPersona" }, "attached": { "type": "boolean", "enum": [ true ] }, "requires_two_factor": { "type": "boolean", "enum": [ false ] } }, "type": "object", "additionalProperties": false }, "QuizClaimRequestSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizClaimRequestData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizClaimVerifySuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizClaimVerifyData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizClaimConfirmSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizClaimConfirmAuthenticatedData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizQuestionOption": { "required": [ "key", "label" ], "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true } }, "type": "object", "additionalProperties": false }, "QuizArchetypeQuestion": { "required": [ "slug", "theme", "prompt", "options" ], "properties": { "slug": { "type": "string" }, "theme": { "type": "string", "nullable": true }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/QuizQuestionOption" } } }, "type": "object", "additionalProperties": false }, "QuizSeasonQuestion": { "required": [ "slug", "signal", "prompt", "options" ], "properties": { "slug": { "type": "string" }, "signal": { "type": "string", "nullable": true }, "prompt": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/QuizQuestionOption" } } }, "type": "object", "additionalProperties": false }, "QuizMetadata": { "required": [ "name", "icon", "color", "tags", "summary", "description", "description_short" ], "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" }, "description": { "type": "string" }, "description_short": { "description": "Backward-compatible alias of summary", "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizPosturePublic": { "required": [ "id", "archetype_slug", "season_slug", "title", "description", "strengths", "growth_areas", "quotes", "matched_professionals", "professional_needs_to" ], "properties": { "id": { "type": "integer", "format": "int64" }, "archetype_slug": { "type": "string" }, "season_slug": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "strengths": { "type": "array", "items": { "type": "object" } }, "growth_areas": { "type": "array", "items": { "type": "object" } }, "quotes": { "type": "array", "items": { "type": "string" } }, "matched_professionals": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" } }, "professional_needs_to": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "QuizTaxonomyContext": { "required": [ "slug", "name", "summary", "description", "icon", "color", "tags", "postures" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "postures": { "type": "array", "items": { "$ref": "#/components/schemas/QuizPosturePublic" } } }, "type": "object", "additionalProperties": false }, "QuizArchetypeScores": { "required": [ "explorer", "builder", "optimizer", "protector", "architect" ], "properties": { "explorer": { "type": "number", "format": "float" }, "builder": { "type": "number", "format": "float" }, "optimizer": { "type": "number", "format": "float" }, "protector": { "type": "number", "format": "float" }, "architect": { "type": "number", "format": "float" } }, "type": "object", "additionalProperties": false }, "QuizSeasonScores": { "required": [ "recovering", "building", "stabilizing", "expanding" ], "properties": { "recovering": { "type": "number", "format": "float" }, "building": { "type": "number", "format": "float" }, "stabilizing": { "type": "number", "format": "float" }, "expanding": { "type": "number", "format": "float" } }, "type": "object", "additionalProperties": false }, "QuizPublicError": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "string", "enum": [ null ], "nullable": true }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object", "additionalProperties": false }, "QuizClaimError": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "string", "enum": [ null ], "nullable": true }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizClaimRequestRateLimited": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "required": [ "retry_after_seconds" ], "properties": { "retry_after_seconds": { "type": "integer", "minimum": 1 } }, "type": "object", "additionalProperties": false }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeStartData": { "required": [ "session_id", "current_question", "total_questions", "answered_question_slugs", "is_complete" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "current_question": { "oneOf": [ { "$ref": "#/components/schemas/QuizArchetypeQuestion" } ], "nullable": true }, "total_questions": { "type": "integer", "minimum": 1 }, "answered_question_slugs": { "type": "array", "items": { "type": "string" } }, "is_complete": { "type": "boolean" }, "archetype_metadata": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuizMetadata" } } }, "type": "object", "additionalProperties": false }, "QuizSeasonStartData": { "required": [ "session_id", "current_question", "total_questions", "answered_question_slugs", "is_complete" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "current_question": { "oneOf": [ { "$ref": "#/components/schemas/QuizSeasonQuestion" } ], "nullable": true }, "total_questions": { "type": "integer", "minimum": 1 }, "answered_question_slugs": { "type": "array", "items": { "type": "string" } }, "is_complete": { "type": "boolean" }, "season_metadata": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuizMetadata" } } }, "type": "object", "additionalProperties": false }, "QuizArchetypeSessionData": { "required": [ "session", "session_id", "current_question", "total_questions", "answered_question_slugs", "is_complete" ], "properties": { "session": { "required": [ "session_id" ], "properties": { "session_id": { "type": "string", "format": "uuid" } }, "type": "object", "additionalProperties": false }, "session_id": { "type": "string", "format": "uuid" }, "current_question": { "oneOf": [ { "$ref": "#/components/schemas/QuizArchetypeQuestion" } ], "nullable": true }, "total_questions": { "type": "integer" }, "answered_question_slugs": { "type": "array", "items": { "type": "string" } }, "is_complete": { "type": "boolean" }, "archetype_metadata": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuizMetadata" } } }, "type": "object", "additionalProperties": false }, "QuizSeasonSessionData": { "required": [ "session", "session_id", "current_question", "total_questions", "answered_question_slugs", "is_complete" ], "properties": { "session": { "required": [ "session_id" ], "properties": { "session_id": { "type": "string", "format": "uuid" } }, "type": "object", "additionalProperties": false }, "session_id": { "type": "string", "format": "uuid" }, "current_question": { "oneOf": [ { "$ref": "#/components/schemas/QuizSeasonQuestion" } ], "nullable": true }, "total_questions": { "type": "integer" }, "answered_question_slugs": { "type": "array", "items": { "type": "string" } }, "is_complete": { "type": "boolean" }, "season_metadata": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/QuizMetadata" } } }, "type": "object", "additionalProperties": false }, "QuizArchetypeAnswerData": { "properties": { "session_id": { "type": "string", "format": "uuid" }, "scores": { "$ref": "#/components/schemas/QuizArchetypeScores" }, "next_question": { "oneOf": [ { "$ref": "#/components/schemas/QuizArchetypeQuestion" } ], "nullable": true }, "is_complete": { "type": "boolean" }, "secondary": { "type": "string", "nullable": true } }, "type": "object", "additionalProperties": false }, "QuizSeasonAnswerData": { "properties": { "session_id": { "type": "string", "format": "uuid" }, "scores": { "$ref": "#/components/schemas/QuizSeasonScores" }, "next_question": { "oneOf": [ { "$ref": "#/components/schemas/QuizSeasonQuestion" } ], "nullable": true }, "is_complete": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeResultData": { "required": [ "session_id", "scores", "archetype_result", "archetype" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "scores": { "$ref": "#/components/schemas/QuizArchetypeScores" }, "archetype_result": { "type": "string", "enum": [ "explorer", "builder", "optimizer", "protector", "architect" ] }, "secondary": { "type": "string", "nullable": true }, "archetype": { "oneOf": [ { "$ref": "#/components/schemas/QuizTaxonomyContext" } ], "nullable": true }, "assignments_attached": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "QuizSeasonResultData": { "required": [ "session_id", "scores", "season_result", "season" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "scores": { "$ref": "#/components/schemas/QuizSeasonScores" }, "season_result": { "type": "string", "enum": [ "recovering", "building", "stabilizing", "expanding" ] }, "season": { "oneOf": [ { "$ref": "#/components/schemas/QuizTaxonomyContext" } ], "nullable": true }, "assignments_attached": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "QuizSeasonLockedTaxonomy": { "description": "Presentation-only season identity for a locked anonymous result: no summary, description, tags, or postures.", "required": [ "name", "icon", "color" ], "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeLockedTaxonomy": { "description": "Presentation-only archetype identity for a locked anonymous result: name, icon, color, tags, and summary for the reveal card. No description, postures, scores, or secondary.", "required": [ "name", "icon", "color", "tags", "summary" ], "properties": { "name": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeLockedResultData": { "description": "Anonymous result before a successful claim request: identity only (archetype: name, icon, color, tags, summary; season: name, icon, color); no scores, secondary, slug, description, or postures.", "required": [ "session_id", "result_locked", "archetype" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "result_locked": { "type": "boolean", "enum": [ true ] }, "archetype": { "oneOf": [ { "$ref": "#/components/schemas/QuizArchetypeLockedTaxonomy" } ], "nullable": true, "description": "Null when the taxonomy is unavailable" } }, "type": "object", "additionalProperties": false }, "QuizSeasonLockedResultData": { "description": "Anonymous result before a successful claim request: identity only (archetype: name, icon, color, tags, summary; season: name, icon, color); no scores, secondary, slug, description, or postures.", "required": [ "session_id", "result_locked", "season" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "result_locked": { "type": "boolean", "enum": [ true ] }, "season": { "oneOf": [ { "$ref": "#/components/schemas/QuizSeasonLockedTaxonomy" } ], "nullable": true, "description": "Null when the taxonomy is unavailable" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeLockedCompleteData": { "description": "Locked completion response; same identity shape as the locked result.", "required": [ "session_id", "result_locked", "archetype", "assignments_attached" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "result_locked": { "type": "boolean", "enum": [ true ] }, "archetype": { "oneOf": [ { "$ref": "#/components/schemas/QuizArchetypeLockedTaxonomy" } ], "nullable": true }, "assignments_attached": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "QuizSeasonLockedCompleteData": { "description": "Locked completion response; same identity shape as the locked result.", "required": [ "session_id", "result_locked", "season", "assignments_attached" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "result_locked": { "type": "boolean", "enum": [ true ] }, "season": { "oneOf": [ { "$ref": "#/components/schemas/QuizSeasonLockedTaxonomy" } ], "nullable": true }, "assignments_attached": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "QuizDashboardEventData": { "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "type": "object", "additionalProperties": false }, "QuizAnswerRequest": { "required": [ "session_id", "question_slug", "selected_option_key" ], "properties": { "session_id": { "type": "string", "format": "uuid" }, "question_slug": { "type": "string" }, "selected_option_key": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizCompleteRequest": { "required": [ "session_id" ], "properties": { "session_id": { "type": "string", "format": "uuid" } }, "type": "object", "additionalProperties": false }, "QuizDashboardEventRequest": { "required": [ "archetype_session_id", "season_session_id", "source" ], "properties": { "archetype_session_id": { "type": "string", "format": "uuid" }, "season_session_id": { "type": "string", "format": "uuid" }, "source": { "type": "string", "enum": [ "auto", "manual" ] }, "question_slug": { "type": "string", "nullable": true } }, "type": "object", "additionalProperties": false }, "QuizArchetypeStartSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizArchetypeStartData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizSeasonStartSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizSeasonStartData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeSessionSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizArchetypeSessionData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizSeasonSessionSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizSeasonSessionData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeAnswerSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizArchetypeAnswerData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizSeasonAnswerSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizSeasonAnswerData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeCompleteSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "oneOf": [ { "$ref": "#/components/schemas/QuizArchetypeResultData" }, { "$ref": "#/components/schemas/QuizArchetypeLockedCompleteData" } ] }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizSeasonCompleteSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "oneOf": [ { "$ref": "#/components/schemas/QuizSeasonResultData" }, { "$ref": "#/components/schemas/QuizSeasonLockedCompleteData" } ] }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizArchetypeResultSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "oneOf": [ { "$ref": "#/components/schemas/QuizArchetypeResultData" }, { "$ref": "#/components/schemas/QuizArchetypeLockedResultData" } ] }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizSeasonResultSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "oneOf": [ { "$ref": "#/components/schemas/QuizSeasonResultData" }, { "$ref": "#/components/schemas/QuizSeasonLockedResultData" } ] }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizDashboardEventSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/QuizDashboardEventData" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuizClaimRequest": { "required": [ "archetype_session_id", "season_session_id", "email" ], "properties": { "archetype_session_id": { "type": "string", "format": "uuid" }, "season_session_id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email", "maxLength": 255 } }, "type": "object", "additionalProperties": false }, "QuizClaimVerifyQuery": { "required": [ "archetype_session", "season_session", "claim_email_hash", "claim_nonce", "expires", "signature" ], "properties": { "archetype_session": { "type": "string", "format": "uuid" }, "season_session": { "type": "string", "format": "uuid" }, "claim_email_hash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "claim_nonce": { "type": "string", "maxLength": 64, "minLength": 64 }, "expires": { "type": "integer" }, "signature": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "type": "object", "additionalProperties": false }, "QuizClaimConfirmRequest": { "required": [ "verify_token" ], "properties": { "verify_token": { "type": "string", "maxLength": 255, "minLength": 32 }, "terms": { "description": "Required when registration_required is true; forbidden otherwise", "type": "boolean", "enum": [ true ] }, "marketing_optin_accepted": { "description": "Required when registration_required is true; forbidden otherwise", "type": "boolean" } }, "type": "object", "additionalProperties": false }, "UserPersonaTaxonomy": { "required": [ "slug", "name", "summary", "description", "icon", "color", "tags" ], "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "UserPersonaMatchedProfessional": { "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object", "additionalProperties": false }, "UserPersonaCopyItem": { "required": [ "title", "description" ], "properties": { "title": { "type": "string" }, "description": { "type": "string" } }, "type": "object", "additionalProperties": false }, "UserPersonaPosture": { "required": [ "title", "description", "strengths", "growth_areas", "quotes", "matched_professionals", "professional_needs_to" ], "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "strengths": { "type": "array", "items": { "$ref": "#/components/schemas/UserPersonaCopyItem" } }, "growth_areas": { "type": "array", "items": { "$ref": "#/components/schemas/UserPersonaCopyItem" } }, "quotes": { "type": "array", "items": { "type": "string" } }, "matched_professionals": { "type": "array", "items": { "$ref": "#/components/schemas/UserPersonaMatchedProfessional" } }, "professional_needs_to": { "type": "array", "items": { "type": "string" } } }, "type": "object", "additionalProperties": false }, "UserPersona": { "required": [ "archetype", "season", "posture" ], "properties": { "archetype": { "$ref": "#/components/schemas/UserPersonaTaxonomy" }, "season": { "$ref": "#/components/schemas/UserPersonaTaxonomy" }, "posture": { "$ref": "#/components/schemas/UserPersonaPosture" } }, "type": "object", "additionalProperties": false }, "UserPersonaData": { "required": [ "persona", "how_chip_uses_this" ], "properties": { "persona": { "oneOf": [ { "$ref": "#/components/schemas/UserPersona" } ], "nullable": true }, "how_chip_uses_this": { "type": "string", "example": "How CHIP uses this: a short quiz puts you on two scales. Your archetype is how you're naturally wired to think about money, and it tends to stay pretty steady over time. Your season is what's actually going on in your life right now, and that can shift fast: a new job, a move, a baby. We keep the two separate because a rough patch doesn't define who you are, and who you are shouldn't be boxed in by whatever season you're in. Together, they shape your Prosperity Matrix posture and the guidance above, and we use them to match you with the right professional for where you are today. Nothing here is permanent. Check back in every few months, especially after something big changes, and retake the quiz whenever you want." } }, "type": "object", "additionalProperties": false }, "UserPersonaSuccess": { "required": [ "success", "data", "message" ], "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "$ref": "#/components/schemas/UserPersonaData" }, "message": { "type": "string", "enum": [ "Successfully retrieved your persona" ] } }, "type": "object", "additionalProperties": false }, "UserPersonaUnauthorizedResponse": { "required": [ "message" ], "properties": { "message": { "type": "string", "enum": [ "Unauthenticated." ], "example": "Unauthenticated." } }, "type": "object", "additionalProperties": false }, "UserPersonaForbiddenResponse": { "required": [ "message" ], "properties": { "message": { "type": "string", "enum": [ "" ], "example": "" } }, "type": "object", "additionalProperties": false }, "ErrorResponse": { "title": "Error Response", "description": "Standard error response format", "properties": { "success": { "description": "Indicates if the request was successful", "type": "boolean", "example": false }, "message": { "description": "Human-readable error message", "type": "string", "example": "An error occurred" }, "errors": { "description": "Detailed validation errors (when applicable)", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "ValidationErrorResponse": { "title": "Validation Error Response", "description": "Response format for validation errors (422)", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "The given data was invalid." }, "errors": { "type": "object", "example": { "name": [ "The name field is required." ], "email": [ "The email field must be a valid email address." ] } } }, "type": "object" }, "NotFoundResponse": { "title": "Not Found Response", "description": "Response format for resource not found (404)", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Resource not found" } }, "type": "object" }, "UnauthorizedResponse": { "title": "Unauthorized Response", "description": "Response format for unauthorized access (401)", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "Unauthorized" } }, "type": "object" }, "ForbiddenResponse": { "title": "Forbidden Response", "description": "Response format for forbidden access (403)", "properties": { "success": { "type": "boolean", "example": false }, "message": { "type": "string", "example": "This action is unauthorized." } }, "type": "object" }, "SuccessResponse": { "title": "Success Response", "description": "Standard success response format", "properties": { "success": { "type": "boolean", "example": true }, "message": { "type": "string", "example": "Operation completed successfully" }, "data": { "description": "The response data (varies by endpoint)" } }, "type": "object" }, "PaginatedResponse": { "title": "Paginated Response", "description": "Standard paginated response format", "properties": { "success": { "type": "boolean", "example": true }, "data": { "description": "Array of data items", "type": "array", "items": {} }, "links": { "properties": { "first": { "type": "string", "nullable": true }, "last": { "type": "string", "nullable": true }, "prev": { "type": "string", "nullable": true }, "next": { "type": "string", "nullable": true } }, "type": "object" }, "meta": { "properties": { "current_page": { "type": "integer", "example": 1 }, "from": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 10 }, "path": { "type": "string", "example": "http://api.example.com/items" }, "per_page": { "type": "integer", "example": 15 }, "to": { "type": "integer", "example": 15 }, "total": { "type": "integer", "example": 150 } }, "type": "object" } }, "type": "object" }, "Agreement": { "required": [ "is_active", "title", "description" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "is_active": { "description": "is_active", "type": "boolean", "readOnly": false, "nullable": false }, "title": { "description": "title", "type": "string", "readOnly": false, "nullable": false }, "description": { "description": "description", "type": "string", "readOnly": false, "nullable": false }, "deleted_at": { "description": "deleted_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Benefit": { "required": [ "title" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "title": { "description": "title", "type": "string", "readOnly": false, "nullable": true }, "description": { "description": "description", "type": "string", "readOnly": false, "nullable": true }, "link": { "description": "link", "type": "string", "readOnly": false, "nullable": true }, "role_id": { "description": "role_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "benefit_type_id": { "description": "benefit_type_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Company": { "required": [ "name", "slug" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "name": { "description": "name", "type": "string", "readOnly": false, "nullable": false }, "slug": { "description": "slug", "type": "string", "readOnly": true, "nullable": false }, "photo_url": { "description": "photo_url", "type": "string", "readOnly": false, "nullable": true }, "website_url": { "description": "website_url", "type": "string", "readOnly": false, "nullable": true }, "team_id": { "description": "team_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "industry_id": { "description": "industry_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "location_id": { "description": "location_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "owner_id": { "description": "owner_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "ConsumerMatchingCriteria": { "required": [ "user_id", "has_dependents", "is_business_owner", "has_financial_planner", "average_client_net_worth_id", "net_worth", "household_income", "investment_amount", "specific_professionals", "investment_minimum", "preferred_languages", "works_virtually", "is_taking_new_clients", "is_fee_only", "is_insurance_licensed" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "age_range_id": { "description": "age_range_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "investment_practice_size_id": { "description": "investment_practice_size_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "has_dependents": { "description": "has_dependents", "type": "boolean", "readOnly": false, "nullable": true }, "is_business_owner": { "description": "is_business_owner", "type": "boolean", "readOnly": false, "nullable": true }, "has_financial_planner": { "description": "has_financial_planner", "type": "boolean", "readOnly": false, "nullable": true }, "preferred_languages": { "description": "preferred_languages", "type": "array", "items": { "type": "string" }, "readOnly": false, "nullable": true }, "prefers_local_professional": { "description": "prefers_local_professional", "type": "string", "readOnly": false, "nullable": true }, "average_client_net_worth_id": { "description": "average_client_net_worth_id", "type": "string", "readOnly": false, "nullable": true }, "net_worth": { "description": "net_worth", "type": "string", "readOnly": false, "nullable": true }, "household_income": { "description": "household_income", "type": "string", "readOnly": false, "nullable": true }, "investment_amount": { "description": "investment_amount", "type": "string", "readOnly": false, "nullable": true }, "specific_professionals": { "description": "specific_professionals", "type": "array", "items": { "type": "integer" }, "readOnly": false, "nullable": true }, "investment_minimum": { "description": "investment_minimum", "type": "string", "readOnly": false, "nullable": true }, "works_virtually": { "description": "works_virtually", "type": "boolean", "readOnly": false, "nullable": true }, "is_taking_new_clients": { "description": "is_taking_new_clients", "type": "boolean", "readOnly": false, "nullable": true }, "is_fee_only": { "description": "is_fee_only", "type": "boolean", "readOnly": false, "nullable": true }, "is_insurance_licensed": { "description": "is_insurance_licensed", "type": "boolean", "readOnly": false, "nullable": true }, "years_of_experience": { "description": "years_of_experience", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "CriteriaConfiguration": { "required": [ "title", "is_active", "role_id", "config" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "title": { "description": "title", "type": "string", "readOnly": false, "nullable": true }, "is_active": { "description": "is_active", "type": "boolean", "readOnly": false, "nullable": true }, "role_id": { "description": "role_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "config": { "description": "config", "type": "string", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Education": { "required": [ "start_date", "school_id", "user_id", "area_of_study_id" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "start_date": { "description": "start_date", "type": "string", "format": "date", "readOnly": false, "nullable": true }, "end_date": { "description": "end_date", "type": "string", "format": "date", "readOnly": false, "nullable": true }, "school_id": { "description": "school_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "area_of_study_id": { "description": "area_of_study_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Event": { "required": [ "user_id", "title", "description", "start_date", "start_time", "is_full_day", "is_recurring" ], "properties": { "title": { "description": "", "type": "string", "readOnly": false, "nullable": false }, "description": { "description": "", "type": "string", "readOnly": false, "nullable": false }, "start_date": { "description": "", "type": "string", "readOnly": false, "nullable": false }, "end_date": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "start_time": { "description": "", "type": "string", "readOnly": false, "nullable": false }, "end_time": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "is_full_day": { "description": "", "type": "boolean", "readOnly": false, "nullable": false }, "is_recurring": { "description": "", "type": "boolean", "readOnly": false, "nullable": false }, "meta": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "exclude_dates": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "created_at": { "description": "", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Faq": { "required": [ "title", "slug", "is_public", "is_active", "answer" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "title": { "description": "title", "type": "string", "readOnly": false, "nullable": true }, "slug": { "description": "slug", "type": "string", "readOnly": false, "nullable": true }, "is_public": { "description": "is_public", "type": "boolean", "readOnly": false, "nullable": true }, "is_active": { "description": "is_active", "type": "boolean", "readOnly": false, "nullable": true }, "answer": { "description": "answer", "type": "string", "readOnly": false, "nullable": true }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "role_id": { "description": "role_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "priority": { "description": "priority", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "deleted_at": { "description": "deleted_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "InviteRedemption": { "required": [ "user_id", "invite_id", "partner_id" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "invite_id": { "description": "invite_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "partner_id": { "description": "partner_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Location": { "required": [ "address", "zipcode", "city_id", "state_id", "country_id" ], "properties": { "name": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "address": { "description": "", "type": "string", "readOnly": false, "nullable": false }, "location": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "created_at": { "description": "", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Meeting": { "required": [ "uuid", "topic", "start_time", "duration", "provider", "scheduler_type", "scheduler_id", "presenter_type", "presenter_id", "host_type", "host_id" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "uuid": { "description": "uuid", "type": "string", "readOnly": false, "nullable": true }, "topic": { "description": "topic", "type": "string", "readOnly": false, "nullable": true }, "duration": { "description": "duration", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "provider": { "description": "provider", "type": "string", "readOnly": false, "nullable": true }, "scheduler_type": { "description": "scheduler_type", "type": "string", "readOnly": false, "nullable": true }, "scheduler_id": { "description": "scheduler_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "presenter_type": { "description": "presenter_type", "type": "string", "readOnly": false, "nullable": true }, "presenter_id": { "description": "presenter_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "host_type": { "description": "host_type", "type": "string", "readOnly": false, "nullable": true }, "host_id": { "description": "host_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "deleted_at": { "description": "deleted_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "MeetingParticipant": { "required": [ "uuid", "participant_type", "meeting_id" ], "properties": { "uuid": { "description": "uuid", "type": "string", "readOnly": false, "nullable": true }, "participant_type": { "description": "participant_type", "type": "string", "readOnly": false, "nullable": true }, "participant_id": { "description": "participant_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "meeting_id": { "description": "meeting_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "deleted_at": { "description": "deleted_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "MeetingRoom": { "required": [ "uuid", "name", "email", "type", "group" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "uuid": { "description": "uuid", "type": "string", "readOnly": false, "nullable": true }, "name": { "description": "name", "type": "string", "readOnly": false, "nullable": true }, "email": { "description": "email", "type": "string", "readOnly": false, "nullable": true }, "type": { "description": "type", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "group": { "description": "group", "type": "string", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "deleted_at": { "description": "deleted_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "OnboardingCriteria": { "required": [ "title", "role_id" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "title": { "description": "title", "type": "string", "readOnly": false, "nullable": false }, "title_display": { "description": "title_display", "type": "string", "readOnly": false, "nullable": true }, "description": { "description": "description", "type": "string", "readOnly": false, "nullable": true }, "role_id": { "description": "role_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": false }, "config": { "description": "config", "type": "string", "readOnly": false, "nullable": true }, "is_active": { "description": "is_active", "type": "boolean", "readOnly": false, "nullable": true }, "for_onboarding": { "description": "for_onboarding", "type": "boolean", "readOnly": false, "nullable": true } }, "type": "object" }, "Opportunity": { "required": [ "title", "starts_at", "ends_at" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "title": { "description": "title", "type": "string", "readOnly": false, "nullable": true }, "description": { "description": "description", "type": "string", "readOnly": false, "nullable": true }, "link": { "description": "link", "type": "string", "readOnly": false, "nullable": true }, "location_id": { "description": "location_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "team_id": { "description": "team_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "opportunity_type_id": { "description": "opportunity_type_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "starts_at": { "description": "starts_at", "type": "string", "format": "date-time", "readOnly": false, "nullable": true }, "ends_at": { "description": "ends_at", "type": "string", "format": "date-time", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "deleted_at": { "description": "deleted_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Partner": { "required": [ "role_id", "partner_type_id" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "name": { "description": "name", "type": "string", "readOnly": false, "nullable": true }, "description": { "description": "description", "type": "string", "readOnly": false, "nullable": true }, "url": { "description": "url", "type": "string", "readOnly": false, "nullable": true }, "role_id": { "description": "role_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "partner_type_id": { "description": "partner_type_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "ProfessionalMatch": { "required": [ "confidence" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": true }, "meeting_id": { "description": "meeting_id", "type": "integer", "format": "int32", "readOnly": true, "nullable": true }, "consumer_id": { "description": "consumer_id", "type": "integer", "format": "int32", "readOnly": true, "nullable": true }, "professional_id": { "description": "professional_id", "type": "integer", "format": "int32", "readOnly": true, "nullable": true }, "accepted_on": { "description": "accepted_on", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "rejected_on": { "description": "rejected_on", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "cancelled_on": { "description": "cancelled_on", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "criteria": { "description": "criteria", "type": "string", "readOnly": true, "nullable": true }, "confidence": { "description": "confidence", "type": "number", "format": "number", "readOnly": true, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "ProfessionalMatchingCriteria": { "required": [ "user_id", "investment_minimum", "average_client_net_worth_id", "languages_spoken", "works_virtually", "is_taking_new_clients", "is_fee_only", "is_insurance_licensed" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "investment_minimum": { "description": "investment_minimum", "type": "string", "readOnly": false, "nullable": true }, "average_client_net_worth_id": { "description": "average_client_net_worth_id", "type": "string", "readOnly": false, "nullable": true }, "languages_spoken": { "description": "languages_spoken", "type": "string", "readOnly": false, "nullable": true }, "works_virtually": { "description": "works_virtually", "type": "boolean", "readOnly": false, "nullable": true }, "is_taking_new_clients": { "description": "is_taking_new_clients", "type": "boolean", "readOnly": false, "nullable": true }, "is_fee_only": { "description": "is_fee_only", "type": "boolean", "readOnly": false, "nullable": true }, "is_insurance_licensed": { "description": "is_insurance_licensed", "type": "boolean", "readOnly": false, "nullable": true }, "years_of_experience": { "description": "years_of_experience", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "investment_practice_size_id": { "description": "investment_practice_size_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "School": { "required": [ "name" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "name": { "description": "name", "type": "string", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "SharedItem": { "required": [ "role_id", "category_id" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "title": { "description": "title", "type": "string", "readOnly": false, "nullable": true }, "url": { "description": "url", "type": "string", "readOnly": false, "nullable": true }, "description": { "description": "description", "type": "string", "readOnly": false, "nullable": true }, "role_id": { "description": "role_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "category_id": { "description": "category_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "SharedItemStatus": { "required": [ "shared_item_id", "user_id", "is_read" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "shared_item_id": { "description": "shared_item_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "is_read": { "description": "is_read", "type": "boolean", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "Subscription": { "required": [ "user_id", "name", "stripe_id", "stripe_status" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "name": { "description": "name", "type": "string", "readOnly": false, "nullable": true }, "stripe_id": { "description": "stripe_id", "type": "string", "readOnly": false, "nullable": true }, "stripe_status": { "description": "stripe_status", "type": "string", "readOnly": false, "nullable": true }, "stripe_price": { "description": "stripe_price", "type": "string", "readOnly": false, "nullable": true }, "quantity": { "description": "quantity", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "trial_ends_at": { "description": "trial_ends_at", "type": "string", "format": "date-time", "readOnly": false, "nullable": true }, "ends_at": { "description": "ends_at", "type": "string", "format": "date-time", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "SubscriptionItem": { "required": [ "subscription_id", "stripe_id", "stripe_product", "stripe_price" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "subscription_id": { "description": "subscription_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "stripe_id": { "description": "stripe_id", "type": "string", "readOnly": false, "nullable": true }, "stripe_product": { "description": "stripe_product", "type": "string", "readOnly": false, "nullable": true }, "stripe_price": { "description": "stripe_price", "type": "string", "readOnly": false, "nullable": true }, "quantity": { "description": "quantity", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "UserAgreement": { "required": [ "user_id", "agreement_id", "is_accepted" ], "properties": { "id": { "description": "id", "type": "integer", "format": "int32", "readOnly": true, "nullable": false }, "user_id": { "description": "user_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "agreement_id": { "description": "agreement_id", "type": "integer", "format": "int32", "readOnly": false, "nullable": true }, "is_accepted": { "description": "is_accepted", "type": "boolean", "readOnly": false, "nullable": true }, "signature": { "description": "signature", "type": "string", "readOnly": false, "nullable": true }, "ip_address": { "description": "ip_address", "type": "string", "readOnly": false, "nullable": true }, "created_at": { "description": "created_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "updated_at", "type": "string", "format": "date-time", "readOnly": true, "nullable": true } }, "type": "object" }, "UserProfile": { "required": [ "user_id", "is_public", "terms_accepted" ], "properties": { "bio": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "is_public": { "description": "", "type": "boolean", "readOnly": false, "nullable": false }, "deleted_at": { "description": "", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "created_at": { "description": "", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "updated_at": { "description": "", "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "dob": { "description": "", "type": "string", "format": "date", "readOnly": false, "nullable": true }, "how_did_you_hear_about_us": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "fun_facts": { "description": "", "type": "string", "readOnly": false, "nullable": true }, "terms_accepted": { "description": "", "type": "boolean", "readOnly": false, "nullable": false }, "terms_accepted_on": { "description": "", "type": "string", "format": "date-time", "readOnly": false, "nullable": true } }, "type": "object" } }, "requestBodies": { "UserUpdateRequest": { "required": false, "content": { "multipart/form-data": { "schema": { "properties": { "name": { "type": "string", "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "photo": { "type": "string", "format": "binary" }, "avatar": { "type": "string", "format": "binary" } }, "type": "object" } } } }, "UserProfileUpdateRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "user_id", "is_public" ], "properties": { "user_id": { "type": "integer" }, "is_public": { "type": "boolean" }, "bio": { "type": "string", "nullable": true }, "dob": { "type": "string", "format": "date", "nullable": true }, "linkedin_url": { "type": "string", "format": "uri", "nullable": true }, "video_url": { "type": "string", "format": "uri", "nullable": true }, "website_url": { "type": "string", "format": "uri", "nullable": true } }, "type": "object" } } } } }, "securitySchemes": { "bearer_token": { "type": "http", "description": "JWT Bearer token authentication. Include 'Bearer ' followed by your JWT token.", "bearerFormat": "JWT", "scheme": "bearer" }, "api_key": { "type": "apiKey", "description": "API key authentication. Include your API key in the X-API-Key header.", "name": "X-API-Key", "in": "header" } } }, "tags": [ { "name": "Quiz", "description": "Public quiz funnel API" }, { "name": "Activity", "description": "Activity" }, { "name": "Auth", "description": "Auth" }, { "name": "SocialAuth", "description": "SocialAuth" }, { "name": "Benefit", "description": "Benefit" }, { "name": "Category", "description": "Category" }, { "name": "Comment", "description": "Comment" }, { "name": "ConsumerMatchingCriteria", "description": "ConsumerMatchingCriteria" }, { "name": "Onboarding", "description": "Onboarding" }, { "name": "Conversational onboarding", "description": "Conversational onboarding" }, { "name": "Dashboard", "description": "Dashboard" }, { "name": "Event", "description": "Event" }, { "name": "FAQ", "description": "FAQ" }, { "name": "Favorite", "description": "Favorite" }, { "name": "Feed", "description": "Feed" }, { "name": "Feedback", "description": "Feedback" }, { "name": "Follow", "description": "Follow" }, { "name": "InviteRedemption", "description": "InviteRedemption" }, { "name": "Like", "description": "Like" }, { "name": "Location", "description": "Location" }, { "name": "Meeting", "description": "Meeting" }, { "name": "Opportunity", "description": "Opportunity" }, { "name": "Partner", "description": "Partner" }, { "name": "ProfessionalMatch", "description": "ProfessionalMatch" }, { "name": "ProfessionalMatchingCriteria", "description": "ProfessionalMatchingCriteria" }, { "name": "SavedCollection", "description": "SavedCollection" }, { "name": "SavedCollectionItem", "description": "SavedCollectionItem" }, { "name": "SharedItem", "description": "SharedItem" }, { "name": "SharedItemStatus", "description": "SharedItemStatus" }, { "name": "Subscription", "description": "Subscription" }, { "name": "SubscriptionItem", "description": "SubscriptionItem" }, { "name": "Team", "description": "Team" }, { "name": "TeamInvitation", "description": "TeamInvitation" }, { "name": "TeamMember", "description": "TeamMember" }, { "name": "TeamProfile", "description": "TeamProfile" }, { "name": "Payment", "description": "Payment" }, { "name": "Trending", "description": "Trending" }, { "name": "User", "description": "User" }, { "name": "UserInterest", "description": "UserInterest" }, { "name": "UserProfile", "description": "UserProfile" } ] }