{ "openapi": "3.0.0", "info": { "title": "Aqarkom API Documentation", "version": "1.0.0" }, "paths": { "/api/v1/ads/check-license": { "post": { "tags": [ "Ads" ], "summary": "check license", "operationId": "checkLicense", "requestBody": { "$ref": "#/components/requestBodies/CheckAdLicenseRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/AdPlatformViewModel" } }, "type": "object" } } } }, "402": { "description": "Exit ad", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/AdExistsAdViewModel" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/constants/geography/cities": { "get": { "tags": [ "Constants" ], "summary": "Get City List", "operationId": "GetCityList", "responses": { "200": { "description": "City retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CityViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/geography/neighborhoods": { "get": { "tags": [ "Constants" ], "summary": "Get Neighborhood List", "operationId": "GetNeighborhoodList", "responses": { "200": { "description": "Neighborhood retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/NeighborhoodViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/geography/regions": { "get": { "tags": [ "Constants" ], "summary": "Get Region List", "operationId": "GetRegionList", "responses": { "200": { "description": "Region retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegionViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/geography/region-maps": { "get": { "tags": [ "Constants" ], "summary": "Get Region For Map List", "operationId": "GetRegionMapList", "responses": { "200": { "description": "Region For Map retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RegionMapViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/ad-types": { "get": { "tags": [ "Constants" ], "summary": "Get Ad Type List", "operationId": "GetAdTypeList", "parameters": [ { "name": "type", "in": "query", "description": "Type", "required": true, "schema": { "type": "string", "enum": [ "sell", "buy" ] }, "example": "sell" } ], "responses": { "200": { "description": "Ad Types retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdTypeViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/estate-types": { "get": { "tags": [ "Constants" ], "summary": "Get Estate Type List", "operationId": "GetEstateTypeList", "responses": { "200": { "description": "Estate Types retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EstateTypeViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/property-utilities": { "get": { "tags": [ "Constants" ], "summary": "Get Property Utility List", "operationId": "GetPropertyUtilityList", "responses": { "200": { "description": "Estate Types retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyUtilityViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/reasons": { "get": { "tags": [ "Constants" ], "summary": "Get Reason List", "operationId": "GetReasonList", "responses": { "200": { "description": "Reasons retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReasonViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/constants/usage-types": { "get": { "tags": [ "Constants" ], "summary": "Get Usage Type List", "operationId": "GetUsageTypeList", "responses": { "200": { "description": "Usage Types retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UsageTypeViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/ads/get-data-filter": { "get": { "tags": [ "Filter" ], "summary": "Get data filter", "operationId": "GetDataFilter", "responses": { "200": { "description": "Packages retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "price": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object" }, "area": { "properties": { "max": { "type": "number", "format": "float" }, "min": { "type": "number", "format": "float" } }, "type": "object" }, "ad_type": { "type": "array", "items": { "$ref": "#/components/schemas/AdTypeViewModel" } }, "estate_type": { "type": "array", "items": { "$ref": "#/components/schemas/EstateTypeViewModel" } }, "usage_type": { "type": "array", "items": { "$ref": "#/components/schemas/UsageTypeViewModel" } }, "property_utility": { "type": "array", "items": { "$ref": "#/components/schemas/PropertyUtilityViewModel" } } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/v1/home": { "get": { "tags": [ "Home" ], "summary": "Get home ads: special, nearest and services", "operationId": "Home", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Fetched successfully" }, "data": { "properties": { "special": { "type": "array", "items": { "$ref": "#/components/schemas/AdViewListModel" } }, "nearest": { "type": "array", "items": { "$ref": "#/components/schemas/AdViewListModel" } }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceViewModel" } } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "optional": [] } ] } }, "/api/v1/ads/list-buy-ads": { "get": { "tags": [ "Ads" ], "summary": "List buy ads", "operationId": "List Buy Ads", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ad_type_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "estate_type_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "city_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "region_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "neighborhood_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdBuyViewListModel" } }, "meta": { "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "optional": [] } ] } }, "/api/v1/ads/list-sell-ads": { "get": { "tags": [ "Ads" ], "summary": "List sell ads", "operationId": "List Sell Ads", "parameters": [ { "name": "lat", "in": "query", "required": true, "schema": { "type": "number", "format": "float" } }, { "name": "lng", "in": "query", "required": true, "schema": { "type": "number", "format": "float" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "ad_type_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "estate_type_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "city_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "region_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "neighborhood_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "usage_type_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "main_type", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "number_of_rooms", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "price", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "min_price", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "max_price", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "min_area", "in": "query", "required": false, "schema": { "type": "number" } }, { "name": "max_area", "in": "query", "required": false, "schema": { "type": "number" } }, { "name": "region_map_id", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "property_utilities", "in": "query", "required": false, "schema": { "description": "Comma-separated list of utility IDs", "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "is_special", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "is_story", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "description": "قيمة الترتيب:\n nearest = الأقرب إليك,\n lowest_price = الأقل سعراً,\n highest_price = الأعلى سعراً,\n largest_area = الأكبر مساحة,\n smallest_area = الأصغر مساحة", "required": false, "schema": { "type": "string", "enum": [ "nearest", "lowest_price", "highest_price", "largest_area", "smallest_area" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AdViewListModel" } }, "meta": { "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "optional": [] } ] } }, "/api/v1/ads/show/sell/{slug}": { "get": { "tags": [ "Ads" ], "summary": "Show Ad Details", "operationId": "ShowAdDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/AdViewModel" } }, "type": "object" } } } }, "400": { "description": "error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "optional": [] } ] } }, "/api/v1/ads/show/buy/{slug}": { "get": { "tags": [ "Ads" ], "summary": "Show Ad Buy Details", "operationId": "ShowBuyAdDetails", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/AdBuyViewModel" } }, "type": "object" } } } }, "400": { "description": "error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "optional": [] } ] } }, "/api/v1/ads/store-buy-ads": { "post": { "tags": [ "Ads" ], "summary": "store buy ads", "operationId": "storeBuyAds", "requestBody": { "$ref": "#/components/requestBodies/StoreBuyAdRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "title": "string", "example": "slug ad" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/ads/store-sell-ads": { "post": { "tags": [ "Ads" ], "summary": "store sell ads", "operationId": "storeSellAds", "requestBody": { "$ref": "#/components/requestBodies/StoreSellAdRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "title": "string", "example": "slug ad" } }, "type": "object" } } } }, "402": { "description": "Exit ad", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/AdExistsAdViewModel" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/ads/list-story-ads": { "get": { "tags": [ "Story" ], "summary": "List story ads", "operationId": "List story Ads", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Fetched successfully" }, "data": { "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserStoryViewListModel" } }, "meta": { "properties": { "current_page": { "type": "integer", "example": 1 }, "per_page": { "type": "integer", "example": 15 }, "total": { "type": "integer", "example": 120 }, "last_page": { "type": "integer", "example": 8 } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "optional": [] } ] } }, "/api/v1/ads/{ad}/toggle-favorite": { "post": { "tags": [ "Ads" ], "summary": "toggle favorite ads", "operationId": "ToggleFavorite", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "boolean" } }, "type": "object" } } } }, "400": { "description": "error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/ads/{ad}/toggle-view": { "post": { "tags": [ "Ads" ], "summary": "toggle view ads", "operationId": "ToggleView", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "is_view": { "type": "boolean", "example": true } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/auth/complete-profile": { "post": { "tags": [ "Auth" ], "operationId": "a63bf5b498b182343c5bd6b452b0e853", "requestBody": { "$ref": "#/components/requestBodies/CompleteProfileRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserViewModel" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/auth/ratings": { "post": { "tags": [ "Auth" ], "operationId": "9d40647a10525a70eab98ca5bdb806eb", "requestBody": { "$ref": "#/components/requestBodies/CreateRatingRequest" }, "responses": { "201": { "description": "Rating created successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Rating created successfully" }, "data": { "$ref": "#/components/schemas/RatingViewModel" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Business logic error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/auth/ratings/{id}": { "put": { "tags": [ "Auth" ], "operationId": "b3955e97854662285837c7b69a16258a", "requestBody": { "$ref": "#/components/requestBodies/UpdateRatingRequest" }, "responses": { "200": { "description": "Rating updated successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Rating updated successfully" }, "data": { "$ref": "#/components/schemas/RatingViewModel" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Rating not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Rating not found" } }, "type": "object" } } } }, "422": { "description": "Business logic error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Auth" ], "operationId": "fe08f98367030e93980ed66e7d7ada11", "responses": { "200": { "description": "Rating deleted successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Rating deleted successfully" } }, "type": "object" } } } }, "404": { "description": "Rating not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Rating not found" } }, "type": "object" } } } }, "422": { "description": "Business logic error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/auth/edit-profile": { "post": { "tags": [ "Auth" ], "operationId": "32acb2cefe03af89b5bc6d2ebee01dde", "requestBody": { "$ref": "#/components/requestBodies/EditProfileRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserViewModel" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/auth/companies/{companyId}/ratings": { "get": { "tags": [ "Auth" ], "operationId": "c2a4a30fbf8a95845c66255c2c9c25a8", "responses": { "200": { "description": "Company ratings retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Company ratings retrieved successfully" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RatingViewModel" } }, "meta": { "type": "object" } }, "type": "object" } } } }, "404": { "description": "Company not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Company not found" } }, "type": "object" } } } } } } }, "/api/v1/service-providers/{id}": { "get": { "tags": [ "Service Providers" ], "operationId": "b061f5f366b04184b076b265cf6a2467", "parameters": [ { "name": "id", "in": "path", "description": "Service provider ID", "required": true, "schema": { "type": "integer", "example": 1 } }, { "name": "latitude", "in": "query", "description": "User latitude for distance calculation", "required": false, "schema": { "type": "number", "format": "float", "example": 21.42251 } }, { "name": "longitude", "in": "query", "description": "User longitude for distance calculation", "required": false, "schema": { "type": "number", "format": "float", "example": 39.826168 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Service provider retrieved successfully" }, "data": { "$ref": "#/components/schemas/UserViewModel" } }, "type": "object" } } } }, "404": { "description": "Service provider not found" }, "400": { "description": "Bad Request - User is individual, not service provider" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/service-providers": { "get": { "tags": [ "Service Providers" ], "operationId": "c7ab08232d27753c93eafae18771f36f", "parameters": [ { "name": "search", "in": "query", "description": "Search by company name", "required": false, "schema": { "type": "string", "example": "construction" } }, { "name": "latitude", "in": "query", "description": "User latitude for distance calculation", "required": false, "schema": { "type": "number", "format": "float", "example": 21.42251 } }, { "name": "longitude", "in": "query", "description": "User longitude for distance calculation", "required": false, "schema": { "type": "number", "format": "float", "example": 39.826168 } }, { "name": "per_page", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "default": 15, "example": 20 } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "default": 1, "example": 2 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Service providers retrieved successfully" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserViewListModel" } }, "pagination": { "properties": { "current_page": { "type": "integer", "example": 1 }, "last_page": { "type": "integer", "example": 5 }, "per_page": { "type": "integer", "example": 15 }, "total": { "type": "integer", "example": 75 } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" } } } }, "/api/v1/auth/login": { "post": { "tags": [ "Auth" ], "operationId": "ecdd4df10738c25ddf52b4577f723dcc", "requestBody": { "$ref": "#/components/requestBodies/LoginRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "user_id": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/v1/auth/logout": { "post": { "tags": [ "Auth" ], "operationId": "f977387e97183b69943b388eb6b70e8b", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/auth/resend-code": { "post": { "tags": [ "Auth" ], "operationId": "21943fc38824027798eb4f16162460d7", "requestBody": { "$ref": "#/components/requestBodies/ResendCodeRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/api/v1/auth/verify-code": { "post": { "tags": [ "Auth" ], "operationId": "5a9aa44e98f4b628299290526eaa102d", "requestBody": { "$ref": "#/components/requestBodies/VerifyCodeRequest" }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "token": { "type": "string" }, "user": { "$ref": "#/components/schemas/UserViewModel" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid code", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } } } }, "/api/v1/notifications": { "get": { "tags": [ "Notifications" ], "summary": "List user notifications", "operationId": "List Notifications", "parameters": [ { "name": "is_read", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationViewModel" } }, "meta": { "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Server Error" } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/notifications/mark-all-as-read": { "post": { "tags": [ "Notifications" ], "summary": "Mark all user notifications as read", "operationId": "Mark All Notifications As Read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "marked_count": { "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "500": { "description": "Server Error" } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/notifications/{id}/mark-as-read": { "post": { "tags": [ "Notifications" ], "summary": "Mark a notification as read", "operationId": "Mark Notification As Read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Notification not found" }, "500": { "description": "Server Error" } }, "security": [ { "sanctum": [] } ] } }, "/api/v1/payments/apply-promo-code": { "post": { "tags": [ "Payments" ], "operationId": "fd1345a42f18afd5a0983a0f4f082521", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "package_id", "code" ], "properties": { "package_id": { "description": "Package ID", "type": "integer" }, "code": { "description": "Promo code", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Promo code applied successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "package_id": { "type": "integer" }, "original_price": { "type": "number" }, "final_price": { "type": "number" }, "discount_amount": { "type": "number" }, "discount_percentage": { "type": "number" }, "promo_code": { "type": "string" }, "is_valid": { "type": "boolean" }, "error_message": { "type": "string" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid request" }, "422": { "description": "Validation error" } } } }, "/api/v1/payments/subscriptions": { "get": { "tags": [ "Payments" ], "operationId": "e43531a54d40b817c30dd69b6a84a2d3", "responses": { "200": { "description": "User subscriptions retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "subscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionViewModel" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/payments/subscribe": { "post": { "tags": [ "Payments" ], "operationId": "b484865b9c894da7f032f232c8c8dff6", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "package_id", "payment_method" ], "properties": { "package_id": { "description": "Package ID", "type": "integer" }, "promo_code": { "description": "Promo code (optional)", "type": "string" }, "payment_method": { "type": "string", "enum": [ "electronic", "bank", "credit_card", "debit_card", "wallet" ] }, "payment_details": { "description": "Additional payment details", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Subscription created successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "subscription": { "$ref": "#/components/schemas/SubscriptionViewModel" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid request" }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation error" } }, "security": [ { "bearerAuth": [] } ] } }, "/api/v1/properties/services": { "get": { "tags": [ "Services" ], "summary": "Get services", "description": "Retrieve services with optional filtering by type, name, or active status", "operationId": "f5eac3547869f32e583fa993369b957e", "parameters": [ { "name": "type", "in": "query", "description": "Filter by service type", "required": false, "schema": { "type": "string", "enum": [ "real_estate_services", "support_services" ] } }, { "name": "name", "in": "query", "description": "Search services by name", "required": false, "schema": { "type": "string" } }, { "name": "active_only", "in": "query", "description": "Filter only active services", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Services retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Services retrieved successfully" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceViewModel" } } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Failed to retrieve services" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } } } }, "post": { "tags": [ "Services" ], "summary": "Create a new service", "description": "Creates a new service with the specified type and name", "operationId": "af71e9a38c069627ac4d10fea00114a7", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateServiceRequest" } } } }, "responses": { "201": { "description": "Service created successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Service created successfully" }, "data": { "$ref": "#/components/schemas/ServiceViewModel" } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Failed to create service" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } } } } }, "/api/v1/properties/services/{id}": { "put": { "tags": [ "Services" ], "summary": "Update a service", "description": "Updates an existing service with the specified ID", "operationId": "a0105c0e144704f923f2f3bd65715a07", "parameters": [ { "name": "id", "in": "path", "description": "Service ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceRequest" } } } }, "responses": { "200": { "description": "Service updated successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Service updated successfully" }, "data": { "$ref": "#/components/schemas/ServiceViewModel" } }, "type": "object" } } } }, "404": { "description": "Service not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Service not found" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "422": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Failed to update service" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } } } }, "delete": { "tags": [ "Services" ], "summary": "Delete a service", "description": "Deletes an existing service with the specified ID", "operationId": "9ebb2698d573836db1a0e68230220d87", "parameters": [ { "name": "id", "in": "path", "description": "Service ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Service deleted successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "success" }, "message": { "type": "string", "example": "Service deleted successfully" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "404": { "description": "Service not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Service not found" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Failed to delete service" }, "data": { "type": "array", "items": {} } }, "type": "object" } } } } } } }, "/api/v1/settings/contact": { "post": { "tags": [ "Settings" ], "operationId": "48fb95175665062d005350579f58238b", "requestBody": { "$ref": "#/components/requestBodies/CreateContactRequest" }, "responses": { "201": { "description": "Contact message created successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ContactViewModel" } }, "type": "object" } } } } } } }, "/api/v1/settings/withdrawals": { "get": { "tags": [ "Settings" ], "operationId": "db63a835a3a9bbccfbea8584bea9fe21", "responses": { "200": { "description": "User withdrawal requests retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WithdrawalViewModel" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Settings" ], "operationId": "1c4bd0d5de3517ccc5e9df4055772476", "requestBody": { "$ref": "#/components/requestBodies/CreateWithdrawalRequest" }, "responses": { "201": { "description": "Withdrawal request created successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/WithdrawalViewModel" } }, "type": "object" } } } } } } }, "/api/v1/settings/packages": { "get": { "tags": [ "Settings" ], "operationId": "460c7015dc1b5ceb19b753bc38fd420c", "parameters": [ { "name": "type", "in": "query", "description": "Package type filter", "required": false, "schema": { "type": "string", "enum": [ "individual", "companies" ] } } ], "responses": { "200": { "description": "Packages retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "properties": { "individual": { "type": "array", "items": { "$ref": "#/components/schemas/PackageViewModel" } }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/PackageViewModel" } } }, "type": "object" } }, "type": "object" } } } } } } }, "/api/v1/settings/profit-subscribers": { "get": { "tags": [ "Settings" ], "operationId": "0a8be36d4bae2f507c07e2544d8255d0", "parameters": [ { "name": "search", "in": "query", "description": "Search by name, email, or phone", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Profit subscribers retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProfitSubscriberViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/settings/contact/my-messages": { "get": { "tags": [ "Settings" ], "operationId": "66de9f6198dc399c02eb5e1e8eef1fa1", "responses": { "200": { "description": "User contact messages retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContactViewModel" } } }, "type": "object" } } } } } } }, "/api/v1/settings/user": { "get": { "tags": [ "Settings" ], "operationId": "cdd74b6458ee210c3579d33e20350a19", "responses": { "200": { "description": "User settings retrieved successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SettingViewModel" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Settings" ], "operationId": "633819be4dbb63dc590d75e9c8748ba1", "requestBody": { "$ref": "#/components/requestBodies/UpdateSettingRequest" }, "responses": { "200": { "description": "Setting updated successfully", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/SettingViewModel" } }, "type": "object" } } } } } } } }, "components": { "schemas": { "AdBuyViewListModel": { "title": "AdBuyViewListModel", "description": "Ad Buy List View Model", "required": [ "id", "slug" ], "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string" }, "price": { "type": "integer" }, "date": { "type": "string" }, "estate_type": { "type": "string" }, "ad_type": { "type": "string" }, "address": { "type": "integer" }, "user_id": { "type": "integer" }, "user_number": { "type": "string" }, "user_whatsapp": { "type": "string" } }, "type": "object" }, "AdBuyViewModel": { "title": "AdBuyViewModel", "description": "Ad buy View Model", "required": [ "id" ], "properties": { "id": { "type": "integer" }, "slug": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "type_ad": { "type": "string", "nullable": true }, "estate_type": { "type": "string", "nullable": true }, "usage_type": { "type": "string", "nullable": true }, "price": { "type": "integer", "nullable": true }, "creation_date": { "description": "Relative time (e.g. منذ يومين)", "type": "string" }, "address": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "user": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "is_verified": { "type": "boolean" }, "whatsapp": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "is_follow": { "type": "boolean" }, "rating_stats": { "properties": { "average_rating": { "type": "number", "format": "float" }, "total_ratings": { "type": "integer" }, "ratings_given_count": { "type": "integer" } }, "type": "object" } }, "type": "object", "nullable": true } }, "type": "object" }, "AdExistsAdViewModel": { "title": "AdViewModel", "description": "Ad If Already exists View Model", "required": [ "license_number" ], "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "license_number": { "type": "string" }, "user_name": { "type": "string" }, "user_id": { "type": "integer" } }, "type": "object" }, "AdPlatformViewModel": { "title": "AdPlatformViewModel", "description": "Ad From Platform View Model", "required": [ "license_number" ], "properties": { "license_number": { "type": "string" }, "advertiser_name": { "type": "string" }, "advertiser_phone": { "type": "string" }, "price": { "type": "number", "format": "float" }, "property_price": { "type": "number", "format": "float" }, "region": { "type": "object" }, "city": { "type": "object" }, "neighborhood": { "type": "object" }, "estate_type": { "type": "object" }, "usage_type": { "type": "object" }, "ad_type": { "type": "object" }, "property_utilities": { "type": "array", "items": { "type": "object" } }, "address": { "type": "string" }, "lng": { "type": "number", "format": "float" }, "lat": { "type": "number", "format": "float" }, "is_constrained": { "type": "boolean" }, "is_pawned": { "type": "boolean" }, "is_halted": { "type": "boolean" }, "is_testment": { "type": "boolean" }, "street_width": { "type": "number", "format": "float", "nullable": true }, "number_of_rooms": { "type": "integer", "nullable": true }, "area": { "type": "string", "nullable": true }, "deed_number": { "type": "string", "nullable": true }, "property_face": { "type": "string", "nullable": true }, "plan_number": { "type": "string", "nullable": true }, "land_number": { "type": "string", "nullable": true }, "ad_license_url": { "type": "string", "nullable": true }, "ad_source": { "type": "string", "nullable": true }, "title_deed_type_name": { "type": "string", "nullable": true }, "location_description": { "type": "string", "nullable": true }, "property_age": { "type": "string", "nullable": true }, "rerConstraints": { "type": "array", "items": { "type": "string" }, "nullable": true }, "creation_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "AdStoryViewListModel": { "title": "AdStoryViewListModel", "description": "Ad Story List View Model", "required": [ "id", "slug" ], "properties": { "id": { "type": "integer", "example": 1 }, "slug": { "type": "string", "example": "my-ad-slug" }, "is_favorite": { "type": "boolean", "example": true }, "video": { "type": "string", "example": "https://example.com/video.mp4" }, "image": { "type": "string", "example": "https://example.com/image.jpg" }, "date": { "type": "string", "example": "منذ 3 أيام" }, "count_favorites": { "type": "integer", "example": 25 }, "is_view": { "type": "boolean", "example": true }, "count_view": { "type": "integer", "example": 120 } }, "type": "object" }, "AdTypeViewModel": { "title": "AdTypeViewModel", "description": "Type Ad View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "AdViewListModel": { "title": "AdViewListModel", "description": "Ad List View Model", "required": [ "id", "slug" ], "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "title": { "type": "string" }, "type_ad": { "type": "string" }, "price": { "type": "integer" }, "property_price": { "type": "integer" }, "is_favorite": { "type": "boolean" }, "is_special": { "type": "boolean" }, "images": { "type": "array", "items": { "type": "string" } }, "distance": { "type": "integer" }, "address": { "type": "string" }, "number_of_rooms": { "type": "integer" }, "area": { "type": "string" }, "user_id": { "type": "integer" }, "user_number": { "type": "string" }, "user_whatsapp": { "type": "string" } }, "type": "object" }, "AdViewModel": { "title": "AdViewModel", "description": "Ad Sell View Model", "properties": { "id": { "type": "integer" }, "slug": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "date_at": { "type": "string", "nullable": true }, "type_ad": { "type": "string", "nullable": true }, "estate_type": { "type": "string", "nullable": true }, "usage_type": { "type": "string", "nullable": true }, "price": { "type": "integer", "nullable": true }, "property_price": { "type": "integer", "nullable": true }, "is_favorite": { "type": "boolean" }, "number_of_rooms": { "type": "integer", "nullable": true }, "area": { "type": "string", "nullable": true }, "license_number": { "type": "string" }, "creation_date": { "type": "string", "format": "date" }, "end_date": { "type": "string", "format": "date" }, "address": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "neighborhood": { "type": "string", "nullable": true }, "lat": { "type": "string", "nullable": true }, "lng": { "type": "string", "nullable": true }, "deed_number": { "type": "string", "nullable": true }, "property_face": { "type": "string", "nullable": true }, "plan_number": { "type": "string", "nullable": true }, "land_number": { "type": "string", "nullable": true }, "street_width": { "type": "string", "nullable": true }, "ad_license_url": { "type": "string", "nullable": true }, "is_constrained": { "type": "boolean" }, "is_pawned": { "type": "boolean" }, "is_halted": { "type": "boolean" }, "is_testament": { "type": "boolean" }, "title_deed_type_name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "video": { "type": "string", "nullable": true }, "images": { "type": "array", "items": { "type": "string" }, "nullable": true }, "user": { "type": "object", "nullable": true } }, "type": "object" }, "CityViewModel": { "title": "CityViewModel", "description": "City View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "EstateTypeViewModel": { "title": "EstateTypeViewModel", "description": "Estate Type View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "is_most_used": { "type": "boolean" }, "title": { "type": "string" } }, "type": "object" }, "NeighborhoodViewModel": { "title": "NeighborhoodViewModel", "description": "Neighborhood View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "PropertyUtilityViewModel": { "title": "PropertyUtilityViewModel", "description": "Property Utilities View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "ReasonViewModel": { "title": "ReasonViewModel", "description": "Reason View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "RegionMapViewModel": { "title": "RegionMapViewModel", "description": "Region Map View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "RegionViewModel": { "title": "RegionViewModel", "description": "Region View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "UsageTypeViewModel": { "title": "UsageTypeViewModel", "description": "Usage Type View Model", "required": [ "id", "title" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" } }, "type": "object" }, "UserStoryViewListModel": { "title": "UserStoryViewListModel", "description": "User Story List View Model", "required": [ "id", "slug" ], "properties": { "id": { "type": "integer" }, "name": { "type": "name" }, "stories": { "$ref": "#/components/schemas/AdStoryViewListModel" } }, "type": "object" }, "RatingViewModel": { "title": "Rating View Model", "description": "Rating data for API responses", "properties": { "id": { "type": "integer", "example": 1 }, "user_id": { "type": "integer", "example": 1 }, "company_id": { "type": "integer", "example": 2 }, "rating": { "type": "integer", "maximum": 5, "minimum": 1, "example": 5 }, "description": { "type": "string", "example": "Great service!", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/components/schemas/UserViewModel" }, "company": { "$ref": "#/components/schemas/UserViewModel" } }, "type": "object" }, "UserViewListModel": { "title": "UserViewListModel", "description": "User List View Model for Service Providers", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Company Name" }, "image": { "type": "string", "example": "https://example.com/image.jpg", "nullable": true }, "user_type": { "type": "string", "example": "office" }, "average_rating": { "type": "number", "format": "float", "example": 4.5, "nullable": true }, "total_ratings": { "type": "integer", "example": 10, "nullable": true }, "distance": { "description": "Distance in kilometers from user location", "type": "number", "format": "float", "example": 2.5 }, "latitude": { "type": "number", "format": "float", "example": 21.42251, "nullable": true }, "longitude": { "type": "number", "format": "float", "example": 39.826168, "nullable": true } }, "type": "object" }, "UserViewModel": { "title": "UserViewModel", "description": "User View Model", "required": [ "id", "email", "phone", "is_active", "created_at", "updated_at" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string" }, "phone": { "type": "string" }, "whatsapp": { "type": "string" }, "image": { "type": "string", "nullable": true }, "user_type": { "type": "string", "example": "individual" }, "code": { "type": "string", "nullable": true }, "is_verified": { "type": "boolean" }, "is_active": { "type": "boolean" }, "receive_notification": { "type": "boolean" }, "receive_messages": { "type": "boolean" }, "free_ads": { "type": "integer" }, "device_token": { "type": "string", "nullable": true }, "last_login": { "type": "string", "format": "date-time", "nullable": true }, "is_authentic": { "type": "boolean" }, "pending_authentication": { "type": "boolean" }, "identity_owner_name": { "type": "string", "nullable": true }, "identity_number": { "type": "string", "nullable": true }, "commercial_owner_name": { "type": "string", "nullable": true }, "commercial_name": { "type": "string", "nullable": true }, "commercial_number": { "type": "string", "nullable": true }, "commercial_image": { "type": "string", "nullable": true }, "identity_image": { "type": "string", "nullable": true }, "val_license": { "type": "string", "nullable": true }, "transId": { "type": "string", "nullable": true }, "requestId": { "type": "string", "nullable": true }, "is_nafath_verified": { "type": "boolean" }, "about_company": { "type": "string", "nullable": true }, "working_hours": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "day": { "type": "string" }, "start_time": { "type": "string", "nullable": true }, "end_time": { "type": "string", "nullable": true }, "is_working_day": { "type": "boolean" } }, "type": "object" }, "nullable": true }, "previous_work_history": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "company_name": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "is_current_job": { "type": "boolean" } }, "type": "object" }, "nullable": true }, "services": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "nullable": true }, "rating_stats": { "properties": { "average_rating": { "type": "number", "format": "float", "example": 4.5 }, "total_ratings": { "type": "integer", "example": 10 }, "ratings_given_count": { "type": "integer", "example": 5 } }, "type": "object", "nullable": true }, "distance": { "description": "Distance in kilometers from user location", "type": "number", "format": "float", "example": 2.5 }, "ratings_received": { "type": "array", "items": { "properties": { "id": { "type": "integer" }, "rating": { "type": "integer", "maximum": 5, "minimum": 1 }, "description": { "type": "string", "nullable": true }, "user": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" } }, "type": "object" }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "NotificationViewModel": { "title": "NotificationViewModel", "description": "Notification View Model", "required": [ "id", "message", "is_read" ], "properties": { "id": { "type": "integer" }, "message": { "type": "string" }, "is_read": { "type": "boolean" }, "read_at": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "SubscriptionViewModel": { "title": "SubscriptionViewModel", "description": "Subscription View Model", "required": [ "id", "user_id", "package_id", "original_price", "final_price", "payment_method", "payment_status", "subscription_status" ], "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "package_id": { "type": "integer" }, "promo_code_id": { "type": "integer", "nullable": true }, "original_price": { "type": "number", "format": "float" }, "final_price": { "type": "number", "format": "float" }, "discount_amount": { "type": "number", "format": "float" }, "discount_percentage": { "type": "number", "format": "float" }, "payment_method": { "type": "string" }, "payment_status": { "type": "string" }, "subscription_status": { "type": "string" }, "start_date": { "type": "string", "format": "date-time", "nullable": true }, "end_date": { "type": "string", "format": "date-time", "nullable": true }, "transaction_id": { "type": "string", "nullable": true }, "payment_details": { "type": "object", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "nullable": true }, "package": { "type": "object", "nullable": true }, "promo_code": { "type": "object", "nullable": true } }, "type": "object" }, "CreateServiceRequest": { "title": "CreateServiceRequest", "description": "Request for creating a new service", "required": [ "type", "name" ], "properties": { "type": { "description": "Type of service (real_estate_services or support_services)", "type": "string" }, "name": { "description": "Name of the service", "type": "string", "maxLength": 255 }, "is_active": { "description": "Whether the service is active", "type": "boolean", "default": true }, "image": { "description": "Service image." } }, "type": "object" }, "UpdateServiceRequest": { "title": "UpdateServiceRequest", "description": "Request for updating an existing service", "properties": { "type": { "description": "Type of service (real_estate_services or support_services)", "type": "string" }, "name": { "description": "Name of the service", "type": "string", "maxLength": 255 }, "is_active": { "description": "Whether the service is active", "type": "boolean" } }, "type": "object" }, "ServiceViewModel": { "title": "ServiceViewModel", "description": "Service View Model", "required": [ "id", "type", "name", "image", "is_active", "created_at", "updated_at" ], "properties": { "id": { "type": "integer" }, "type": { "type": "string" }, "type_label": { "type": "string" }, "name": { "type": "string" }, "image": { "type": "string" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "ContactViewModel": { "title": "ContactViewModel", "description": "Contact Message View Model", "required": [ "id", "name", "email", "mobile", "subject", "message", "status", "created_at" ], "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer", "nullable": true }, "name": { "type": "string" }, "email": { "type": "string" }, "mobile": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "resolved", "closed" ] }, "responded_at": { "type": "string", "format": "date-time", "nullable": true }, "response_message": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "PackageViewModel": { "title": "PackageViewModel", "description": "Package View Model", "required": [ "id", "name", "type", "period_months", "description", "price", "is_active" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "individual", "companies" ] }, "period_months": { "type": "integer" }, "description": { "type": "string" }, "price": { "type": "number", "format": "decimal" }, "price_before_discount": { "type": "number", "format": "decimal", "nullable": true }, "discount_percentage": { "type": "number", "format": "float", "nullable": true }, "features": { "type": "array", "items": { "type": "string" } }, "is_active": { "type": "boolean" }, "sort_order": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "ProfitSubscriberViewModel": { "title": "ProfitSubscriberViewModel", "description": "Profit Subscriber View Model", "required": [ "id", "name", "email", "phone", "status", "subscription_date", "is_active" ], "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer", "nullable": true }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "status": { "type": "string", "enum": [ "independent", "not_independent" ] }, "subscription_date": { "type": "string", "format": "date" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "SettingViewModel": { "title": "SettingViewModel", "description": "Setting View Model", "required": [ "id", "key", "value", "type", "is_public", "created_at", "updated_at" ], "properties": { "id": { "type": "integer" }, "key": { "type": "string" }, "value": { "type": "object" }, "type": { "type": "string" }, "user_id": { "type": "integer", "nullable": true }, "is_public": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "WithdrawalViewModel": { "title": "WithdrawalViewModel", "description": "Withdrawal Request View Model", "required": [ "id", "user_id", "account_number", "account_holder_name", "amount", "status", "requested_at" ], "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "account_number": { "type": "string" }, "account_holder_name": { "type": "string" }, "amount": { "type": "number", "format": "decimal" }, "status": { "type": "string", "enum": [ "pending", "accepted", "rejected" ] }, "requested_at": { "type": "string", "format": "date-time" }, "processed_at": { "type": "string", "format": "date-time", "nullable": true }, "rejection_reason": { "type": "string", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "Meta": { "properties": { "total": { "type": "integer" }, "per_page": { "type": "integer" }, "current_page": { "type": "integer" }, "last_page": { "type": "integer" }, "from": { "type": "integer" }, "to": { "type": "integer" } }, "type": "object" }, "DataTable": { "properties": { "draw": { "type": "integer", "example": 0 }, "recordsTotal": { "type": "integer", "example": 15 }, "recordsFiltered": { "type": "integer", "example": 10 }, "data": { "type": "array", "items": { "type": "object" } }, "input": { "required": [ "columns" ], "properties": { "columns": { "type": "array", "items": { "properties": { "name": { "type": "string", "example": "column_name" }, "searchable": { "type": "boolean", "example": true }, "orderable": { "type": "boolean", "example": true }, "search": { "properties": { "value": { "type": "string", "example": "column value", "nullable": true } }, "type": "object" } }, "type": "object" } }, "search": { "properties": { "value": { "type": "string", "nullable": true } }, "type": "object" } }, "type": "object", "additionalProperties": { "description": "Whatever you pass to request body will be present here under the same key, with the same value.", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" } ] } } }, "type": "object" } }, "requestBodies": { "CheckAdLicenseRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "license_number" ], "properties": { "license_number": { "description": "The license number must be exactly 10 digits long and must begin with 72.", "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^72\\d{8}$" } }, "type": "object" } } } }, "StoreBuyAdRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "description", "ad_type_id", "estate_type_id", "region_id", "city_id", "neighborhood_id" ], "properties": { "ad_type_id": { "description": "Type of the ad", "type": "integer", "example": 1 }, "estate_type_id": { "description": "Type of the estate", "type": "integer", "example": 2 }, "region_id": { "description": "ID of the region", "type": "integer", "example": 3 }, "city_id": { "description": "ID of the city", "type": "integer", "example": 4 }, "neighborhood_id": { "description": "ID of the neighborhood", "type": "integer", "example": 5 }, "price": { "description": "Ad price", "type": "number", "format": "float", "example": 150000 }, "description": { "description": "Ad description text.", "type": "string", "example": "This is a description of the ad." } }, "type": "object" } } } }, "StoreSellAdRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "license_number", "is_special", "is_story", "description", "main_image" ], "properties": { "license_number": { "description": "The license number must be exactly 10 digits long and must begin with 72.", "type": "string", "maxLength": 10, "minLength": 10, "pattern": "^72\\d{8}$" }, "is_special": { "description": "Is the ad marked as special?", "type": "boolean" }, "is_story": { "description": "Is the ad shown as a story?", "type": "boolean" }, "description": { "description": "Ad description text.", "type": "string" }, "main_image": { "description": "Ad main image." }, "images": { "description": "Array of image files. Each image must be one of: jpeg, png, gif, svg, webp, bmp, tiff and max 5MB each.", "type": "array", "items": { "type": "string", "format": "binary" } }, "video": { "description": "Video file (mp4, avi, mpeg, mov). Max size: 50MB.", "format": "binary" } }, "type": "object" } } } }, "CompleteProfileRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "identity_number", "account_type" ], "properties": { "name": { "type": "string" }, "identity_number": { "type": "string" }, "email": { "type": "string", "nullable": true }, "account_type": { "type": "string", "enum": [ "individual", "office", "organization", "support_facility" ] }, "commercial_name": { "type": "string", "nullable": true }, "commercial_number": { "type": "string", "nullable": true } }, "type": "object" } } } }, "CreateRatingRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "company_id", "rating" ], "properties": { "company_id": { "type": "integer", "example": 2 }, "rating": { "type": "integer", "maximum": 5, "minimum": 1, "example": 5 }, "description": { "type": "string", "example": "Great service!", "nullable": true } }, "type": "object" } } } }, "EditProfileRequest": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "whatsapp": { "type": "string", "nullable": true }, "commercial_name": { "type": "string", "nullable": true }, "location": { "properties": { "latitude": { "type": "number", "format": "float", "nullable": true }, "longitude": { "type": "number", "format": "float", "nullable": true }, "address": { "type": "string", "nullable": true } }, "type": "object", "nullable": true }, "about_company": { "description": "Company description", "type": "string", "nullable": true }, "working_hours": { "type": "array", "items": { "properties": { "day": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] }, "start_time": { "type": "string", "format": "time", "nullable": true }, "end_time": { "type": "string", "format": "time", "nullable": true }, "is_working_day": { "type": "boolean", "default": true } }, "type": "object" }, "nullable": true }, "previous_work_history": { "type": "array", "items": { "properties": { "company_name": { "type": "string" }, "description": { "type": "string" }, "start_date": { "type": "string", "format": "date", "nullable": true }, "end_date": { "type": "string", "format": "date", "nullable": true }, "is_current_job": { "type": "boolean", "default": false } }, "type": "object" }, "nullable": true }, "services": { "description": "Array of service IDs", "type": "array", "items": { "type": "integer" }, "nullable": true } }, "type": "object" } } } }, "LoginRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "phone" ], "properties": { "phone": { "description": "Phone number", "type": "string" } }, "type": "object" } } } }, "ResendCodeRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "user_id" ], "properties": { "user_id": { "description": "Id For User ", "type": "integer" } }, "type": "object" } } } }, "UpdateRatingRequest": { "required": true, "content": { "application/json": { "schema": { "properties": { "rating": { "type": "integer", "maximum": 5, "minimum": 1, "example": 4 }, "description": { "type": "string", "example": "Updated review", "nullable": true } }, "type": "object" } } } }, "VerifyCodeRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "code", "user_id" ], "properties": { "user_id": { "description": "Id For User ", "type": "integer" }, "code": { "description": "Verification code", "type": "string" } }, "type": "object" } } } }, "CreateContactRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "email", "mobile", "subject", "message" ], "properties": { "name": { "description": "Contact person name", "type": "string" }, "email": { "description": "Contact email address", "type": "string", "format": "email" }, "mobile": { "description": "Contact mobile number", "type": "string" }, "subject": { "description": "Message subject", "type": "string" }, "message": { "description": "Message content", "type": "string" } }, "type": "object" } } } }, "CreateWithdrawalRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "account_number", "account_holder_name", "amount" ], "properties": { "account_number": { "description": "Bank account number", "type": "string" }, "account_holder_name": { "description": "Account holder name", "type": "string" }, "amount": { "description": "Withdrawal amount", "type": "number", "format": "decimal" } }, "type": "object" } } } }, "UpdateSettingRequest": { "required": true, "content": { "application/json": { "schema": { "required": [ "key", "value" ], "properties": { "key": { "description": "Setting key", "type": "string" }, "value": { "description": "Setting value", "type": "object" }, "type": { "description": "Setting type", "type": "string", "nullable": true }, "description": { "description": "Setting description", "type": "string", "nullable": true } }, "type": "object" } } } } }, "securitySchemes": { "sanctum": { "type": "http", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "Ads", "description": "Ads" }, { "name": "Constants", "description": "Constants" }, { "name": "Filter", "description": "Filter" }, { "name": "Home", "description": "Home" }, { "name": "Story", "description": "Story" }, { "name": "Auth", "description": "Auth" }, { "name": "Service Providers", "description": "Service Providers" }, { "name": "Notifications", "description": "Notifications" }, { "name": "Payments", "description": "Payments" }, { "name": "Services", "description": "Services" }, { "name": "Settings", "description": "Settings" } ] }